Group
Interfaces
GroupProps
API documentation for the Community-JS Widget component. Learn about the available props and the CSS API.
Import
import {Widget} from '@selfcommunity/react-ui';
Component Name
The name SCWidget can be used when providing style overrides in the theme.
CSS
| Rule Name | Global class | Description |
|---|---|---|
| root | .SCWidget-root | Styles applied to the root element. |
Extends
Indexable
[p: string]: any
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
actionRedirect? | boolean | Prop to redirect the user to the group page Default false | - |
badgeContent? | any | Badge content to show as group avatar badge if show reaction is true. | - |
buttonProps? | ButtonBaseProps | Props to spread to the button Default {} | - |
className? | string | Overrides or extends the styles applied to the component. Default null | WidgetProps.className |
group? | SCGroupType | Group Object Default null | - |
groupId? | number | Id of the group for filter the feed Default null | - |
groupSubscribeButtonProps? | GroupSubscribeButtonProps | Props to spread to group subscribe/unsubscribe button Default {} | - |
hideActions? | boolean | Prop to hide actions Default false | - |
Functions
Group()
Group(
inProps):JSX.Element
API documentation for the Community-JS Group component. Learn about the available props and the CSS API.
This component renders a group item. Take a look at our demo component here
Import
import {group} from '@selfcommunity/react-ui';
Component Name
The name SCGroup can be used when providing style overrides in the theme.
CSS
| Rule Name | Global class | Description |
|---|---|---|
| root | .SCGroup-root | Styles applied to the root element. |
| avatar | .SCGroup-avatar | Styles applied to the avatar element. |
| actions | .SCGroup-actions | Styles applied to the actions section. |
| icon | .SCGroup-icon | Styles applied to the group privacy icon element. |
Parameters
| Parameter | Type | Description |
|---|---|---|
inProps | GroupProps |
Returns
JSX.Element
Source
packages/react-ui/src/components/Group/Group.tsx:119
GroupSkeleton()
GroupSkeleton(
props):JSX.Element
API documentation for the Community-JS Group Skeleton component. Learn about the available props and the CSS API.
Import
import {GroupSkeleton} from '@selfcommunity/react-ui';
Component Name
The name SCGroup-skeleton-root can be used when providing style overrides in the theme.
CSS
| Rule Name | Global class | Description |
|---|---|---|
| root | .SCGroup-skeleton-root | Styles applied to the root element. |
Parameters
| Parameter | Type |
|---|---|
props | WidgetProps |
Returns
JSX.Element