Utility component for rendering category group icons.
AccessibilityPermalink to: Accessibility
Category Group Icon has role="presentation" to explicitly mark it as purely decorative, preventing assistive technologies from misinterpreting it as conveying meaningful information.
ExamplesPermalink to: Examples
Category Group IconPermalink to: Category Group Icon
Use the name prop to render a category group icon (see list of category group icons).
Open
import { CategoryGroupIcon } from "@peakon/bedrock/react/assets/CategoryGroupIcon";
function Snippet() {
return <CategoryGroupIcon name="engagement" />;
}FormatsPermalink to: Formats
Category Group Icons can be rendered in SVG (default) or PNG format via the format prop.
Open
import { CategoryGroupIcon } from "@peakon/bedrock/react/assets/CategoryGroupIcon";
function Snippet() {
return (
<>
<CategoryGroupIcon name="engagement" format="svg" />
<CategoryGroupIcon name="engagement" format="png" />
</>
);
}Width and heightPermalink to: Width and height
Use the native HTML Image width and height attributes to set the size of the Category Group Icon.
Open
import { CategoryGroupIcon } from "@peakon/bedrock/react/assets/CategoryGroupIcon";
function Snippet() {
return <CategoryGroupIcon name="engagement" width="64" />;
}Props TablePermalink to: Props Table
CategoryGroupIconPermalink to: CategoryGroupIcon
Props extend from HTML Image Element(external link), with the omission of role and style
| Name | Type | Description | Default | Required |
|---|---|---|---|---|
name | string | One of the Category Group Icon names ( | — | Yes |
format | svg | png | What format to render the icon in. | svg | No |