UNPKG

@selfcommunity/react-ui

Version:

React UI Components to integrate a Community created with SelfCommunity Platform.

78 lines (69 loc) 2.21 kB
import { WidgetProps } from '../Widget'; import { SCUserType } from '@selfcommunity/types'; import { CacheStrategies } from '@selfcommunity/utils'; import { UserProps } from '../User'; import { BaseDialogProps } from '../../shared/BaseDialog'; import { VirtualScrollerItemProps } from '../../types/virtualScroller'; export interface UserConnectionsWidgetProps extends VirtualScrollerItemProps, WidgetProps { /** * The user id * @default null */ userId: number; /** * User Object * @default null */ user?: SCUserType; /** * Hides this component * @default false */ autoHide?: boolean; /** * Limit the number of categories to show * @default false */ limit?: number; /** * Props to spread to single user object * @default empty object */ UserProps?: UserProps; /** * Caching strategies * @default CacheStrategies.CACHE_FIRST */ cacheStrategy?: CacheStrategies; /** * Props to spread to followers users dialog * @default {} */ DialogProps?: BaseDialogProps; /** * Other props */ [p: string]: any; } /** * > API documentation for the Community-JS User Connections Widget component. Learn about the available props and the CSS API. * * * This component renders the list of connections of the given user. #### Import ```jsx import {UserConnectionsWidget} from '@selfcommunity/react-ui'; ``` #### Component Name The name `SCUserConnectionsWidget` can be used when providing style overrides in the theme. #### CSS |Rule Name|Global class|Description| |---|---|---| |root|.SCUserConnectionsWidget-root|Styles applied to the root element.| |title|.SCUserConnectionsWidget-title|Styles applied to the title element.| |noResults|.SCUserConnectionsWidget-no-results|Styles applied to no results section.| |connectionsItem|.SCUserConnectionsWidget-connections-item|Styles applied to connection item element.| |showMore|.SCUserConnectionsWidget-show-more|Styles applied to show more button element.| * @param inProps */ export default function UserConnectionsWidget(inProps: UserConnectionsWidgetProps): JSX.Element;