@selfcommunity/react-ui/lib/esm/components/CategoriesPopularWidget/CategoriesPopularWidget.d.ts

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

import { CacheStrategies } from '@selfcommunity/utils';
import { CategoryProps } from '../Category';
import { BaseDialogProps } from '../../shared/BaseDialog';
import { WidgetProps } from '../Widget';
import { VirtualScrollerItemProps } from '../../types/virtualScroller';
export interface CategoriesPopularWidgetProps extends VirtualScrollerItemProps, WidgetProps {
    /**
     * Hides this component
     * @default false
     */
    autoHide?: boolean;
    /**
     * Limit the number of categories to show
     * @default false
     */
    limit?: number;
    /**
     * Props to spread to single category object
     * @default empty object
     */
    CategoryProps?: CategoryProps;
    /**
     * Caching strategies
     * @default CacheStrategies.CACHE_FIRST
     */
    cacheStrategy?: CacheStrategies;
    /**
     * Props to spread to followed categories dialog
     * @default {}
     */
    DialogProps?: BaseDialogProps;
    /**
     * Other props
     */
    [p: string]: any;
}
/**
 * > API documentation for the Community-JS Categories Popular widget component. Learn about the available props and the CSS API.
 *
 *
 * This component renders a list of popular categories.
 * Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/CategoriesPopular)

 #### Import
 ```jsx
 import {CategoriesPopular} from '@selfcommunity/react-ui';
 ```

 #### Component Name
 The name `SCCategoriesPopularWidget` can be used when providing style overrides in the theme.

 #### CSS

 |Rule Name|Global class|Description|
 |---|---|---|
 |root|.SCCategoriesPopularWidget-root|Styles applied to the root element.|
 |title|.SCCategoriesPopularWidget-title|Styles applied to the title element.|
 |noResults|.SCCategoriesPopularWidget-no-results|Styles applied to no results section.|
 |showMore|.SCCategoriesPopularWidget-show-more|Styles applied to show more button element.|
 |dialogRoot|.SCCategoriesPopularWidget-dialog-root|Styles applied to the root dialog element.|
 |endMessage|.SCCategoriesPopularWidget-end-message|Styles applied to the end message element.|

 * @param inProps
 */
export default function CategoriesPopularWidget(inProps: CategoriesPopularWidgetProps): JSX.Element;