Skip to content

Remix Icon API

ttkbootstrap_icons_remix.icon

RemixStyles = Literal['fill', 'line'] module-attribute

RemixFontProvider

Bases: BaseFontProvider

Initialize the provider with style configuration.

Uses a single font file (remixicon.ttf) for all styles. Style selection is performed by predicates that test for the suffix.

format_glyph_name(glyph_name) staticmethod

Display friendly name for font name

RemixIcon

Bases: Icon

Convenience icon for the Remix Icon glyph set.

Resolves the provided name (optionally with a style) using RemixProvider, then initializes the base Icon with the resolved glyph.

Parameters:

Name Type Description Default
name str

Glyph name. May be a friendly name (e.g. "admin") or a raw glyph (e.g. "admin-line"). If you pass a conflicting style (e.g. name ends with "-line" but you set style="fill"), a ValueError is raised.

required
size int

Pixel size of the rasterized image (default: 24).

24
color str

Foreground color used to render the glyph (default: "black").

'black'
style RemixStyles | None

Optional style override: "fill", "line". If omitted, the provider's default style is used. When name already encodes a style suffix (e.g. "-line"), that suffix takes precedence.

None

Raises:

Type Description
ValueError

If the name cannot be resolved for the requested style.

ttkbootstrap_icons_remix.provider

RemixFontProvider

Bases: BaseFontProvider

Initialize the provider with style configuration.

Uses a single font file (remixicon.ttf) for all styles. Style selection is performed by predicates that test for the suffix.

format_glyph_name(glyph_name) staticmethod

Display friendly name for font name