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

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

import { WidgetProps } from '../Widget';
import { SCGroupType } from '@selfcommunity/types';
import { CacheStrategies } from '@selfcommunity/utils';
import { BaseDialogProps } from '../../shared/BaseDialog';
import { VirtualScrollerItemProps } from '../../types/virtualScroller';
import { UserProps } from '../User';
export interface GroupMembersWidgetProps extends VirtualScrollerItemProps, WidgetProps {
    /**
     * Group Object
     * @default null
     */
    group?: SCGroupType;
    /**
     * Id of the group
     * @default null
     */
    groupId?: number | string;
    /**
     * Hides this component
     * @default false
     */
    autoHide?: boolean;
    /**
     * Limit the number of users to show
     * @default false
     */
    limit?: number;
    /**
     * Caching strategies
     * @default CacheStrategies.CACHE_FIRST
     */
    cacheStrategy?: CacheStrategies;
    /**
     * Props to spread to single user object
     * @default empty object
     */
    UserProps?: UserProps;
    /**
     * Props to spread to followers users dialog
     * @default {}
     */
    DialogProps?: BaseDialogProps;
    /**
     * Other props
     */
    [p: string]: any;
}
/**
 * > API documentation for the Community-JS Group Members Widget 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/GroupMembers)

 #### Import

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

 #### Component Name

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


 #### CSS

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

 * @param inProps
 */
export default function GroupMembersWidget(inProps: GroupMembersWidgetProps): JSX.Element;