Skip to main content

GroupHeader

Interfaces

GroupHeaderProps

Indexable

[p: string]: any

Properties

PropertyTypeDescription
ChangeCoverProps?ChangeGroupCoverPropsProps to spread change cover button

Default
{}
ChangePictureProps?ChangeGroupPicturePropsProps to spread change picture button

Default
{}
GroupMembersButtonProps?GroupMembersButtonPropsProps to spread to the group memebers button

Default
{}
GroupSubscribeButtonProps?GroupSubscribeButtonPropsProps to spread group button followed

Default
{}
className?stringOverrides or extends the styles applied to the component.

Default
null
group?SCGroupTypeGroup Object

Default
null
groupId?numberId of the group

Default
null
id?stringId of group object

Default
null

Functions

GroupHeader()

GroupHeader(inProps): JSX.Element

API documentation for the Community-JS Group Header component. Learn about the available props and the CSS API.

This component renders the groups top section.

Import

import {UserProfileHeader} from '@selfcommunity/react-ui';

Component Name

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

CSS

Rule NameGlobal classDescription
root.SCGroupHeader-rootStyles applied to the root element.
cover.SCGroupHeader-coverStyles applied to the cover element.
avatar.SCGroupHeader-avatarStyles applied to the avatar element.
infoSCGroupHeader-infoStyles applied to the info section.
nameSCGroupHeader-usernameStyles applied to the username element.
changePicture.SCGroupHeader-change-pictureStyles applied to changePicture element.
changeCover.SCGroupHeader-change-cover`Styles applied to changeCover element.

Parameters

ParameterTypeDescription
inPropsGroupHeaderProps

Returns

JSX.Element

Source

packages/react-ui/src/components/GroupHeader/GroupHeader.tsx:122


GroupHeaderSkeleton()

GroupHeaderSkeleton(): JSX.Element

API documentation for the Community-JS Group Header Skeleton component. Learn about the available props and the CSS API.

Import

import {GroupHeaderSkeleton} from '@selfcommunity/react-ui';

Component Name

The name SCGroupHeader-skeleton-root can be used when providing style overrides in the theme.

CSS

Rule NameGlobal classDescription
root.SCGroupHeader-skeleton-rootStyles applied to the root element.
avatar.SCGroupHeader-avatarStyles applied to the avatar element.
cover.SCGroupHeader-coverStyles applied to the cover element.
info.SCGroupHeader-infoStyles applied to the info info.

Returns

JSX.Element

Source

packages/react-ui/src/components/GroupHeader/Skeleton.tsx:43