View Source Termite.Style (Termite v0.3.0)

This module contains functions for building up a styled input.

The functions in this module are intended to be chained. For example:

iex> Termite.Style.background(5)
...> |> Termite.Style.foreground(3)
...> |> Termite.Style.bold()
...> |> Termite.Style.render_to_string("Hello World")
"[1;45;33mHello World[0m"

Summary

Functions

ansi256(style \\ %Style{})

Change the style type to ansi256 for extended colors.

ansi(style \\ %Style{})

Change the style type to ansi. This is the default value.

background(style \\ %Style{}, color)

Set the background color. This can be a value up to 16 for :ansi or up to 255 for :ansi256.

blink(style \\ %Style{})

Set the text style to blink.

bold(style \\ %Style{})

Set the text style to bold.

crossed_out(style \\ %Style{})

Set the text style to strikethrough.

faint(style \\ %Style{})

Set the text style to dim/faint.

foreground(style \\ %Style{}, color)

Set the foreground (text) color. This can be a value up to 16 for :ansi or up to 255 for :ansi256.

inverse(style \\ %Style{})

Set the text style to inverse (swap foreground/background colors).

italic(style \\ %Style{})

Set the text style to italic.

render_to_string(style \\ %Style{}, str)

Render a string with the specified styles. And a reset code.

reset_code()

Output the reset code.

reverse(style \\ %Style{})

Set the text style to inverse (swap foreground/background colors).

underline(style \\ %Style{})

Set the text style to underline.

Functions

ansi256(style \\ %Style{})

Change the style type to ansi256 for extended colors.

ansi(style \\ %Style{})

Change the style type to ansi. This is the default value.

background(style \\ %Style{}, color)

Set the background color. This can be a value up to 16 for :ansi or up to 255 for :ansi256.

blink(style \\ %Style{})

Set the text style to blink.

bold(style \\ %Style{})

Set the text style to bold.

crossed_out(style \\ %Style{})

Set the text style to strikethrough.

faint(style \\ %Style{})

Set the text style to dim/faint.

foreground(style \\ %Style{}, color)

Set the foreground (text) color. This can be a value up to 16 for :ansi or up to 255 for :ansi256.

inverse(style \\ %Style{})

Set the text style to inverse (swap foreground/background colors).

italic(style \\ %Style{})

Set the text style to italic.

render_to_string(style \\ %Style{}, str)

Render a string with the specified styles. And a reset code.

iex> Termite.Style.bold()
...> |> Termite.Style.render_to_string("Hello")
"[1mHello[0m"

reset_code()

Output the reset code.

iex> Termite.Style.reset_code()
"[0m"

reverse(style \\ %Style{})

Set the text style to inverse (swap foreground/background colors).

underline(style \\ %Style{})

Set the text style to underline.