@spec primary_font() :: String.t()
Sets primary (default) font.
Functionality to render ANSI escape sequences.
ANSI escape sequences are characters embedded in text used to control formatting, color, and other output options on video text terminals.
ANSI escapes are typically enabled on all Unix terminals. They are also available on Windows consoles from Windows 10, although it must be explicitly enabled for the current user in the registry by running the following command:
reg add HKCU\Console /v VirtualTerminalLevel /t REG_DWORD /d 1
After running the command above, you must restart your current console.
Because the ANSI escape sequences are embedded in text, the normal usage of these functions is to concatenate their output with text.
formatted_text = IO.ANSI.blue_background() <> "Example" <> IO.ANSI.reset()
IO.puts(formatted_text)
A higher level and more convenient API is provided via IO.ANSI.format/1
which accepts atoms to represent ANSI escape sequences and which, by default,
checks if ANSI is enabled:
IO.puts(IO.ANSI.format([:blue_background, "Example"]))
In case ANSI is disabled, the ANSI escape sequences are simply discarded.
In addition to the 16 regular ANSI colors and their background counterparts, this module also supports the 256 Xterm colors (foreground and background).
New shortcut functions IO.ANSI.Plus.gets/2
, IO.ANSI.Plus.puts/2
and
IO.ANSI.Plus.write/2
are also provided.
Sets foreground color to black.
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.
Sets foreground color to blue.
Sets background color to blue.
Bright (increased intensity) or bold.
Clears screen.
Clears line.
Sets foreground color.
Sets the foreground color from individual RGB values.
Sets background color.
Sets the background color from individual RGB values.
Conceal. Not widely supported.
Crossed-out. Characters legible, but marked for deletion. Not widely supported.
Sends cursor to the absolute position specified by line
and column
.
Sends cursor lines
down.
Sends cursor columns
to the left.
Sends cursor columns
to the right.
Sends cursor lines
up.
Sets foreground color to cyan.
Sets background color to cyan.
Default background color.
Default text color.
Checks if ANSI coloring is supported and enabled on this machine.
Encircled.
Faint (decreased intensity). Not widely supported.
Sets alternative font 1.
Sets alternative font 2.
Sets alternative font 3.
Sets alternative font 4.
Sets alternative font 5.
Sets alternative font 6.
Sets alternative font 7.
Sets alternative font 8.
Sets alternative font 9.
Formats a chardata-like argument by converting named ANSI sequences into actual ANSI codes.
Formats a chardata-like argument by converting named ANSI sequences into actual ANSI codes.
Framed.
Sets foreground color to green.
Sets background color to green.
Sends cursor home.
Image: negative. Swap foreground and background.
Image: positive. Normal foreground and background.
Italic: on. Not widely supported. Sometimes treated as inverse.
Sets foreground color to light black.
Sets background color to light black.
Sets foreground color to light blue.
Sets background color to light blue.
Sets foreground color to light cyan.
Sets background color to light cyan.
Sets foreground color to light green.
Sets background color to light green.
Sets foreground color to light magenta.
Sets background color to light magenta.
Sets foreground color to light red.
Sets background color to light red.
Sets foreground color to light white.
Sets background color to light white.
Sets foreground color to light yellow.
Sets background color to light yellow.
Sets foreground color to magenta.
Sets background color to magenta.
Underline: none.
Normal color or intensity.
Not framed or encircled.
Not italic.
Not overlined.
Overlined.
Sets primary (default) font.
Sets foreground color to red.
Sets background color to red.
Resets all attributes.
Image: negative. Swap foreground and background.
Image: positive. Normal foreground and background.
Underline: single.
Sets foreground color to white.
Sets background color to white.
Sets foreground color to yellow.
Sets background color to yellow.
@spec aero_blue() :: String.t()
@spec aero_blue_background() :: String.t()
@spec air_force_blue() :: String.t()
@spec air_force_blue_background() :: String.t()
@spec alto() :: String.t()
@spec alto_background() :: String.t()
@spec anakiwa() :: String.t()
@spec anakiwa_background() :: String.t()
@spec aqua() :: String.t()
@spec aqua_background() :: String.t()
@spec aths_special() :: String.t()
@spec aths_special_background() :: String.t()
@spec baby_blue() :: String.t()
@spec baby_blue_background() :: String.t()
@spec bandicoot() :: String.t()
@spec bandicoot_background() :: String.t()
@spec beige() :: String.t()
@spec beige_background() :: String.t()
@spec bermuda() :: String.t()
@spec bermuda_background() :: String.t()
@spec bittersweet() :: String.t()
@spec bittersweet_background() :: String.t()
@spec black() :: String.t()
Sets foreground color to black.
@spec black_background() :: String.t()
Sets background color to black.
@spec blink_off() :: String.t()
Blink: off.
@spec blink_rapid() :: String.t()
Blink: rapid. MS-DOS ANSI.SYS; 150 per minute or more; not widely supported.
@spec blink_slow() :: String.t()
Blink: slow. Less than 150 per minute.
@spec blue() :: String.t()
Sets foreground color to blue.
@spec blue_background() :: String.t()
Sets background color to blue.
@spec blue_lagoon() :: String.t()
@spec blue_lagoon_background() :: String.t()
@spec blue_marguerite() :: String.t()
@spec blue_marguerite_background() :: String.t()
@spec blue_ribbon() :: String.t()
@spec blue_ribbon_background() :: String.t()
@spec blue_stone() :: String.t()
@spec blue_stone_background() :: String.t()
@spec blue_violet() :: String.t()
@spec blue_violet_background() :: String.t()
@spec bondi_blue() :: String.t()
@spec bondi_blue_background() :: String.t()
@spec bright() :: String.t()
Bright (increased intensity) or bold.
@spec bright_green() :: String.t()
@spec bright_green_background() :: String.t()
@spec bright_turquoise() :: String.t()
@spec bright_turquoise_background() :: String.t()
@spec brown() :: String.t()
@spec brown_background() :: String.t()
@spec buddha_gold() :: String.t()
@spec buddha_gold_background() :: String.t()
@spec cadet_blue() :: String.t()
@spec cadet_blue_background() :: String.t()
@spec calico() :: String.t()
@spec calico_background() :: String.t()
@spec camarone() :: String.t()
@spec camarone_background() :: String.t()
@spec canary() :: String.t()
@spec canary_background() :: String.t()
@spec caribbean_green() :: String.t()
@spec caribbean_green_background() :: String.t()
@spec cerulean() :: String.t()
@spec cerulean_background() :: String.t()
@spec charcoal() :: String.t()
@spec charcoal_background() :: String.t()
@spec chartreuse() :: String.t()
@spec chartreuse_background() :: String.t()
@spec chartreuse_yellow() :: String.t()
@spec chartreuse_yellow_background() :: String.t()
@spec chelsea_cucumber() :: String.t()
@spec chelsea_cucumber_background() :: String.t()
@spec chinook() :: String.t()
@spec chinook_background() :: String.t()
@spec chocolate() :: String.t()
@spec chocolate_background() :: String.t()
@spec citrus() :: String.t()
@spec citrus_background() :: String.t()
@spec clear() :: String.t()
Clears screen.
@spec clear_line() :: String.t()
Clears line.
@spec cobalt() :: String.t()
@spec cobalt_background() :: String.t()
@spec cod_gray() :: String.t()
@spec cod_gray_background() :: String.t()
@spec color0() :: String.t()
@spec color0_background() :: String.t()
@spec color1() :: String.t()
@spec color1_background() :: String.t()
@spec color2() :: String.t()
@spec color2_background() :: String.t()
@spec color3() :: String.t()
@spec color3_background() :: String.t()
@spec color4() :: String.t()
@spec color4_background() :: String.t()
@spec color5() :: String.t()
@spec color5_background() :: String.t()
@spec color6() :: String.t()
@spec color6_background() :: String.t()
@spec color7() :: String.t()
@spec color7_background() :: String.t()
@spec color8() :: String.t()
@spec color8_background() :: String.t()
@spec color9() :: String.t()
@spec color9_background() :: String.t()
@spec color10() :: String.t()
@spec color10_background() :: String.t()
@spec color11() :: String.t()
@spec color11_background() :: String.t()
@spec color12() :: String.t()
@spec color12_background() :: String.t()
@spec color13() :: String.t()
@spec color13_background() :: String.t()
@spec color14() :: String.t()
@spec color14_background() :: String.t()
@spec color15() :: String.t()
@spec color15_background() :: String.t()
@spec color16() :: String.t()
@spec color16_background() :: String.t()
@spec color17() :: String.t()
@spec color17_background() :: String.t()
@spec color18() :: String.t()
@spec color18_background() :: String.t()
@spec color19() :: String.t()
@spec color19_background() :: String.t()
@spec color20() :: String.t()
@spec color20_background() :: String.t()
@spec color21() :: String.t()
@spec color21_background() :: String.t()
@spec color22() :: String.t()
@spec color22_background() :: String.t()
@spec color23() :: String.t()
@spec color23_background() :: String.t()
@spec color24() :: String.t()
@spec color24_background() :: String.t()
@spec color25() :: String.t()
@spec color25_background() :: String.t()
@spec color26() :: String.t()
@spec color26_background() :: String.t()
@spec color27() :: String.t()
@spec color27_background() :: String.t()
@spec color28() :: String.t()
@spec color28_background() :: String.t()
@spec color29() :: String.t()
@spec color29_background() :: String.t()
@spec color30() :: String.t()
@spec color30_background() :: String.t()
@spec color31() :: String.t()
@spec color31_background() :: String.t()
@spec color32() :: String.t()
@spec color32_background() :: String.t()
@spec color33() :: String.t()
@spec color33_background() :: String.t()
@spec color34() :: String.t()
@spec color34_background() :: String.t()
@spec color35() :: String.t()
@spec color35_background() :: String.t()
@spec color36() :: String.t()
@spec color36_background() :: String.t()
@spec color37() :: String.t()
@spec color37_background() :: String.t()
@spec color38() :: String.t()
@spec color38_background() :: String.t()
@spec color39() :: String.t()
@spec color39_background() :: String.t()
@spec color40() :: String.t()
@spec color40_background() :: String.t()
@spec color41() :: String.t()
@spec color41_background() :: String.t()
@spec color42() :: String.t()
@spec color42_background() :: String.t()
@spec color43() :: String.t()
@spec color43_background() :: String.t()
@spec color44() :: String.t()
@spec color44_background() :: String.t()
@spec color45() :: String.t()
@spec color45_background() :: String.t()
@spec color46() :: String.t()
@spec color46_background() :: String.t()
@spec color47() :: String.t()
@spec color47_background() :: String.t()
@spec color48() :: String.t()
@spec color48_background() :: String.t()
@spec color49() :: String.t()
@spec color49_background() :: String.t()
@spec color50() :: String.t()
@spec color50_background() :: String.t()
@spec color51() :: String.t()
@spec color51_background() :: String.t()
@spec color52() :: String.t()
@spec color52_background() :: String.t()
@spec color53() :: String.t()
@spec color53_background() :: String.t()
@spec color54() :: String.t()
@spec color54_background() :: String.t()
@spec color55() :: String.t()
@spec color55_background() :: String.t()
@spec color56() :: String.t()
@spec color56_background() :: String.t()
@spec color57() :: String.t()
@spec color57_background() :: String.t()
@spec color58() :: String.t()
@spec color58_background() :: String.t()
@spec color59() :: String.t()
@spec color59_background() :: String.t()
@spec color60() :: String.t()
@spec color60_background() :: String.t()
@spec color61() :: String.t()
@spec color61_background() :: String.t()
@spec color62() :: String.t()
@spec color62_background() :: String.t()
@spec color63() :: String.t()
@spec color63_background() :: String.t()
@spec color64() :: String.t()
@spec color64_background() :: String.t()
@spec color65() :: String.t()
@spec color65_background() :: String.t()
@spec color66() :: String.t()
@spec color66_background() :: String.t()
@spec color67() :: String.t()
@spec color67_background() :: String.t()
@spec color68() :: String.t()
@spec color68_background() :: String.t()
@spec color69() :: String.t()
@spec color69_background() :: String.t()
@spec color70() :: String.t()
@spec color70_background() :: String.t()
@spec color71() :: String.t()
@spec color71_background() :: String.t()
@spec color72() :: String.t()
@spec color72_background() :: String.t()
@spec color73() :: String.t()
@spec color73_background() :: String.t()
@spec color74() :: String.t()
@spec color74_background() :: String.t()
@spec color75() :: String.t()
@spec color75_background() :: String.t()
@spec color76() :: String.t()
@spec color76_background() :: String.t()
@spec color77() :: String.t()
@spec color77_background() :: String.t()
@spec color78() :: String.t()
@spec color78_background() :: String.t()
@spec color79() :: String.t()
@spec color79_background() :: String.t()
@spec color80() :: String.t()
@spec color80_background() :: String.t()
@spec color81() :: String.t()
@spec color81_background() :: String.t()
@spec color82() :: String.t()
@spec color82_background() :: String.t()
@spec color83() :: String.t()
@spec color83_background() :: String.t()
@spec color84() :: String.t()
@spec color84_background() :: String.t()
@spec color85() :: String.t()
@spec color85_background() :: String.t()
@spec color86() :: String.t()
@spec color86_background() :: String.t()
@spec color87() :: String.t()
@spec color87_background() :: String.t()
@spec color88() :: String.t()
@spec color88_background() :: String.t()
@spec color89() :: String.t()
@spec color89_background() :: String.t()
@spec color90() :: String.t()
@spec color90_background() :: String.t()
@spec color91() :: String.t()
@spec color91_background() :: String.t()
@spec color92() :: String.t()
@spec color92_background() :: String.t()
@spec color93() :: String.t()
@spec color93_background() :: String.t()
@spec color94() :: String.t()
@spec color94_background() :: String.t()
@spec color95() :: String.t()
@spec color95_background() :: String.t()
@spec color96() :: String.t()
@spec color96_background() :: String.t()
@spec color97() :: String.t()
@spec color97_background() :: String.t()
@spec color98() :: String.t()
@spec color98_background() :: String.t()
@spec color99() :: String.t()
@spec color99_background() :: String.t()
@spec color100() :: String.t()
@spec color100_background() :: String.t()
@spec color101() :: String.t()
@spec color101_background() :: String.t()
@spec color102() :: String.t()
@spec color102_background() :: String.t()
@spec color103() :: String.t()
@spec color103_background() :: String.t()
@spec color104() :: String.t()
@spec color104_background() :: String.t()
@spec color105() :: String.t()
@spec color105_background() :: String.t()
@spec color106() :: String.t()
@spec color106_background() :: String.t()
@spec color107() :: String.t()
@spec color107_background() :: String.t()
@spec color108() :: String.t()
@spec color108_background() :: String.t()
@spec color109() :: String.t()
@spec color109_background() :: String.t()
@spec color110() :: String.t()
@spec color110_background() :: String.t()
@spec color111() :: String.t()
@spec color111_background() :: String.t()
@spec color112() :: String.t()
@spec color112_background() :: String.t()
@spec color113() :: String.t()
@spec color113_background() :: String.t()
@spec color114() :: String.t()
@spec color114_background() :: String.t()
@spec color115() :: String.t()
@spec color115_background() :: String.t()
@spec color116() :: String.t()
@spec color116_background() :: String.t()
@spec color117() :: String.t()
@spec color117_background() :: String.t()
@spec color118() :: String.t()
@spec color118_background() :: String.t()
@spec color119() :: String.t()
@spec color119_background() :: String.t()
@spec color120() :: String.t()
@spec color120_background() :: String.t()
@spec color121() :: String.t()
@spec color121_background() :: String.t()
@spec color122() :: String.t()
@spec color122_background() :: String.t()
@spec color123() :: String.t()
@spec color123_background() :: String.t()
@spec color124() :: String.t()
@spec color124_background() :: String.t()
@spec color125() :: String.t()
@spec color125_background() :: String.t()
@spec color126() :: String.t()
@spec color126_background() :: String.t()
@spec color127() :: String.t()
@spec color127_background() :: String.t()
@spec color128() :: String.t()
@spec color128_background() :: String.t()
@spec color129() :: String.t()
@spec color129_background() :: String.t()
@spec color130() :: String.t()
@spec color130_background() :: String.t()
@spec color131() :: String.t()
@spec color131_background() :: String.t()
@spec color132() :: String.t()
@spec color132_background() :: String.t()
@spec color133() :: String.t()
@spec color133_background() :: String.t()
@spec color134() :: String.t()
@spec color134_background() :: String.t()
@spec color135() :: String.t()
@spec color135_background() :: String.t()
@spec color136() :: String.t()
@spec color136_background() :: String.t()
@spec color137() :: String.t()
@spec color137_background() :: String.t()
@spec color138() :: String.t()
@spec color138_background() :: String.t()
@spec color139() :: String.t()
@spec color139_background() :: String.t()
@spec color140() :: String.t()
@spec color140_background() :: String.t()
@spec color141() :: String.t()
@spec color141_background() :: String.t()
@spec color142() :: String.t()
@spec color142_background() :: String.t()
@spec color143() :: String.t()
@spec color143_background() :: String.t()
@spec color144() :: String.t()
@spec color144_background() :: String.t()
@spec color145() :: String.t()
@spec color145_background() :: String.t()
@spec color146() :: String.t()
@spec color146_background() :: String.t()
@spec color147() :: String.t()
@spec color147_background() :: String.t()
@spec color148() :: String.t()
@spec color148_background() :: String.t()
@spec color149() :: String.t()
@spec color149_background() :: String.t()
@spec color150() :: String.t()
@spec color150_background() :: String.t()
@spec color151() :: String.t()
@spec color151_background() :: String.t()
@spec color152() :: String.t()
@spec color152_background() :: String.t()
@spec color153() :: String.t()
@spec color153_background() :: String.t()
@spec color154() :: String.t()
@spec color154_background() :: String.t()
@spec color155() :: String.t()
@spec color155_background() :: String.t()
@spec color156() :: String.t()
@spec color156_background() :: String.t()
@spec color157() :: String.t()
@spec color157_background() :: String.t()
@spec color158() :: String.t()
@spec color158_background() :: String.t()
@spec color159() :: String.t()
@spec color159_background() :: String.t()
@spec color160() :: String.t()
@spec color160_background() :: String.t()
@spec color161() :: String.t()
@spec color161_background() :: String.t()
@spec color162() :: String.t()
@spec color162_background() :: String.t()
@spec color163() :: String.t()
@spec color163_background() :: String.t()
@spec color164() :: String.t()
@spec color164_background() :: String.t()
@spec color165() :: String.t()
@spec color165_background() :: String.t()
@spec color166() :: String.t()
@spec color166_background() :: String.t()
@spec color167() :: String.t()
@spec color167_background() :: String.t()
@spec color168() :: String.t()
@spec color168_background() :: String.t()
@spec color169() :: String.t()
@spec color169_background() :: String.t()
@spec color170() :: String.t()
@spec color170_background() :: String.t()
@spec color171() :: String.t()
@spec color171_background() :: String.t()
@spec color172() :: String.t()
@spec color172_background() :: String.t()
@spec color173() :: String.t()
@spec color173_background() :: String.t()
@spec color174() :: String.t()
@spec color174_background() :: String.t()
@spec color175() :: String.t()
@spec color175_background() :: String.t()
@spec color176() :: String.t()
@spec color176_background() :: String.t()
@spec color177() :: String.t()
@spec color177_background() :: String.t()
@spec color178() :: String.t()
@spec color178_background() :: String.t()
@spec color179() :: String.t()
@spec color179_background() :: String.t()
@spec color180() :: String.t()
@spec color180_background() :: String.t()
@spec color181() :: String.t()
@spec color181_background() :: String.t()
@spec color182() :: String.t()
@spec color182_background() :: String.t()
@spec color183() :: String.t()
@spec color183_background() :: String.t()
@spec color184() :: String.t()
@spec color184_background() :: String.t()
@spec color185() :: String.t()
@spec color185_background() :: String.t()
@spec color186() :: String.t()
@spec color186_background() :: String.t()
@spec color187() :: String.t()
@spec color187_background() :: String.t()
@spec color188() :: String.t()
@spec color188_background() :: String.t()
@spec color189() :: String.t()
@spec color189_background() :: String.t()
@spec color190() :: String.t()
@spec color190_background() :: String.t()
@spec color191() :: String.t()
@spec color191_background() :: String.t()
@spec color192() :: String.t()
@spec color192_background() :: String.t()
@spec color193() :: String.t()
@spec color193_background() :: String.t()
@spec color194() :: String.t()
@spec color194_background() :: String.t()
@spec color195() :: String.t()
@spec color195_background() :: String.t()
@spec color196() :: String.t()
@spec color196_background() :: String.t()
@spec color197() :: String.t()
@spec color197_background() :: String.t()
@spec color198() :: String.t()
@spec color198_background() :: String.t()
@spec color199() :: String.t()
@spec color199_background() :: String.t()
@spec color200() :: String.t()
@spec color200_background() :: String.t()
@spec color201() :: String.t()
@spec color201_background() :: String.t()
@spec color202() :: String.t()
@spec color202_background() :: String.t()
@spec color203() :: String.t()
@spec color203_background() :: String.t()
@spec color204() :: String.t()
@spec color204_background() :: String.t()
@spec color205() :: String.t()
@spec color205_background() :: String.t()
@spec color206() :: String.t()
@spec color206_background() :: String.t()
@spec color207() :: String.t()
@spec color207_background() :: String.t()
@spec color208() :: String.t()
@spec color208_background() :: String.t()
@spec color209() :: String.t()
@spec color209_background() :: String.t()
@spec color210() :: String.t()
@spec color210_background() :: String.t()
@spec color211() :: String.t()
@spec color211_background() :: String.t()
@spec color212() :: String.t()
@spec color212_background() :: String.t()
@spec color213() :: String.t()
@spec color213_background() :: String.t()
@spec color214() :: String.t()
@spec color214_background() :: String.t()
@spec color215() :: String.t()
@spec color215_background() :: String.t()
@spec color216() :: String.t()
@spec color216_background() :: String.t()
@spec color217() :: String.t()
@spec color217_background() :: String.t()
@spec color218() :: String.t()
@spec color218_background() :: String.t()
@spec color219() :: String.t()
@spec color219_background() :: String.t()
@spec color220() :: String.t()
@spec color220_background() :: String.t()
@spec color221() :: String.t()
@spec color221_background() :: String.t()
@spec color222() :: String.t()
@spec color222_background() :: String.t()
@spec color223() :: String.t()
@spec color223_background() :: String.t()
@spec color224() :: String.t()
@spec color224_background() :: String.t()
@spec color225() :: String.t()
@spec color225_background() :: String.t()
@spec color226() :: String.t()
@spec color226_background() :: String.t()
@spec color227() :: String.t()
@spec color227_background() :: String.t()
@spec color228() :: String.t()
@spec color228_background() :: String.t()
@spec color229() :: String.t()
@spec color229_background() :: String.t()
@spec color230() :: String.t()
@spec color230_background() :: String.t()
@spec color231() :: String.t()
@spec color231_background() :: String.t()
@spec color232() :: String.t()
@spec color232_background() :: String.t()
@spec color233() :: String.t()
@spec color233_background() :: String.t()
@spec color234() :: String.t()
@spec color234_background() :: String.t()
@spec color235() :: String.t()
@spec color235_background() :: String.t()
@spec color236() :: String.t()
@spec color236_background() :: String.t()
@spec color237() :: String.t()
@spec color237_background() :: String.t()
@spec color238() :: String.t()
@spec color238_background() :: String.t()
@spec color239() :: String.t()
@spec color239_background() :: String.t()
@spec color240() :: String.t()
@spec color240_background() :: String.t()
@spec color241() :: String.t()
@spec color241_background() :: String.t()
@spec color242() :: String.t()
@spec color242_background() :: String.t()
@spec color243() :: String.t()
@spec color243_background() :: String.t()
@spec color244() :: String.t()
@spec color244_background() :: String.t()
@spec color245() :: String.t()
@spec color245_background() :: String.t()
@spec color246() :: String.t()
@spec color246_background() :: String.t()
@spec color247() :: String.t()
@spec color247_background() :: String.t()
@spec color248() :: String.t()
@spec color248_background() :: String.t()
@spec color249() :: String.t()
@spec color249_background() :: String.t()
@spec color250() :: String.t()
@spec color250_background() :: String.t()
@spec color251() :: String.t()
@spec color251_background() :: String.t()
@spec color252() :: String.t()
@spec color252_background() :: String.t()
@spec color253() :: String.t()
@spec color253_background() :: String.t()
@spec color254() :: String.t()
@spec color254_background() :: String.t()
@spec color255() :: String.t()
@spec color255_background() :: String.t()
@spec color(0..255) :: String.t()
Sets foreground color.
@spec color(0..5, 0..5, 0..5) :: String.t()
Sets the foreground color from individual RGB values.
Valid values for each color are in the range 0 to 5.
@spec color_background(0..255) :: String.t()
Sets background color.
@spec color_background(0..5, 0..5, 0..5) :: String.t()
Sets the background color from individual RGB values.
Valid values for each color are in the range 0 to 5.
@spec columbia_blue() :: String.t()
@spec columbia_blue_background() :: String.t()
@spec conceal() :: String.t()
Conceal. Not widely supported.
@spec conifer() :: String.t()
@spec conifer_background() :: String.t()
@spec copper() :: String.t()
@spec copper_background() :: String.t()
@spec coral() :: String.t()
@spec coral_background() :: String.t()
@spec coral_tree() :: String.t()
@spec coral_tree_background() :: String.t()
@spec corn() :: String.t()
@spec corn_background() :: String.t()
@spec cornflower_blue() :: String.t()
@spec cornflower_blue_background() :: String.t()
@spec cotton_candy() :: String.t()
@spec cotton_candy_background() :: String.t()
@spec cream() :: String.t()
@spec cream_background() :: String.t()
@spec crossed_out() :: String.t()
Crossed-out. Characters legible, but marked for deletion. Not widely supported.
@spec cumulus() :: String.t()
@spec cumulus_background() :: String.t()
@spec cursor(non_neg_integer(), non_neg_integer()) :: String.t()
Sends cursor to the absolute position specified by line
and column
.
Line 0
and column 0
would mean the top left corner.
@spec cursor_down(pos_integer()) :: String.t()
Sends cursor lines
down.
@spec cursor_left(pos_integer()) :: String.t()
Sends cursor columns
to the left.
@spec cursor_right(pos_integer()) :: String.t()
Sends cursor columns
to the right.
@spec cursor_up(pos_integer()) :: String.t()
Sends cursor lines
up.
@spec cyan() :: String.t()
Sets foreground color to cyan.
@spec cyan_background() :: String.t()
Sets background color to cyan.
@spec dandelion() :: String.t()
@spec dandelion_background() :: String.t()
@spec dark_blue() :: String.t()
@spec dark_blue_background() :: String.t()
@spec dark_cyan() :: String.t()
@spec dark_cyan_background() :: String.t()
@spec dark_goldenrod() :: String.t()
@spec dark_goldenrod_background() :: String.t()
@spec dark_gray() :: String.t()
@spec dark_gray_background() :: String.t()
@spec dark_green() :: String.t()
@spec dark_green_background() :: String.t()
@spec dark_khaki() :: String.t()
@spec dark_khaki_background() :: String.t()
@spec dark_magenta() :: String.t()
@spec dark_magenta_background() :: String.t()
@spec dark_orange() :: String.t()
@spec dark_orange_background() :: String.t()
@spec dark_red() :: String.t()
@spec dark_red_background() :: String.t()
@spec dark_sea_green() :: String.t()
@spec dark_sea_green_background() :: String.t()
@spec dark_slate_gray() :: String.t()
@spec dark_slate_gray_background() :: String.t()
@spec dark_turquoise() :: String.t()
@spec dark_turquoise_background() :: String.t()
@spec dark_violet() :: String.t()
@spec dark_violet_background() :: String.t()
@spec deco() :: String.t()
@spec deco_background() :: String.t()
@spec deep_magenta() :: String.t()
@spec deep_magenta_background() :: String.t()
@spec deep_pink() :: String.t()
@spec deep_pink_background() :: String.t()
@spec deep_sea() :: String.t()
@spec deep_sea_background() :: String.t()
@spec deep_sky_blue() :: String.t()
@spec deep_sky_blue_background() :: String.t()
@spec default_background() :: String.t()
Default background color.
@spec default_color() :: String.t()
Default text color.
@spec dim_gray() :: String.t()
@spec dim_gray_background() :: String.t()
@spec dodger_blue() :: String.t()
@spec dodger_blue_background() :: String.t()
@spec dolly() :: String.t()
@spec dolly_background() :: String.t()
@spec dove_gray() :: String.t()
@spec dove_gray_background() :: String.t()
@spec dusty_gray() :: String.t()
@spec dusty_gray_background() :: String.t()
@spec eclipse() :: String.t()
@spec eclipse_background() :: String.t()
@spec eggplant() :: String.t()
@spec eggplant_background() :: String.t()
@spec electric_blue() :: String.t()
@spec electric_blue_background() :: String.t()
@spec electric_indigo() :: String.t()
@spec electric_indigo_background() :: String.t()
@spec electric_purple() :: String.t()
@spec electric_purple_background() :: String.t()
@spec electric_violet() :: String.t()
@spec electric_violet_background() :: String.t()
@spec empress() :: String.t()
@spec empress_background() :: String.t()
@spec 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.
@spec encircled() :: String.t()
Encircled.
@spec endeavour() :: String.t()
@spec endeavour_background() :: String.t()
@spec equator() :: String.t()
@spec equator_background() :: String.t()
@spec faint() :: String.t()
Faint (decreased intensity). Not widely supported.
@spec feijoa() :: String.t()
@spec feijoa_background() :: String.t()
@spec fern() :: String.t()
@spec fern_background() :: String.t()
@spec flirt() :: String.t()
@spec flirt_background() :: String.t()
@spec font_1() :: String.t()
Sets alternative font 1.
@spec font_2() :: String.t()
Sets alternative font 2.
@spec font_3() :: String.t()
Sets alternative font 3.
@spec font_4() :: String.t()
Sets alternative font 4.
@spec font_5() :: String.t()
Sets alternative font 5.
@spec font_6() :: String.t()
Sets alternative font 6.
@spec font_7() :: String.t()
Sets alternative font 7.
@spec font_8() :: String.t()
Sets alternative font 8.
@spec font_9() :: String.t()
Sets alternative font 9.
@spec format(ansidata(), boolean()) :: IO.chardata()
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/0
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 be emitted.
By default checks if ANSI is enabled using the enabled?/0
function.
An ArgumentError
will be raised if an invalid ANSI code is provided.
iex> IO.ANSI.Plus.format(["Hello, ", :red, :bright, "world!"], true)
[[[[[[], "Hello, "] | "\e[31m"] | "\e[1m"], "world!"] | "\e[0m"]
@spec format_fragment(ansidata(), boolean()) :: IO.chardata()
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 be emitted.
By default checks if ANSI is enabled using the enabled?/0
function.
iex> IO.ANSI.Plus.format_fragment([:bright, ~c"Word"], true)
[[[[[[] | "\e[1m"], 87], 111], 114], 100]
@spec fountain_blue() :: String.t()
@spec fountain_blue_background() :: String.t()
@spec framed() :: String.t()
Framed.
@spec free_speech_red() :: String.t()
@spec free_speech_red_background() :: String.t()
@spec french_lilac() :: String.t()
@spec french_lilac_background() :: String.t()
@spec french_pass() :: String.t()
@spec french_pass_background() :: String.t()
@spec fresh_eggplant() :: String.t()
@spec fresh_eggplant_background() :: String.t()
@spec fuchsia() :: String.t()
@spec fuchsia_background() :: String.t()
@spec fuchsia_pink() :: String.t()
@spec fuchsia_pink_background() :: String.t()
@spec gainsboro() :: String.t()
@spec gainsboro_background() :: String.t()
@spec gallery() :: String.t()
@spec gallery_background() :: String.t()
@spec gets(ansidata(), boolean()) :: IO.chardata() | IO.nodata()
@spec gold() :: String.t()
@spec gold_background() :: String.t()
@spec golden_poppy() :: String.t()
@spec golden_poppy_background() :: String.t()
@spec goldenrod() :: String.t()
@spec goldenrod_background() :: String.t()
@spec gossip() :: String.t()
@spec gossip_background() :: String.t()
@spec gray() :: String.t()
@spec gray_background() :: String.t()
@spec green() :: String.t()
Sets foreground color to green.
@spec green_background() :: String.t()
Sets background color to green.
@spec green_yellow() :: String.t()
@spec green_yellow_background() :: String.t()
@spec grey() :: String.t()
@spec grey_background() :: String.t()
@spec guardsman_red() :: String.t()
@spec guardsman_red_background() :: String.t()
@spec heliotrope() :: String.t()
@spec heliotrope_background() :: String.t()
@spec hippie_green() :: String.t()
@spec hippie_green_background() :: String.t()
@spec hit_pink() :: String.t()
@spec hit_pink_background() :: String.t()
@spec hoki() :: String.t()
@spec hoki_background() :: String.t()
@spec hollywood_cerise() :: String.t()
@spec hollywood_cerise_background() :: String.t()
@spec home() :: String.t()
Sends cursor home.
@spec honeydew() :: String.t()
@spec honeydew_background() :: String.t()
@spec hopbush() :: String.t()
@spec hopbush_background() :: String.t()
@spec hot_magenta() :: String.t()
@spec hot_magenta_background() :: String.t()
@spec hot_pink() :: String.t()
@spec hot_pink_background() :: String.t()
@spec indian_red() :: String.t()
@spec indian_red_background() :: String.t()
@spec indigo() :: String.t()
@spec indigo_background() :: String.t()
@spec inverse() :: String.t()
Image: negative. Swap foreground and background.
@spec inverse_off() :: String.t()
Image: positive. Normal foreground and background.
@spec iris_blue() :: String.t()
@spec iris_blue_background() :: String.t()
@spec islamic_green() :: String.t()
@spec islamic_green_background() :: String.t()
@spec italic() :: String.t()
Italic: on. Not widely supported. Sometimes treated as inverse.
@spec jade() :: String.t()
@spec jade_background() :: String.t()
@spec japanese_laurel() :: String.t()
@spec japanese_laurel_background() :: String.t()
@spec keppel() :: String.t()
@spec keppel_background() :: String.t()
@spec khaki() :: String.t()
@spec khaki_background() :: String.t()
@spec kimberly() :: String.t()
@spec kimberly_background() :: String.t()
@spec kobi() :: String.t()
@spec kobi_background() :: String.t()
@spec laser_lemon() :: String.t()
@spec laser_lemon_background() :: String.t()
@spec lavender_blue() :: String.t()
@spec lavender_blue_background() :: String.t()
@spec lavender_blush() :: String.t()
@spec lavender_blush_background() :: String.t()
@spec lavender_rose() :: String.t()
@spec lavender_rose_background() :: String.t()
@spec lawn_green() :: String.t()
@spec lawn_green_background() :: String.t()
@spec light_black() :: String.t()
Sets foreground color to light black.
@spec light_black_background() :: String.t()
Sets background color to light black.
@spec light_blue() :: String.t()
Sets foreground color to light blue.
@spec light_blue_background() :: String.t()
Sets background color to light blue.
@spec light_coral() :: String.t()
@spec light_coral_background() :: String.t()
@spec light_cyan() :: String.t()
Sets foreground color to light cyan.
@spec light_cyan_background() :: String.t()
Sets background color to light cyan.
@spec light_gray() :: String.t()
@spec light_gray_background() :: String.t()
@spec light_green() :: String.t()
Sets foreground color to light green.
@spec light_green_background() :: String.t()
Sets background color to light green.
@spec light_grey() :: String.t()
@spec light_grey_background() :: String.t()
@spec light_magenta() :: String.t()
Sets foreground color to light magenta.
@spec light_magenta_background() :: String.t()
Sets background color to light magenta.
@spec light_red() :: String.t()
Sets foreground color to light red.
@spec light_red_background() :: String.t()
Sets background color to light red.
@spec light_sea_green() :: String.t()
@spec light_sea_green_background() :: String.t()
@spec light_slate_blue() :: String.t()
@spec light_slate_blue_background() :: String.t()
@spec light_slate_grey() :: String.t()
@spec light_slate_grey_background() :: String.t()
@spec light_steel_blue() :: String.t()
@spec light_steel_blue_background() :: String.t()
@spec light_white() :: String.t()
Sets foreground color to light white.
@spec light_white_background() :: String.t()
Sets background color to light white.
@spec light_wood() :: String.t()
@spec light_wood_background() :: String.t()
@spec light_yellow() :: String.t()
Sets foreground color to light yellow.
@spec light_yellow_background() :: String.t()
Sets background color to light yellow.
@spec lime() :: String.t()
@spec lime_background() :: String.t()
@spec limeade() :: String.t()
@spec limeade_background() :: String.t()
@spec london_hue() :: String.t()
@spec london_hue_background() :: String.t()
@spec macaroni_and_cheese() :: String.t()
@spec macaroni_and_cheese_background() :: String.t()
@spec magenta() :: String.t()
Sets foreground color to magenta.
@spec magenta_background() :: String.t()
Sets background color to magenta.
@spec malachite() :: String.t()
@spec malachite_background() :: String.t()
@spec malibu() :: String.t()
@spec malibu_background() :: String.t()
@spec mango_tango() :: String.t()
@spec mango_tango_background() :: String.t()
@spec maroon() :: String.t()
@spec maroon_background() :: String.t()
@spec matterhorn() :: String.t()
@spec matterhorn_background() :: String.t()
@spec mauve() :: String.t()
@spec mauve_background() :: String.t()
@spec maya_blue() :: String.t()
@spec maya_blue_background() :: String.t()
@spec medium_blue() :: String.t()
@spec medium_blue_background() :: String.t()
@spec medium_orchid() :: String.t()
@spec medium_orchid_background() :: String.t()
@spec medium_purple() :: String.t()
@spec medium_purple_background() :: String.t()
@spec medium_spring_green() :: String.t()
@spec medium_spring_green_background() :: String.t()
@spec medium_turquoise() :: String.t()
@spec medium_turquoise_background() :: String.t()
@spec medium_violet_red() :: String.t()
@spec medium_violet_red_background() :: String.t()
@spec melon() :: String.t()
@spec melon_background() :: String.t()
@spec mercury() :: String.t()
@spec mercury_background() :: String.t()
@spec mine_shaft() :: String.t()
@spec mine_shaft_background() :: String.t()
@spec mint_green() :: String.t()
@spec mint_green_background() :: String.t()
@spec moccasin() :: String.t()
@spec moccasin_background() :: String.t()
@spec mona_lisa() :: String.t()
@spec mona_lisa_background() :: String.t()
@spec moon_raker() :: String.t()
@spec moon_raker_background() :: String.t()
@spec mortar() :: String.t()
@spec mortar_background() :: String.t()
@spec mosque() :: String.t()
@spec mosque_background() :: String.t()
@spec my_pink() :: String.t()
@spec my_pink_background() :: String.t()
@spec mysty_rose() :: String.t()
@spec mysty_rose_background() :: String.t()
@spec neon_blue() :: String.t()
@spec neon_blue_background() :: String.t()
@spec neon_pink() :: String.t()
@spec neon_pink_background() :: String.t()
@spec nero() :: String.t()
@spec nero_background() :: String.t()
@spec neutral_green() :: String.t()
@spec neutral_green_background() :: String.t()
@spec new_midnight_blue() :: String.t()
@spec new_midnight_blue_background() :: String.t()
@spec night_rider() :: String.t()
@spec night_rider_background() :: String.t()
@spec no_underline() :: String.t()
Underline: none.
@spec normal() :: String.t()
Normal color or intensity.
@spec not_framed_encircled() :: String.t()
Not framed or encircled.
@spec not_italic() :: String.t()
Not italic.
@spec not_overlined() :: String.t()
Not overlined.
@spec observatory() :: String.t()
@spec observatory_background() :: String.t()
@spec olive() :: String.t()
@spec olive_background() :: String.t()
@spec olive_green() :: String.t()
@spec olive_green_background() :: String.t()
@spec orange() :: String.t()
@spec orange_background() :: String.t()
@spec orange_red() :: String.t()
@spec orange_red_background() :: String.t()
@spec orchid() :: String.t()
@spec orchid_background() :: String.t()
@spec orient() :: String.t()
@spec orient_background() :: String.t()
@spec overlined() :: String.t()
Overlined.
@spec oyster_bay() :: String.t()
@spec oyster_bay_background() :: String.t()
@spec pacific_blue() :: String.t()
@spec pacific_blue_background() :: String.t()
@spec pale_green() :: String.t()
@spec pale_green_background() :: String.t()
@spec pale_violet_red() :: String.t()
@spec pale_violet_red_background() :: String.t()
@spec pastel_green() :: String.t()
@spec pastel_green_background() :: String.t()
@spec persian_green() :: String.t()
@spec persian_green_background() :: String.t()
@spec picton_blue() :: String.t()
@spec picton_blue_background() :: String.t()
@spec pink_flamingo() :: String.t()
@spec pink_flamingo_background() :: String.t()
@spec pink_flare() :: String.t()
@spec pink_flare_background() :: String.t()
@spec plum() :: String.t()
@spec plum_background() :: String.t()
@spec portafino() :: String.t()
@spec portafino_background() :: String.t()
@spec portage() :: String.t()
@spec portage_background() :: String.t()
@spec primary_font() :: String.t()
Sets primary (default) font.
@spec psychedelic_purple() :: String.t()
@spec psychedelic_purple_background() :: String.t()
@spec purple() :: String.t()
@spec purple_background() :: String.t()
@spec purple_pizzazz() :: String.t()
@spec purple_pizzazz_background() :: String.t()
@spec rajah() :: String.t()
@spec rajah_background() :: String.t()
@spec razzmatazz() :: String.t()
@spec razzmatazz_background() :: String.t()
@spec red() :: String.t()
Sets foreground color to red.
@spec red_background() :: String.t()
Sets background color to red.
@spec reef() :: String.t()
@spec reef_background() :: String.t()
@spec reset() :: String.t()
Resets all attributes.
@spec reverse() :: String.t()
Image: negative. Swap foreground and background.
@spec reverse_off() :: String.t()
Image: positive. Normal foreground and background.
@spec rich_blue() :: String.t()
@spec rich_blue_background() :: String.t()
@spec riptide() :: String.t()
@spec riptide_background() :: String.t()
@spec roman() :: String.t()
@spec roman_background() :: String.t()
@spec rose() :: String.t()
@spec rose_background() :: String.t()
@spec rose_of_sharon() :: String.t()
@spec rose_of_sharon_background() :: String.t()
@spec rosewood() :: String.t()
@spec rosewood_background() :: String.t()
@spec rosy_brown() :: String.t()
@spec rosy_brown_background() :: String.t()
@spec royal_blue() :: String.t()
@spec royal_blue_background() :: String.t()
@spec safety_orange() :: String.t()
@spec safety_orange_background() :: String.t()
@spec salomie() :: String.t()
@spec salomie_background() :: String.t()
@spec sandy_brown() :: String.t()
@spec sandy_brown_background() :: String.t()
@spec scandal() :: String.t()
@spec scandal_background() :: String.t()
@spec school_bus_yellow() :: String.t()
@spec school_bus_yellow_background() :: String.t()
@spec science_blue() :: String.t()
@spec science_blue_background() :: String.t()
@spec scorpion() :: String.t()
@spec scorpion_background() :: String.t()
@spec screamin_green() :: String.t()
@spec screamin_green_background() :: String.t()
@spec seagull() :: String.t()
@spec seagull_background() :: String.t()
@spec shakespeare() :: String.t()
@spec shakespeare_background() :: String.t()
@spec ship_cove() :: String.t()
@spec ship_cove_background() :: String.t()
@spec silver() :: String.t()
@spec silver_background() :: String.t()
@spec silver_chalice() :: String.t()
@spec silver_chalice_background() :: String.t()
@spec slate_blue() :: String.t()
@spec slate_blue_background() :: String.t()
@spec spring_bud() :: String.t()
@spec spring_bud_background() :: String.t()
@spec spring_green() :: String.t()
@spec spring_green_background() :: String.t()
@spec steel_blue() :: String.t()
@spec steel_blue_background() :: String.t()
@spec stratos() :: String.t()
@spec stratos_background() :: String.t()
@spec suva_grey() :: String.t()
@spec suva_grey_background() :: String.t()
@spec tacha() :: String.t()
@spec tacha_background() :: String.t()
@spec tan() :: String.t()
@spec tan_background() :: String.t()
@spec tapestry() :: String.t()
@spec tapestry_background() :: String.t()
@spec teak() :: String.t()
@spec teak_background() :: String.t()
@spec teal() :: String.t()
@spec teal_background() :: String.t()
@spec tenn() :: String.t()
@spec tenn_background() :: String.t()
@spec tenne() :: String.t()
@spec tenne_background() :: String.t()
@spec thatch() :: String.t()
@spec thatch_background() :: String.t()
@spec tickle_me_pink() :: String.t()
@spec tickle_me_pink_background() :: String.t()
@spec trendy_pink() :: String.t()
@spec trendy_pink_background() :: String.t()
@spec tundora() :: String.t()
@spec tundora_background() :: String.t()
@spec tyrian_purple() :: String.t()
@spec tyrian_purple_background() :: String.t()
@spec underline() :: String.t()
Underline: single.
@spec verdun_green() :: String.t()
@spec verdun_green_background() :: String.t()
@spec violet() :: String.t()
@spec violet_background() :: String.t()
@spec violet_blue() :: String.t()
@spec violet_blue_background() :: String.t()
@spec white() :: String.t()
Sets foreground color to white.
@spec white_background() :: String.t()
Sets background color to white.
@spec white_smoke() :: String.t()
@spec white_smoke_background() :: String.t()
@spec wild_watermelon() :: String.t()
@spec wild_watermelon_background() :: String.t()
@spec wisteria() :: String.t()
@spec wisteria_background() :: String.t()
@spec yellow() :: String.t()
Sets foreground color to yellow.
@spec yellow_background() :: String.t()
Sets background color to yellow.
@spec ziggurat() :: String.t()
@spec ziggurat_background() :: String.t()