@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
57 lines (48 loc) • 1.32 kB
TypeScript
import { SCGroupType, SCUserType } from '@selfcommunity/types';
export interface GroupSubscribeButtonProps {
/**
* Overrides or extends the styles applied to the component.
* @default null
*/
className?: string;
/**
* Group Object
* @default null
*/
group?: SCGroupType;
/**
* Id of the group
* @default null
*/
groupId?: number;
/**
* The user to be accepted into the group
* @default null
*/
user?: SCUserType;
/**
* onSubscribe callback
* @param user
* @param joined
*/
onSubscribe?: (group: SCGroupType, status: string | null) => any;
/**
* Others properties
*/
[p: string]: any;
}
/**
* > API documentation for the Community-JS Group Subscribe Button component. Learn about the available props and the CSS API.
#### Import
```jsx
import {GroupSubscribeButton} from '@selfcommunity/react-ui';
```
#### Component Name
The name `SCGroupSubscribeButton` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCGroupSubscribeButton-root|Styles applied to the root element.|
* @param inProps
*/
export default function GroupSubscribeButton(inProps: GroupSubscribeButtonProps): JSX.Element;