@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
69 lines (65 loc) • 2.37 kB
TypeScript
import { CacheStrategies } from '@selfcommunity/utils';
import { BaseDialogProps } from '../../shared/BaseDialog';
import { WidgetProps } from '../Widget';
import { VirtualScrollerItemProps } from '../../types/virtualScroller';
import { GroupProps } from '../Group';
export interface UserSubscribedGroupsWidgetProps extends VirtualScrollerItemProps, WidgetProps {
/**
* The user id
* @default null
*/
userId: number;
/**
* Hides this component
* @default false
*/
autoHide?: boolean;
/**
* Limit the number of groups to show
* @default false
*/
limit?: number;
/**
* Props to spread to single group object
* @default empty object
*/
GroupProps?: GroupProps;
/**
* Caching strategies
* @default CacheStrategies.CACHE_FIRST
*/
cacheStrategy?: CacheStrategies;
/**
* Props to spread to subscribed groups dialog
* @default {}
*/
DialogProps?: BaseDialogProps;
/**
* Other props
*/
[p: string]: any;
}
/**
* > API documentation for the Community-JS User Profile Groups Subscribed Widget component. Learn about the available props and the CSS API.
*
*
* This component renders the list of the groups that the given user follows.
* Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/UserSubscribedGroups)
#### Import
```jsx
import {UserSubscribedGroupsWidget} from '@selfcommunity/react-ui';
```
#### Component Name
The name `SCUserSubscribedGroupsWidget` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCUserSubscribedGroupsWidget-root|Styles applied to the root element.|
|title|.SCUserSubscribedGroupsWidget-title|Styles applied to the title element.|
|noResults|.SCUserSubscribedGroupsWidget-no-results|Styles applied to no results section.|
|showMore|.SCUserSubscribedGroupsWidget-show-more|Styles applied to show more button element.|
|dialogRoot|.SCUserSubscribedGroupsWidget-dialog-root|Styles applied to the root dialog element.|
|endMessage|.SCUserSubscribedGroupsWidget-end-message|Styles applied to the end message element.|
* @param inProps
*/
export default function UserSubscribedGroupsWidget(inProps: UserSubscribedGroupsWidgetProps): JSX.Element;