@selfcommunity/react-ui/lib/cjs/components/Groups/Groups.d.ts

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

import { GroupProps } from '../Group';
export interface GroupsProps {
    /**
     * Overrides or extends the styles applied to the component.
     * @default null
     */
    className?: string;
    /**
     * Feed API Query Params
     * @default [{'limit': 20, 'offset': 0}]
     */
    endpointQueryParams?: Record<string, string | number>;
    /**
     * Props to spread to single group object
     * @default {variant: 'outlined', ButtonBaseProps: {disableRipple: 'true'}}
     */
    GroupComponentProps?: GroupProps;
    /** If true, it means that the endpoint fetches all groups available
     * @default true
     */
    general?: boolean;
    /**
     * Show/Hide filters
     * @default true
     */
    showFilters?: boolean;
    /**
     * Filters component
     * @param props
     */
    filters?: JSX.Element;
    /**
     * Other props
     */
    [p: string]: any;
}
/**
 * > API documentation for the Community-JS Groups component. Learn about the available props and the CSS API.
 *
 *
 * This component renders the list of the follows of the given group.
 * Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/Groups)

 #### Import

 ```jsx
 import {Groups} from '@selfcommunity/react-ui';
 ```

 #### Component Name

 The name `SCGroups` can be used when providing style overrides in the theme.


 #### CSS

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

 * @param inProps
 */
export default function Groups(inProps: GroupsProps): JSX.Element;