IconComponentProps

The IconComponentProps object is used to create an icon component.

type IconComponentProps = {
    iconSize?: number;
    color?: string;
    semanticColor?: SemantiColor;
    title?: string;
    titleId?: string;
    desc?: string;
    descId?: string;
    autoMirror?: boolean;
};

Properties

Property	Type	Description
iconSize	`number` \| `undefined`	Icon size
color	`string` \| `undefined`	Icon color. Might not be used by component
semanticColor	`SemanticColor` \| `undefined`	Semantic color name. Matches color variables used in xpui
title	`string` \| `undefined`	Icon title
titleId	`string` \| `undefined`	Title ID (internal)
desc	`string` \| `undefined`	Icon description
descId	`string` \| `undefined`	Description ID (internal)
autoMirror	`boolean` \| `undefined`	Whether the icon can be auto mirrored

Edit this page