CategoryHeader
Interfaces
CategoryHeaderProps
Indexable
[p
: string
]: any
Properties
Property | Type | Description |
---|---|---|
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? | SCCategoryType | Category Object Default null |
categoryId? | number | Id of category object Default null |
className? | string | Overrides 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 Name | Global class | Description |
---|---|---|
root | .SCCategoryHeader-root | Styles applied to the root element. |
cover | .SCCategoryHeader-cover | Styles applied to the cover element. |
name | .SCCategoryHeader-name | Styles applied to the name element. |
slogan | .SCCategoryHeader-slogan | Styles applied to the slogan element. |
info | .SCCategoryHeader-info | Styles applied to the info element. |
followedCounter | .SCCategoryHeader-followed-by-counter | Styles applied to the followers counter element. |
followed | .SCCategoryHeader-followed | Styles applied to the followers avatars section. |
action | .SCCategoryHeader-action | Styles applied to the action section. |
Parameters
Parameter | Type | Description |
---|---|---|
inProps | CategoryHeaderProps |
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 Name | Global class | Description |
---|---|---|
root | .SCCategoryHeader-skeleton-root | Styles applied to the root element. |
Returns
JSX.Element
Source
packages/react-ui/src/components/CategoryHeader/Skeleton.tsx:36