IO.ANSI

Introduction #

Functionality to render ANSI escape sequences (http://en.wikipedia.org/wiki/ANSI_escape_code) — characters embedded in text used to control formatting, color, and other output options on video text terminals.

Source

Types #

ansidata :: ansilist | ansicode | binary

Functions #

black()

(function)

Sets foreground color to black

black_background()

(function)

Sets background color to black

Blink: off

Blink: Rapid. MS-DOS ANSI.SYS; 150 per minute or more; not widely supported

Blink: Slow. Less than 150 per minute

blue()

(function)

Sets foreground color to blue

blue_background()

(function)

Sets background color to blue

bright()

(function)

Bright (increased intensity) or Bold

clear()

(function)

Clear screen

conceal()

(function)

Conceal. Not widely supported

crossed_out()

(function)

Crossed-out. Characters legible, but marked for deletion. Not widely supported.

cyan()

(function)

Sets foreground color to cyan

cyan_background()

(function)

Sets background color to cyan

default_background()

(function)

Default background color

default_color()

(function)

Default text color

enabled?()

(function)

Specs

  • enabled? :: boolean

Checks if ANSI coloring is supported and enabled on this machine.

This function simply reads the configuration value for :ansi_enabled in the :elixir application. The value is by default false unless Elixir can detect during startup that both stdout and stderr are terminals.

encircled()

(function)

Encircled

faint()

(function)

Faint (decreased intensity), not widely supported

font_1()

(function)

Sets alternative font 1

font_2()

(function)

Sets alternative font 2

font_3()

(function)

Sets alternative font 3

font_4()

(function)

Sets alternative font 4

font_5()

(function)

Sets alternative font 5

font_6()

(function)

Sets alternative font 6

font_7()

(function)

Sets alternative font 7

font_8()

(function)

Sets alternative font 8

font_9()

(function)

Sets alternative font 9

format(chardata, emit \\ enabled?())

(function)

Formats a chardata-like argument by converting named ANSI sequences into actual ANSI codes.

The named sequences are represented by atoms.

It will also append an IO.ANSI.reset to the chardata when a conversion is performed. If you don't want this behaviour, use format_fragment/2.

An optional boolean parameter can be passed to enable or disable emitting actual ANSI codes. When false, no ANSI codes will emitted. By default checks if ANSI is enabled using the enabled?/0 function.

Examples

iex> IO.ANSI.format(["Hello, ", :red, :bright, "world!"], true)
[[[[[[], "Hello, "] | "\e[31m"] | "\e[1m"], "world!"] | "\e[0m"]

format_fragment(chardata, emit \\ enabled?())

(function)

Formats a chardata-like argument by converting named ANSI sequences into actual ANSI codes.

The named sequences are represented by atoms.

An optional boolean parameter can be passed to enable or disable emitting actual ANSI codes. When false, no ANSI codes will emitted. By default checks if ANSI is enabled using the enabled?/0 function.

Examples

iex> IO.ANSI.format_fragment([:bright, 'Word'], true)
[[[[[[] | "\e[1m"], 87], 111], 114], 100]

framed()

(function)

Framed

green()

(function)

Sets foreground color to green

green_background()

(function)

Sets background color to green

home()

(function)

Send cursor home

inverse()

(function)

Image: Negative. Swap foreground and background

italic()

(function)

Italic: on. Not widely supported. Sometimes treated as inverse.

magenta()

(function)

Sets foreground color to magenta

magenta_background()

(function)

Sets background color to magenta

no_underline()

(function)

Underline: None

normal()

(function)

Normal color or intensity

not_framed_encircled()

(function)

Not framed or encircled

not_italic()

(function)

Not italic

not_overlined()

(function)

Not overlined

overlined()

(function)

Overlined

primary_font()

(function)

Sets primary (default) font

red()

(function)

Sets foreground color to red

red_background()

(function)

Sets background color to red

reset()

(function)

Resets all attributes

reverse()

(function)

Image: Negative. Swap foreground and background

underline()

(function)

Underline: Single

white()

(function)

Sets foreground color to white

white_background()

(function)

Sets background color to white

yellow()

(function)

Sets foreground color to yellow

yellow_background()

(function)

Sets background color to yellow