UNPKG

@selfcommunity/react-ui

Version:

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

80 lines (71 loc) 2.39 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 UserFollowersWidgetProps 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 Followers Widget component. Learn about the available props and the CSS API. * * * This component renders the list of the follows of the given user. * Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/UserFollowers) #### Import ```jsx import {UserFollowersWidget} from '@selfcommunity/react-ui'; ``` #### Component Name The name `SCUserFollowersWidget` can be used when providing style overrides in the theme. #### CSS |Rule Name|Global class|Description| |---|---|---| |root|.SCUserFollowersWidget-root|Styles applied to the root element.| |title|.SCUserFollowersWidget-title|Styles applied to the title element.| |noResults|.SCUserFollowersWidget-no-results|Styles applied to no results section.| |showMore|.SCUserFollowersWidget-show-more|Styles applied to show more button element.| |dialogRoot|.SCUserFollowersWidget-dialog-root|Styles applied to the dialog root element.| |endMessage|.SCUserFollowersWidget-end-message|Styles applied to the end message element.| * @param inProps */ export default function UserFollowersWidget(inProps: UserFollowersWidgetProps): JSX.Element;