Skip to content

Font Awesome API

ttkbootstrap_icons_fa.icon

FAStyles = Literal['regular', 'solid', 'brands'] module-attribute

FAIcon

Bases: Icon

Convenience icon for the Font Awesome Icon glyph set.

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

Optional style override: "regular", "solid", "brands". If omitted, the provider's default style is used.

None

Raises:

Type Description
ValueError

If the name cannot be resolved for the requested style.

FontAwesomeFontProvider

Bases: BaseFontProvider

Initialize the provider with style configuration

ttkbootstrap_icons_fa.provider

FontAwesomeFontProvider

Bases: BaseFontProvider

Initialize the provider with style configuration