Raxol.Style.Colors.Formats (Raxol v2.0.1)

Color format conversion utilities.

This module provides functions for converting between different color formats:

Summary

Converts an ANSI color code to RGB values.

Parses a hex string into RGB/RGBA values.

rgb_to_ansi(arg)

Converts RGB values to an ANSI color code.

to_hex(arg)

Converts a color to its hex representation.

@spec ansi_to_rgb(byte()) :: {integer(), integer(), integer()}

Converts an ANSI color code to RGB values.

iex> Formats.ansi_to_rgb(1)
{205, 0, 0}

@spec from_hex(String.t()) ::
  {integer(), integer(), integer()}
  | {integer(), integer(), integer(), integer()}

Parses a hex string into RGB/RGBA values.

iex> Formats.from_hex("#FF0000")
{255, 0, 0}

iex> Formats.from_hex("#FF000080")
{255, 0, 0, 128}

@spec rgb_to_ansi({byte(), byte(), byte()}) :: pos_integer()

Converts RGB values to an ANSI color code.

iex> Formats.rgb_to_ansi({255, 0, 0})
196

@spec to_hex({byte(), byte(), byte()} | {byte(), byte(), byte(), byte()}) ::
  String.t()

Converts a color to its hex representation.

iex> Formats.to_hex({255, 0, 0})
"#FF0000"

iex> Formats.to_hex({255, 0, 0, 128})
"#FF000080"