Skip to content

Google Material Icons API

ttkbootstrap_icons_gmi.icon

GMatStyles = Literal['baseline', 'outlined', 'round', 'sharp'] module-attribute

GMatIcon

Bases: Icon

Convenience icon for the GMI Icon glyph set.

Resolves the provided name (optionally with a style) using GMIProvider, 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. "home") or a raw glyph (e.g. "home-outlined"). If you pass a conflicting style (e.g. name ends with "-outlined" but you set style="round"), 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 GMatStyles | None

Optional style override: "baseline", "outlined", "round", "sharp". If omitted, the provider's default style is used.

None

Raises:

Type Description
ValueError

If the name cannot be resolved for the requested style.

GoogleMaterialIconFontProvider

Bases: BaseFontProvider

Initialize the provider with style configuration

ttkbootstrap_icons_gmi.provider

GoogleMaterialIconFontProvider

Bases: BaseFontProvider

Initialize the provider with style configuration