Skip to main content

IconComponent

Home > @backstage/core-plugin-api > IconComponent

IconComponent is the common icon type used throughout Backstage when working with and rendering generic icons, including the app system icons.

Signature:

export type IconComponent = ComponentType<{
    fontSize?: 'large' | 'small' | 'default' | 'inherit';
} | {
    fontSize?: 'medium' | 'large' | 'small' | 'inherit';
}>;

Remarks​

The type is based on SvgIcon from Material UI, but both do not what the plugin-api package to have a dependency on Material UI, nor do we want the props to be as broad as the SvgIconProps interface.

If you have the need to forward additional props from SvgIconProps, you can open an issue or submit a PR to the main Backstage repo. When doing so please also describe your use-case and reasoning of the addition.