package ansifmt

  1. Overview
  2. Docs

Module Ansifmt.ColorSource

Color encodes ANSI colors.

It comes in three flavors:

  • 4-bit (Minimal)
  • 8-bit (Advanced)
  • 24-bit (Rgb)
Sourcemodule Ground : sig ... end

Ground encodes the information on whether a certain color is on the foreground or the background.

Sourcemodule Minimal : sig ... end

Minimal encodes the 8 default ANSI colors.

Sourcetype t = [
  1. | `Minimal of minimal
  2. | `Advanced of int
  3. | `Rgb of int * int * int
]
Sourceand minimal = {
  1. color : Minimal.t;
  2. bright : bool;
}
Sourceval black : t

Default black color.

Sourceval red : t

Default red color.

Sourceval green : t

Default green color.

Sourceval yellow : t

Default yellow color.

Sourceval blue : t

Default blue color.

Sourceval magenta : t

Default magenta color.

Sourceval cyan : t

Default cyan color.

Sourceval white : t

Default white color.

Sourceval bright_black : t

Default bright black (gray) color.

Sourceval bright_red : t

Default bright red color.

Sourceval bright_green : t

Default bright green color.

Sourceval bright_yellow : t

Default bright yellow color.

Sourceval bright_blue : t

Default bright blue color.

Sourceval bright_magenta : t

Default bright magenta color.

Sourceval bright_cyan : t

Default bright cyan color.

Sourceval bright_white : t

Default bright white color.

Sourceval make_minimal : ?bright:??? -> int -> [ `Minimal of minimal ] option

make_minimal ?bright value creates a minimal color. If value is not a valid color code, it returns None.

A valid color code is an integer i where 0 <= i <= 7.

Sourceval make_minimal_exn : ?bright:??? -> int -> [ `Minimal of minimal ]

make_minimal_exn ?bright value creates a minimal color. If value is not a valid color code, it raises a Failure exception.

A valid color code is an integer i where 0 <= i <= 7.

Sourceval make_advanced : int -> [ `Advanced of int ] option

make_advanced value creates an advanced color. If value is not a valid color code, it returns None.

A valid color code is an integer i where 0 <= i < 256.

Sourceval make_advanced_exn : int -> [ `Advanced of int ]

make_advanced_exn value creates an advanced color. If value is not a valid color code, it raises a Failure exception.

A valid color code is an integer i where 0 <= i < 256.

Sourcemodule Channel : sig ... end
Sourceval make_rgb : int -> int -> int -> ([ `Rgb of int * int * int ], Channel.t) result

make_rgb red green blue creates an RGB color. If any of red, green or blue is not a valid channel value, it returns an Error which indicates which channel had an invalid value.

A valid channel value is an integer i where 0 <= i < 256.

For the version that returns an option instead, see make_rgb_opt.

Sourceval make_rgb_opt : int -> int -> int -> [ `Rgb of int * int * int ] option

make_rgb_opt red green blue creates an RGB color. If any of red, green or blue is not a valid channel value, it returns None.

A valid channel value is an integer i where 0 <= i < 256.

For the version that returns a result with the invalid channel data, see make_rgb.

Sourceval make_rgb_exn : int -> int -> int -> [ `Rgb of int * int * int ]

make_rgb_exn red green blue creates an RGB color. If any of red, green or blue is not a valid channel value, it raises a Failure exception.

A valid channel value is an integer i where 0 <= i < 256.

Sourceval make_rgb_hex : string -> [ `Rgb of int * int * int ] option

make_rgb_hex str parses an RGB color from a string str like 7057fc or #fbca04

Sourceval to_ansi : ground:Ground.t -> t -> string

to_ansi color produces an SGR escape portion that can be embedded in a string based on the color.

Sourceval luminance : [ `Rgb of int * int * int ] -> int

This function returns luminance of an RGB color in range between 0 and 255.

See best_for_contrast for a usage example.

Sourceval best_for_contrast : ?threshold:??? -> [ `Rgb of int * int * int ] -> [ `Dark | `Light ]

best_for_contrast ~threshold rgb takes a color rgb, threshold between 0 and 255 (both inclusive) representing luminescence tolerance, and returns the suggested color theme for the opposite color to achieve the best contrast.

For example, if rgb is a background colour, and best_for_contrast return `Light, you should select a light foreground colour for the best readability.

  • NOTE: Default threshold value is 128.
  • NOTE: Higher threshold will suggest `Light more often and on brighter colours. Lower threshold will suggest `Light for darker colours. The opposite is true for `Dark.