@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
74 lines (65 loc) • 2.36 kB
TypeScript
import { WidgetProps } from '../Widget';
import { UserProps } from '../User';
import { BaseDialogProps } from '../../shared/BaseDialog';
import { VirtualScrollerItemProps } from '../../types/virtualScroller';
import { CacheStrategies } from '@selfcommunity/utils';
export interface CategoryTrendingUsersWidgetProps extends VirtualScrollerItemProps, WidgetProps {
/**
* Category id
* @default null
*/
categoryId?: number;
/**
* 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 Trending Users Widget component. Learn about the available props and the CSS API.
*
*
* This component renders a specific category's trending people list.
* Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/CategoryTrendingUsers)
#### Import
```jsx
import {CategoryTrendingUsersWidget} from '@selfcommunity/react-ui';
```
#### Component Name
The name `SCCategoryTrendingUsersWidget` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCCategoryTrendingUsersWidget-root|Styles applied to the root element.|
|title|.SCCategoryTrendingUsersWidget-title|Styles applied to the title element.|
|noResults|.SCCategoryTrendingUsersWidget-no-results|Styles applied to no results section.|
|showMore|.SCCategoryTrendingUsersWidget-show-more|Styles applied to show more button element.|
|dialogRoot|.SCCategoryTrendingUsersWidget-dialog-root|Styles applied to dialog root element.|
|endMessage|.SCCategoryTrendingUsersWidget-end-message|Styles applied to the end message element.|
* @param inProps
*/
export default function CategoryTrendingUsersWidget(inProps: CategoryTrendingUsersWidgetProps): JSX.Element;