Pote.Style (Pote v3.0.0)

Inline styling DSL — compose foreground, background and text effects into an immutable %Pote.Style{} struct, then render text with ANSI escapes.

Pote.Style is the agnostic, terminal-agnostic layer: it resolves colors (atoms from Pote.Colors.Basic, RGB tuples, hex strings via Pote.parse/1) and emits truecolor ANSI. Deciding whether to fall back to 256-color or no-color modes is the host's job (alaja does this for the TUI).

Example

iex> style = Pote.Style.red() |> Pote.Style.bold() |> Pote.Style.on("#1e1e2e")
iex> style.fg
{255, 0, 0}
iex> style.bg
{30, 30, 46}
iex> style.effects
[:bold]
iex> Pote.Style.render(style, "hi") |> IO.iodata_to_binary()
"[1m[38;2;255;0;0m[48;2;30;30;46mhi[0m"

Summary

Types

color_input()

effect()

t()

Functions

aqua(style \\ %__MODULE__{})

Returns a style with aqua as the foreground color.

bg(style \\ %__MODULE__{}, color)

Sets the background color on a style. Alias of on/2.

black(style \\ %__MODULE__{})

Returns a style with black as the foreground color.

blink(style \\ %__MODULE__{})

Adds the blink effect to the style.

blue(style \\ %__MODULE__{})

Returns a style with blue as the foreground color.

bold(style \\ %__MODULE__{})

Adds the bold effect to the style.

bright_black(style \\ %__MODULE__{})

Returns a style with bright_black as the foreground color.

bright_blue(style \\ %__MODULE__{})

Returns a style with bright_blue as the foreground color.

bright_cyan(style \\ %__MODULE__{})

Returns a style with bright_cyan as the foreground color.

bright_green(style \\ %__MODULE__{})

Returns a style with bright_green as the foreground color.

bright_magenta(style \\ %__MODULE__{})

Returns a style with bright_magenta as the foreground color.

bright_red(style \\ %__MODULE__{})

Returns a style with bright_red as the foreground color.

bright_white(style \\ %__MODULE__{})

Returns a style with bright_white as the foreground color.

bright_yellow(style \\ %__MODULE__{})

Returns a style with bright_yellow as the foreground color.

cyan(style \\ %__MODULE__{})

Returns a style with cyan as the foreground color.

dim(style \\ %__MODULE__{})

Adds the dim effect to the style.

fg(style \\ %__MODULE__{}, color)

Sets the foreground color on a style.

fuchsia(style \\ %__MODULE__{})

Returns a style with fuchsia as the foreground color.

gray(style \\ %__MODULE__{})

Returns a style with gray as the foreground color.

green(style \\ %__MODULE__{})

Returns a style with green as the foreground color.

grey(style \\ %__MODULE__{})

Returns a style with grey as the foreground color.

hidden(style \\ %__MODULE__{})

Adds the hidden effect to the style.

indigo(style \\ %__MODULE__{})

Returns a style with indigo as the foreground color.

inverse(style \\ %__MODULE__{})

Adds the inverse effect to the style.

italic(style \\ %__MODULE__{})

Adds the italic effect to the style.

lime(style \\ %__MODULE__{})

Returns a style with lime as the foreground color.

magenta(style \\ %__MODULE__{})

Returns a style with magenta as the foreground color.

maroon(style \\ %__MODULE__{})

Returns a style with maroon as the foreground color.

navy(style \\ %__MODULE__{})

Returns a style with navy as the foreground color.

new()

Returns an empty style (no fg, no bg, no effects).

olive(style \\ %__MODULE__{})

Returns a style with olive as the foreground color.

on(style \\ %__MODULE__{}, color)

Sets the background color on a style (terminal-idiomatic "on").

orange(style \\ %__MODULE__{})

Returns a style with orange as the foreground color.

pink(style \\ %__MODULE__{})

Returns a style with pink as the foreground color.

purple(style \\ %__MODULE__{})

Returns a style with purple as the foreground color.

red(style \\ %__MODULE__{})

Returns a style with red as the foreground color.

render(style, text)

Renders text with the style applied, including the reset sequence.

silver(style \\ %__MODULE__{})

Returns a style with silver as the foreground color.

teal(style \\ %__MODULE__{})

Returns a style with teal as the foreground color.

to_ansi(style)

Returns the ANSI escape sequence for the style as iodata.

underline(style \\ %__MODULE__{})

Adds the underline effect to the style.

violet(style \\ %__MODULE__{})

Returns a style with violet as the foreground color.

white(style \\ %__MODULE__{})

Returns a style with white as the foreground color.

yellow(style \\ %__MODULE__{})

Returns a style with yellow as the foreground color.

Types

color_input()

@type color_input() :: atom() | binary() | Pote.rgb()

effect()

@type effect() :: :bold | :dim | :italic | :underline | :inverse | :blink | :hidden

t()

@type t() :: %Pote.Style{
  bg: Pote.rgb() | nil,
  effects: [effect()],
  fg: Pote.rgb() | nil
}

Functions

aqua(style \\ %MODULE{})

@spec aqua(t()) :: t()

Returns a style with aqua as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

bg(style \\ %MODULE{}, color)

@spec bg(t(), color_input()) :: t()

Sets the background color on a style. Alias of on/2.

Examples

iex> Pote.Style.new() |> Pote.Style.bg("#1e1e2e")
%Pote.Style{fg: nil, bg: {30, 30, 46}, effects: []}

black(style \\ %MODULE{})

@spec black(t()) :: t()

Returns a style with black as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

blink(style \\ %MODULE{})

@spec blink(t()) :: t()

Adds the blink effect to the style.

Examples

iex> Pote.Style.bold().effects
[:bold]

blue(style \\ %MODULE{})

@spec blue(t()) :: t()

Returns a style with blue as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

bold(style \\ %MODULE{})

@spec bold(t()) :: t()

Adds the bold effect to the style.

Examples

iex> Pote.Style.bold().effects
[:bold]

bright_black(style \\ %MODULE{})

@spec bright_black(t()) :: t()

Returns a style with bright_black as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

bright_blue(style \\ %MODULE{})

@spec bright_blue(t()) :: t()

Returns a style with bright_blue as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

bright_cyan(style \\ %MODULE{})

@spec bright_cyan(t()) :: t()

Returns a style with bright_cyan as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

bright_green(style \\ %MODULE{})

@spec bright_green(t()) :: t()

Returns a style with bright_green as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

bright_magenta(style \\ %MODULE{})

@spec bright_magenta(t()) :: t()

Returns a style with bright_magenta as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

bright_red(style \\ %MODULE{})

@spec bright_red(t()) :: t()

Returns a style with bright_red as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

bright_white(style \\ %MODULE{})

@spec bright_white(t()) :: t()

Returns a style with bright_white as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

bright_yellow(style \\ %MODULE{})

@spec bright_yellow(t()) :: t()

Returns a style with bright_yellow as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

cyan(style \\ %MODULE{})

@spec cyan(t()) :: t()

Returns a style with cyan as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

dim(style \\ %MODULE{})

@spec dim(t()) :: t()

Adds the dim effect to the style.

Examples

iex> Pote.Style.bold().effects
[:bold]

fg(style \\ %MODULE{}, color)

@spec fg(t(), color_input()) :: t()

Sets the foreground color on a style.

Accepts a color name atom (:red), an RGB tuple, or a hex string ("#ff0000").

Examples

iex> Pote.Style.new() |> Pote.Style.fg(:red)
%Pote.Style{fg: {255, 0, 0}, bg: nil, effects: []}

fuchsia(style \\ %MODULE{})

@spec fuchsia(t()) :: t()

Returns a style with fuchsia as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

gray(style \\ %MODULE{})

@spec gray(t()) :: t()

Returns a style with gray as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

green(style \\ %MODULE{})

@spec green(t()) :: t()

Returns a style with green as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

grey(style \\ %MODULE{})

@spec grey(t()) :: t()

Returns a style with grey as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

hidden(style \\ %MODULE{})

@spec hidden(t()) :: t()

Adds the hidden effect to the style.

Examples

iex> Pote.Style.bold().effects
[:bold]

indigo(style \\ %MODULE{})

@spec indigo(t()) :: t()

Returns a style with indigo as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

inverse(style \\ %MODULE{})

@spec inverse(t()) :: t()

Adds the inverse effect to the style.

Examples

iex> Pote.Style.bold().effects
[:bold]

italic(style \\ %MODULE{})

@spec italic(t()) :: t()

Adds the italic effect to the style.

Examples

iex> Pote.Style.bold().effects
[:bold]

lime(style \\ %MODULE{})

@spec lime(t()) :: t()

Returns a style with lime as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

magenta(style \\ %MODULE{})

@spec magenta(t()) :: t()

Returns a style with magenta as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

maroon(style \\ %MODULE{})

@spec maroon(t()) :: t()

Returns a style with maroon as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

navy(style \\ %MODULE{})

@spec navy(t()) :: t()

Returns a style with navy as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

new()

@spec new() :: t()

Returns an empty style (no fg, no bg, no effects).

Examples

iex> Pote.Style.new()
%Pote.Style{fg: nil, bg: nil, effects: []}

olive(style \\ %MODULE{})

@spec olive(t()) :: t()

Returns a style with olive as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

on(style \\ %MODULE{}, color)

@spec on(t(), color_input()) :: t()

Sets the background color on a style (terminal-idiomatic "on").

Examples

iex> Pote.Style.red() |> Pote.Style.on(:black)
%Pote.Style{fg: {255, 0, 0}, bg: {0, 0, 0}, effects: []}

orange(style \\ %MODULE{})

@spec orange(t()) :: t()

Returns a style with orange as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

pink(style \\ %MODULE{})

@spec pink(t()) :: t()

Returns a style with pink as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

purple(style \\ %MODULE{})

@spec purple(t()) :: t()

Returns a style with purple as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

red(style \\ %MODULE{})

@spec red(t()) :: t()

Returns a style with red as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

render(style, text)

@spec render(t(), binary()) :: iodata()

Renders text with the style applied, including the reset sequence.

Examples

iex> Pote.Style.red() |> Pote.Style.render("hi") |> IO.iodata_to_binary()
"[38;2;255;0;0mhi[0m"

silver(style \\ %MODULE{})

@spec silver(t()) :: t()

Returns a style with silver as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

teal(style \\ %MODULE{})

@spec teal(t()) :: t()

Returns a style with teal as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

to_ansi(style)

@spec to_ansi(t()) :: iodata()

Returns the ANSI escape sequence for the style as iodata.

The result is a binary suitable to be prepended to text; it does not include the reset sequence (use render/2 for that).

Examples

iex> Pote.Style.red() |> Pote.Style.to_ansi()
"[38;2;255;0;0m"

underline(style \\ %MODULE{})

@spec underline(t()) :: t()

Adds the underline effect to the style.

Examples

iex> Pote.Style.bold().effects
[:bold]

violet(style \\ %MODULE{})

@spec violet(t()) :: t()

Returns a style with violet as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

white(style \\ %MODULE{})

@spec white(t()) :: t()

Returns a style with white as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}

yellow(style \\ %MODULE{})

@spec yellow(t()) :: t()

Returns a style with yellow as the foreground color.

Examples

iex> Pote.Style.red().fg
{255, 0, 0}