Skip to main content

CategoryHeader

Interfaces

CategoryHeaderProps

Indexable

[p: string]: any

Properties

PropertyTypeDescription
CategoryFollowButtonProps?Pick <CategoryFollowButtonProps, keyof CategoryFollowButtonProps>Props to spread category button followed

Default
{}
CategoryFollowersButtonProps?Pick <CategoryFollowersButtonProps, keyof CategoryFollowersButtonProps>Props to spread to followedBy dialog

Default
{}
category?SCCategoryTypeCategory Object

Default
null
categoryId?numberId of category object

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

Default
null

Functions

CategoryHeader()

CategoryHeader(inProps): JSX.Element

API documentation for the Community-JS Category AppBar component. Learn about the available props and the CSS API.

This component renders the top section for category pages. Take a look at our demo component here

Import

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

Component Name

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

CSS

Rule NameGlobal classDescription
root.SCCategoryHeader-rootStyles applied to the root element.
cover.SCCategoryHeader-coverStyles applied to the cover element.
name.SCCategoryHeader-nameStyles applied to the name element.
slogan.SCCategoryHeader-sloganStyles applied to the slogan element.
info.SCCategoryHeader-infoStyles applied to the info element.
followedCounter.SCCategoryHeader-followed-by-counterStyles applied to the followers counter element.
followed.SCCategoryHeader-followedStyles applied to the followers avatars section.
action.SCCategoryHeader-actionStyles applied to the action section.

Parameters

ParameterTypeDescription
inPropsCategoryHeaderProps

Returns

JSX.Element

Source

packages/react-ui/src/components/CategoryHeader/CategoryHeader.tsx:94


CategoryHeaderSkeleton()

CategoryHeaderSkeleton(): JSX.Element

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

Import

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

Component Name

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

CSS

Rule NameGlobal classDescription
root.SCCategoryHeader-skeleton-rootStyles applied to the root element.

Returns

JSX.Element

Source

packages/react-ui/src/components/CategoryHeader/Skeleton.tsx:36