@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
58 lines (53 loc) • 2.06 kB
TypeScript
import { ButtonProps } from '@mui/material/Button/Button';
import { SCGroupType } from '@selfcommunity/types';
export interface GroupInviteButtonProps extends ButtonProps {
/**
* 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 | string;
/**
* Functions to handle invitations sending in group creation mode
* @default null
*/
handleInvitations?: (data: any) => any;
/**
* Any other properties
*/
[p: string]: any;
}
/**
*> API documentation for the Community-JS Group Invite Button component. Learn about the available props and the CSS API.
*
#### Import
```jsx
import {SCGroupInviteButton} from '@selfcommunity/react-ui';
```
#### Component Name
The name `SCGroupInviteButton` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCGroupInviteButton-root|Styles applied to the root element.|
|dialogRoot|.SCGroupInviteButton-dialog-root|Styles applied to the dialog root.|
|dialogTitle|.SCGroupInviteButton-dialog-title|Styles applied to the dialog title element.|
|dialogContent|.SCGroupInviteButton-dialog-content|Styles applied to the dialog content.|
|autocomplete|.SCGroupInviteButton-autocomplete|Styles applied to the autocomplete element.|
|icon|.SCGroupInviteButton-icon|Styles applied to the autocomplete icon element.|
|input|.SCGroupInviteButton-input|Styles applied to the autocomplete input element.|
|clear|.SCGroupInviteButton-clear|Styles applied to the autocomplete clear icon element.|
|invitedBox|.SCGroupInviteButton-invited-box|Styles applied to the invited users box.|
|suggested|.SCGroupInviteButton-suggested|Styles applied to the suggested users box.|
* @param inProps
*/
export default function GroupInviteButton(inProps: GroupInviteButtonProps): JSX.Element;