@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
53 lines (44 loc) • 1.38 kB
TypeScript
import { VirtualScrollerItemProps } from '../../types/virtualScroller';
import { SCGroupType } from '@selfcommunity/types';
export interface GroupInfoWidgetProps extends VirtualScrollerItemProps {
/**
* Group Object
* @default null
*/
group?: SCGroupType;
/**
* Id of the group
* @default null
*/
groupId?: number | string;
/**
* Overrides or extends the styles applied to the component.
* @default null
*/
className?: string;
/**
* Other props
*/
[p: string]: any;
}
/**
* > API documentation for the Community-JS Group Info Widget component. Learn about the available props and the CSS API.
*
*
* This component renders a widget containing the group info.
* Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/GroupInfoWidget)
#### Import
```jsx
import {GroupInfoWidget} from '@selfcommunity/react-ui';
```
#### Component Name
The name `SCGroupInfoWidget` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCGroupInfoWidget-root|Styles applied to the root element.|
|title|.SCGroupInfoWidget-title|Styles applied to the title element.|
*
* @param inProps
*/
export default function GroupInfoWidget(inProps: GroupInfoWidgetProps): JSX.Element;