chromatic

Chromatic

Composable text formatting for CLI in Gleam.

Usage

The best way to use this is through Gleam’s pipelines.

Check it out!

import chromatic.{bold, italic, magenta, rainbow}

pub fn main() {
 io.println(
  "Hello "
  <> "Gleam"
  |> magenta
  |> italic
  |> bold
  <> ", this is "
  <> "Chromatic"
  |> rainbow
  |> bold,
 )
}

Functions

bg_black

</>

pub fn bg_black(string: String) -> String

Set background color to black.

bg_blue

</>

pub fn bg_blue(string: String) -> String

Set background color to blue.

bg_bright_blue

</>

pub fn bg_bright_blue(string: String) -> String

Set background color to a lighter blue.

bg_bright_cyan

</>

pub fn bg_bright_cyan(string: String) -> String

Set background color to a lighter cyan.

bg_bright_green

</>

pub fn bg_bright_green(string: String) -> String

Set background color to a lighter green.

bg_bright_magenta

</>

pub fn bg_bright_magenta(string: String) -> String

Set background color to a lighter magenta.

bg_bright_red

</>

pub fn bg_bright_red(string: String) -> String

Set background color to a lighter red.

bg_bright_white

</>

pub fn bg_bright_white(string: String) -> String

Set background color to a bright white color

bg_bright_yellow

</>

pub fn bg_bright_yellow(string: String) -> String

Set background color to a lighter yellow.

bg_cyan

</>

pub fn bg_cyan(string: String) -> String

Set background color to cyan.

bg_gray

</>

pub fn bg_gray(string: String) -> String

Set background color to gray.

bg_green

</>

pub fn bg_green(string: String) -> String

Set background color to green.

bg_magenta

</>

pub fn bg_magenta(string: String) -> String

Set background color to magenta.

bg_red

</>

pub fn bg_red(string: String) -> String

Set background color to red.

bg_white

</>

pub fn bg_white(string: String) -> String

Set’s background to an off-white color, for a lighter white try bg_bright_white

bg_yellow

</>

pub fn bg_yellow(string: String) -> String

Set background color to yellow.

black

</>

pub fn black(string: String) -> String

Set text color to black.

bleed

</>

pub fn bleed(string: String) -> String

Propagate style from this string until next reset. Must be the last function in the pipeline.

blue

</>

pub fn blue(string: String) -> String

Set text color to blue.

bold

</>

pub fn bold(string: String) -> String

Set text style to bold

bright_blue

</>

pub fn bright_blue(string: String) -> String

Set text color to a lighter blue.

bright_cyan

</>

pub fn bright_cyan(string: String) -> String

Set text color to a lighter cyan.

bright_green

</>

pub fn bright_green(string: String) -> String

Set text color to a lighter green.

bright_magenta

</>

pub fn bright_magenta(string: String) -> String

Set text color to a lighter magenta.

bright_red

</>

pub fn bright_red(string: String) -> String

Set text color to a lighter red.

bright_white

</>

pub fn bright_white(string: String) -> String

Set text color to a bright white color

bright_yellow

</>

pub fn bright_yellow(string: String) -> String

Set text color to a lighter yellow.

clear

</>

pub fn clear(string: String) -> String

Clears any previously added styles that would have bled into it.

Only necessary if you’ve used bleed.

Like bleed needs to be the last function in the pipeline

clear_str

</>

pub fn clear_str() -> String

Print this to clear any styles that are bleeding through.

cyan

</>

pub fn cyan(string: String) -> String

Set text color to cyan.

decorate_ansi

</>

pub fn decorate_ansi(string: String, code: String) -> String

ANSI escape helper, adds a ANSI code to the provided string. This also terminates the string with the clear sequence so it doesn’t affect other strings.

decorate_ansi_raw

</>

pub fn decorate_ansi_raw(string: String, code: String) -> String

ANSI escape helper, adds a ANSI code to the provided string. Unlike the decorate_ansi function not terminate with the clear sequence.

gray

</>

pub fn gray(string: String) -> String

Set text color to gray.

green

</>

pub fn green(string: String) -> String

Set text color to green.

italic

</>

pub fn italic(string: String) -> String

Set text style to italic

magenta

</>

pub fn magenta(string: String) -> String

Set text color to magenta.

offset_rainbow

</>

pub fn offset_rainbow(string: String, offset: Int) -> String

Rainbow text with an integer offset

rainbow

</>

pub fn rainbow(string: String) -> String

red

</>

pub fn red(string: String) -> String

Set text color to red.

underline

</>

pub fn underline(string: String) -> String

Set text style to underlined

white

</>

pub fn white(string: String) -> String

Set text color to an off-white color, for a lighter white try bright_white

yellow

</>

pub fn yellow(string: String) -> String

Set text color to yellow.