Skip to main content

Groups

Interfaces

GroupsProps

Indexable

[p: string]: any

Other props

Properties

PropertyTypeDescription
className?stringOverrides 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?ElementFilters component Param
general?booleanIf true, it means that the endpoint fetches all groups available Default true
GroupComponentProps?GroupPropsProps to spread to single group object Default {variant: 'outlined', ButtonBaseProps: {disableRipple: 'true'}}
showFilters?booleanShow/Hide filters Default true

Functions

Groups()

Groups(inProps): 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 NameGlobal classDescription
root.SCGroups-rootStyles applied to the root element.
title.SCGroups-titleStyles applied to the title element.
noResults.SCGroups-no-resultsStyles applied to no results section.
showMore.SCGroups-show-moreStyles applied to show more button element.
dialogRoot.SCGroups-dialog-rootStyles applied to the dialog root element.
endMessage.SCGroups-end-messageStyles applied to the end message element.

Parameters

ParameterTypeDescription
inPropsGroupsProps

Returns

Element


GroupsSkeleton()

GroupsSkeleton(inProps): 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 NameGlobal classDescription
root.SCGroups-skeleton-rootStyles applied to the root element.
groups.SCGroups-skeleton-groupsStyles applied to the group elements.

Parameters

ParameterType
inPropsGroupsSkeletonProps

Returns

Element