Groups
Interfaces
GroupsProps
Indexable
[p: string]: any
Properties
| Property | Type | Description |
|---|---|---|
GroupComponentProps? | GroupProps | Props to spread to single group object Default {variant: 'outlined', ButtonBaseProps: {disableRipple: 'true'}} |
className? | string | Overrides or extends the styles applied to the component. Default null |
endpointQueryParams? | Record<string, string | number> | Feed API Query Params Default [{'limit': 20, 'offset': 0}] |
filters? | Element | Filters component Param |
general? | boolean | If true, it means that the endpoint fetches all groups available Default true |
showFilters? | boolean | Show/Hide filters Default true |
Functions
Groups()
Groups(
inProps):JSX.Element
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 demo component here
Import
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. |
Parameters
| Parameter | Type | Description |
|---|---|---|
inProps | GroupsProps |
Returns
JSX.Element
Source
packages/react-ui/src/components/Groups/Groups.tsx:106
GroupsSkeleton()
GroupsSkeleton(
inProps):JSX.Element
API documentation for the Community-JS Groups Skeleton component. Learn about the available props and the CSS API.
Import
import {GroupsSkeleton} from '@selfcommunity/react-ui';
Component Name
The name SCGroups-skeleton-root can be used when providing style overrides in the theme.
CSS
| Rule Name | Global class | Description |
|---|---|---|
| root | .SCGroups-skeleton-root | Styles applied to the root element. |
| groups | .SCGroups-skeleton-groups | Styles applied to the group elements. |
Parameters
| Parameter | Type |
|---|---|
inProps | GroupsSkeletonProps |
Returns
JSX.Element