Drafter.Theme (drafter v0.3.1)

Copy Markdown View Source

Theme definition and built-in theme library for TUI applications.

A theme is a %Drafter.Theme{} struct containing named RGB color slots covering UI surfaces, semantic colors (primary, secondary, accent, warning, error, success), text variants, cursor colors, and a syntax map for code highlighting. The framework ships with thirteen ready-to-use themes accessible via available_themes/0 and get_theme/1, including "textual-dark", "nord", "dracula", "monokai", "tokyo-night", and "catppuccin-mocha".

Summary

Types

rgb()
t()

Functions

available_themes()

Every built-in theme, keyed by the name get_theme/1 takes.

catppuccin_mocha_theme()

The built-in "catppuccin-mocha" theme, with its syntax map filled in from default_syntax_colors/1.

classic_theme()

The built-in "classic" theme, with its syntax map filled in from default_syntax_colors/1.

dark_theme()

The built-in "textual-dark" theme, with its syntax map filled in from default_syntax_colors/1.

default_syntax_colors(theme)

The syntax-highlighting palette derived from a theme's semantic colours.

dracula_theme()

The built-in "dracula" theme, with its syntax map filled in from default_syntax_colors/1.

get_color(theme, color_name)

Look a colour up on a theme by slot name.

get_theme(name)

The built-in theme called name, or nil when there is no such theme.

gruvbox_dark_theme()

The built-in "gruvbox-dark" theme, with its syntax map filled in from default_syntax_colors/1.

gruvbox_light_theme()

The built-in "gruvbox-light" theme, with its syntax map filled in from default_syntax_colors/1.

light_theme()

The built-in "textual-light" theme, with its syntax map filled in from default_syntax_colors/1.

monokai_theme()

The built-in "monokai" theme, with its syntax map filled in from default_syntax_colors/1.

mute_color(color)

A desaturated version of an {r, g, b} colour.

nord_theme()

The built-in "nord" theme, with its syntax map filled in from default_syntax_colors/1.

retro_theme()

The built-in "retro" theme, with its syntax map filled in from default_syntax_colors/1.

solarized_dark_theme()

The built-in "solarized-dark" theme, with its syntax map filled in from default_syntax_colors/1.

solarized_light_theme()

The built-in "solarized-light" theme, with its syntax map filled in from default_syntax_colors/1.

tokyo_night_theme()

The built-in "tokyo-night" theme, with its syntax map filled in from default_syntax_colors/1.

Types

rgb()

@type rgb() :: {non_neg_integer(), non_neg_integer(), non_neg_integer()}

t()

@type t() :: %Drafter.Theme{
  accent: rgb(),
  accent_muted: rgb(),
  background: rgb(),
  block_hover: rgb(),
  border: rgb(),
  cursor: %{
    block_cursor: rgb(),
    block_cursor_foreground: rgb(),
    block_cursor_blurred: rgb()
  },
  dark: boolean(),
  error: rgb(),
  error_muted: rgb(),
  foreground: rgb(),
  name: String.t(),
  panel: rgb(),
  primary: rgb(),
  primary_muted: rgb(),
  secondary: rgb(),
  secondary_muted: rgb(),
  success: rgb(),
  success_muted: rgb(),
  surface: rgb(),
  syntax: %{required(atom()) => rgb()},
  text_accent: rgb(),
  text_disabled: rgb(),
  text_error: rgb(),
  text_muted: rgb(),
  text_primary: rgb(),
  text_secondary: rgb(),
  text_success: rgb(),
  text_warning: rgb(),
  warning: rgb(),
  warning_muted: rgb()
}

Functions

available_themes()

@spec available_themes() :: %{required(String.t()) => t()}

Every built-in theme, keyed by the name get_theme/1 takes.

Examples

iex> Drafter.Theme.available_themes() |> Map.keys() |> Enum.sort() |> hd()
"catppuccin-mocha"

iex> Drafter.Theme.available_themes() |> map_size()
13

catppuccin_mocha_theme()

@spec catppuccin_mocha_theme() :: t()

The built-in "catppuccin-mocha" theme, with its syntax map filled in from default_syntax_colors/1.

Examples

iex> Drafter.Theme.catppuccin_mocha_theme().name
"catppuccin-mocha"

classic_theme()

@spec classic_theme() :: t()

The built-in "classic" theme, with its syntax map filled in from default_syntax_colors/1.

Examples

iex> Drafter.Theme.classic_theme().name
"classic"

dark_theme()

@spec dark_theme() :: t()

The built-in "textual-dark" theme, with its syntax map filled in from default_syntax_colors/1.

Examples

iex> Drafter.Theme.dark_theme().name
"textual-dark"

default_syntax_colors(theme)

@spec default_syntax_colors(t()) :: %{required(atom()) => rgb()}

The syntax-highlighting palette derived from a theme's semantic colours.

Keys: :keyword, :keyword_builtin, :type, :function, :function_builtin, :variable, :string, :string_special, :number, :operator, :comment and :default. The mapping is currently the same for dark and light themes, but a theme whose :dark field is neither true nor false raises FunctionClauseError.

dracula_theme()

@spec dracula_theme() :: t()

The built-in "dracula" theme, with its syntax map filled in from default_syntax_colors/1.

Examples

iex> Drafter.Theme.dracula_theme().name
"dracula"

get_color(theme, color_name)

@spec get_color(t(), {:syntax, atom()} | atom()) :: term() | nil

Look a colour up on a theme by slot name.

{:syntax, key} reads the theme's syntax map. A plain atom reads the struct field of that name and, when that field is nil, falls back to the theme's :cursor map — so :block_cursor and friends resolve without naming the map. Returns nil when neither carries the name. Any struct field is reachable this way, including the non-colour :name and :dark.

Examples

iex> Drafter.Theme.get_color(Drafter.Theme.nord_theme(), :primary)
{136, 192, 208}

iex> Drafter.Theme.get_color(Drafter.Theme.nord_theme(), {:syntax, :no_such_token})
nil

iex> Drafter.Theme.get_color(Drafter.Theme.nord_theme(), :no_such_slot)
nil

get_theme(name)

@spec get_theme(String.t()) :: t() | nil

The built-in theme called name, or nil when there is no such theme.

Examples

iex> Drafter.Theme.get_theme("nord").dark
true

iex> Drafter.Theme.get_theme("no-such-theme")
nil

gruvbox_dark_theme()

@spec gruvbox_dark_theme() :: t()

The built-in "gruvbox-dark" theme, with its syntax map filled in from default_syntax_colors/1.

Examples

iex> Drafter.Theme.gruvbox_dark_theme().name
"gruvbox-dark"

gruvbox_light_theme()

@spec gruvbox_light_theme() :: t()

The built-in "gruvbox-light" theme, with its syntax map filled in from default_syntax_colors/1.

Examples

iex> Drafter.Theme.gruvbox_light_theme().name
"gruvbox-light"

light_theme()

@spec light_theme() :: t()

The built-in "textual-light" theme, with its syntax map filled in from default_syntax_colors/1.

Examples

iex> Drafter.Theme.light_theme().name
"textual-light"

monokai_theme()

@spec monokai_theme() :: t()

The built-in "monokai" theme, with its syntax map filled in from default_syntax_colors/1.

Examples

iex> Drafter.Theme.monokai_theme().name
"monokai"

mute_color(color)

@spec mute_color(rgb() | nil | term()) :: rgb() | nil | term()

A desaturated version of an {r, g, b} colour.

Each channel is moved halfway towards the mean of the three, which keeps the colour's brightness and halves its saturation. A grey stays exactly as it was.

nil passes through as nil, and any other term is returned unchanged.

Examples

iex> Drafter.Theme.mute_color({200, 100, 0})
{150, 100, 50}

iex> Drafter.Theme.mute_color({80, 80, 80})
{80, 80, 80}

iex> Drafter.Theme.mute_color(nil)
nil

nord_theme()

@spec nord_theme() :: t()

The built-in "nord" theme, with its syntax map filled in from default_syntax_colors/1.

Examples

iex> Drafter.Theme.nord_theme().name
"nord"

retro_theme()

@spec retro_theme() :: t()

The built-in "retro" theme, with its syntax map filled in from default_syntax_colors/1.

Examples

iex> Drafter.Theme.retro_theme().name
"retro"

solarized_dark_theme()

@spec solarized_dark_theme() :: t()

The built-in "solarized-dark" theme, with its syntax map filled in from default_syntax_colors/1.

Examples

iex> Drafter.Theme.solarized_dark_theme().name
"solarized-dark"

solarized_light_theme()

@spec solarized_light_theme() :: t()

The built-in "solarized-light" theme, with its syntax map filled in from default_syntax_colors/1.

Examples

iex> Drafter.Theme.solarized_light_theme().name
"solarized-light"

tokyo_night_theme()

@spec tokyo_night_theme() :: t()

The built-in "tokyo-night" theme, with its syntax map filled in from default_syntax_colors/1.

Examples

iex> Drafter.Theme.tokyo_night_theme().name
"tokyo-night"