@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
52 lines (48 loc) • 1.5 kB
TypeScript
import { ButtonProps } from '@mui/material/Button/Button';
import { SCGroupType } from '@selfcommunity/types';
import { BaseDialogProps } from '../../shared/BaseDialog';
export interface GroupMembersButtonProps extends Pick<ButtonProps, Exclude<keyof ButtonProps, 'onClick' | 'disabled'>> {
/**
* Group Object
* @default null
*/
group?: SCGroupType;
/**
* Id of the group
* @default null
*/
groupId?: number | string;
/**
* Props to spread to followedBy dialog
* @default {}
*/
DialogProps?: BaseDialogProps;
/**
* Hides this component
* @default false
*/
autoHide?: boolean;
/**
* Any other properties
*/
[p: string]: any;
}
/**
*> API documentation for the Community-JS Group Members Button component. Learn about the available props and the CSS API.
*
#### Import
```jsx
import {GroupMembersButton} from '@selfcommunity/react-ui';
```
#### Component Name
The name `SCGroupMembersButton` can be used when providing style overrides in the theme.
* #### CSS
*
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCGroupMembersButton-root|Styles applied to the root element.|
|dialogRoot|.SCGroupMembersButton-dialog-root|Styles applied to the root element.|
|endMessage|.SCCategoriesFollowedWidget-end-message|Styles applied to the end message element.|
* @param inProps
*/
export default function GroupMembersButton(inProps: GroupMembersButtonProps): JSX.Element;