Skip to content

pantoken / formats/components/src / IconGlyphsOptions

Interface: IconGlyphsOptions

Beta

Options for iconGlyphsCss.

Extends

Properties

prefix?

optional prefix?: string | null

Beta

The class prefix. A truthy string namespaces every class ("instui".instui-button); any falsy value (null, undefined, "", or omitting the option) drops the prefix entirely (.button), so you can author class="heading -h1". The stylesheets shipped by this package are built with "instui".

Inherited from

ComponentOptions.prefix


theme?

optional theme?: ComponentTheme

Beta

Target theme for emitted CSS. Defaults to "rebrand" when omitted.

Inherited from

ComponentOptions.theme


deprecatedAliases?

optional deprecatedAliases?: boolean

Beta

Also emit the deprecated InstUI-prop glyph aliases (-render-icon-<name>, -render-custom-icon-<name>) as functional aliases of -icon-<name>. Off by default — turning it on roughly doubles the sheet, so enable it only when you need markup written against the old renderIcon/renderCustomIcon prop names to keep rendering. The shipped icons.css is built with this on.