bootstack.style.Theme#

class bootstack.style.Theme(name, primary=None, success=None, info=None, warning=None, danger=None, secondary=None, neutral='#adb5bd', light=None, dark=None, surfaces=None, display_name=None, white='#ffffff', black='#000000')#

Bases: object

A color theme family declared in code.

Declare the semantic accent colors as [500] anchors plus a light and/or dark block (background/foreground). Each accent generates a 50–950 ramp; the framework picks the per-mode step for solids, washes, borders, and emphasis text. install() registers the generated <name>-light and <name>-dark variants.

Parameters:

  • name (str) – Family name; generated variants are <name>-light / <name>-dark.

  • primary (str | None) – Primary accent color (the [500] ramp midpoint), as hex.

  • success (str | None) – Success accent color (hex).

  • info (str | None) – Info accent color (hex).

  • warning (str | None) – Warning accent color (hex).

  • danger (str | None) – Danger accent color (hex).

  • secondary (str | None) – Optional colored secondary accent (hex). When omitted, secondary derives from the neutral ramp.

  • neutral (str) – Gray base for the neutral ramp (borders, muted text, secondary).

  • light (dict[str, str] | None) – {'background': ..., 'foreground': ...} for the light variant, or None to skip it.

  • dark (dict[str, str] | None) – {'background': ..., 'foreground': ...} for the dark variant.

  • surfaces (dict | None) – Optional surface overrides — either a flat {'chrome': '#...'} (both modes) or per-mode {'light': {...}, 'dark': {...}}. Pins surfaces the auto-derivation can’t produce well (e.g. chrome on a very-dark background).

  • display_name (str | None) – Human label base; the mode is appended (` Light`/` Dark`).

  • white (str) – Reference white. Defaults to '#ffffff'.

  • black (str) – Reference black. Defaults to '#000000'.

black: str = '#000000'#
danger: str | None = None#
dark: dict[str, str] | None = None#
display_name: str | None = None#
info: str | None = None#
light: dict[str, str] | None = None#
name: str#
neutral: str = '#adb5bd'#
primary: str | None = None#
secondary: str | None = None#
success: str | None = None#
surfaces: dict | None = None#
warning: str | None = None#
white: str = '#ffffff'#
classmethod from_existing(base, *, name, **overrides)#

Derive a new theme from an existing one, overriding only some tokens.

Every token you don’t override is inherited from base, so you can brand a built-in family by changing just its primary (and any others you want):

Theme.from_existing(“bootstrap”, name=”acme”, primary=”#ff5722”).install() bs.set_theme(“acme-light”)

Parameters:

  • base (str | Theme) – The theme to build on — a built-in or already-installed family name (e.g. 'bootstrap'), or a Theme instance. Required.

  • name (str) – Family name for the derived theme; its install() registers <name>-light / <name>-dark. Required.

  • **overrides – Any Theme token to replace (primary, neutral, light, dark, surfaces, display_name, …).

Returns:

A new Theme; call install() on it to register its variants.

Raises:

ThemeError – If base names a theme family that is not registered, or an override names a token that is not a Theme field.

Return type:

Theme

install(*, activate=False)#

Register the generated variants so they can be activated by name.

Parameters:

activate (bool | str) – True activates the light variant; pass a variant name (e.g. 'bootstrap-dark') to activate that one.

Returns:

This theme, to allow theme = Theme(...).install().

Return type:

Theme

variants()#

Return the generated per-mode schema dicts (light first, then dark).