Index

Modules: palettes, terminal_style, terminal_style/ansi, terminal_style/colors, terminal_style/widths.

API symbols

`==`:

• colors: proc `==`(left, right: TerminalColor): bool

alignCenter:

• widths: TextAlignment.alignCenter

alignLeft:

• widths: TextAlignment.alignLeft

alignRight:

• widths: TextAlignment.alignRight

ansi16Color:

• colors: proc ansi16Color(index: range[0 .. 15]): TerminalColor

ansiCode:

• colors: proc ansiCode(color: TerminalColor; plane = cpForeground): string
• colors: proc ansiCode(textStyle: TerminalStyle): string
• colors: proc ansiCode(attribute: TextAttribute): string

ansiEscape:

• ansi: const ansiEscape

ansiPalette:

• palettes: const ansiPalette

ansiReset:

• ansi: const ansiReset

AnsiToken:

• ansi: object AnsiToken

AnsiTokenKind:

• ansi: enum AnsiTokenKind

applyStyle:

• colors: proc applyStyle(value: string; textStyle: TerminalStyle; enabled = true): string

atkCsi:

• ansi: AnsiTokenKind.atkCsi

atkEscape:

• ansi: AnsiTokenKind.atkEscape

atkOsc:

• ansi: AnsiTokenKind.atkOsc

atkText:

• ansi: AnsiTokenKind.atkText

background:

• colors: proc background(color: TerminalColor; values: varargs[string, `$`]): string

bgBlack:

• colors: proc bgBlack(values`gensym23: varargs[string, $]): string

bgBlue:

• colors: proc bgBlue(values`gensym27: varargs[string, $]): string

bgBrightBlack:

• colors: proc bgBrightBlack(values`gensym31: varargs[string, $]): string

bgBrightBlue:

• colors: proc bgBrightBlue(values`gensym35: varargs[string, $]): string

bgBrightCyan:

• colors: proc bgBrightCyan(values`gensym37: varargs[string, $]): string

bgBrightGreen:

• colors: proc bgBrightGreen(values`gensym33: varargs[string, $]): string

bgBrightMagenta:

• colors: proc bgBrightMagenta(values`gensym36: varargs[string, $]): string

bgBrightRed:

• colors: proc bgBrightRed(values`gensym32: varargs[string, $]): string

bgBrightWhite:

• colors: proc bgBrightWhite(values`gensym38: varargs[string, $]): string

bgBrightYellow:

• colors: proc bgBrightYellow(values`gensym34: varargs[string, $]): string

bgCyan:

• colors: proc bgCyan(values`gensym29: varargs[string, $]): string

bgGreen:

• colors: proc bgGreen(values`gensym25: varargs[string, $]): string

bgMagenta:

• colors: proc bgMagenta(values`gensym28: varargs[string, $]): string

bgRed:

• colors: proc bgRed(values`gensym24: varargs[string, $]): string

bgWhite:

• colors: proc bgWhite(values`gensym30: varargs[string, $]): string

bgYellow:

• colors: proc bgYellow(values`gensym26: varargs[string, $]): string

black:

• colors: proc black(values`gensym7: varargs[string, $]): string

blink:

• colors: proc blink(values`gensym43: varargs[string, $]): string

blue:

• colors: proc blue(values`gensym11: varargs[string, $]): string

bold:

• colors: proc bold(values`gensym39: varargs[string, $]): string

brightBlack:

• colors: proc brightBlack(values`gensym15: varargs[string, $]): string

brightBlue:

• colors: proc brightBlue(values`gensym19: varargs[string, $]): string

brightCyan:

• colors: proc brightCyan(values`gensym21: varargs[string, $]): string

brightGreen:

• colors: proc brightGreen(values`gensym17: varargs[string, $]): string

brightMagenta:

• colors: proc brightMagenta(values`gensym20: varargs[string, $]): string

brightRed:

• colors: proc brightRed(values`gensym16: varargs[string, $]): string

brightWhite:

• colors: proc brightWhite(values`gensym22: varargs[string, $]): string

brightYellow:

• colors: proc brightYellow(values`gensym18: varargs[string, $]): string

colorBlack:

• colors: const colorBlack

colorBlue:

• colors: const colorBlue

colorBrightBlack:

• colors: const colorBrightBlack

colorBrightBlue:

• colors: const colorBrightBlue

colorBrightCyan:

• colors: const colorBrightCyan

colorBrightGreen:

• colors: const colorBrightGreen

colorBrightMagenta:

• colors: const colorBrightMagenta

colorBrightRed:

• colors: const colorBrightRed

colorBrightWhite:

• colors: const colorBrightWhite

colorBrightYellow:

• colors: const colorBrightYellow

colorCyan:

• colors: const colorCyan

colorDefault:

• colors: const colorDefault

colorGreen:

• colors: const colorGreen

colorMagenta:

• colors: const colorMagenta

ColorPlane:

• colors: enum ColorPlane

colorRed:

• colors: const colorRed

colorWhite:

• colors: const colorWhite

colorYellow:

• colors: const colorYellow

composeAnsi:

• ansi: proc composeAnsi(opening, value: string; enabled = true): string

conceal:

• colors: proc conceal(values`gensym47: varargs[string, $]): string

cpBackground:

• colors: ColorPlane.cpBackground

cpForeground:

• colors: ColorPlane.cpForeground

cyan:

• colors: proc cyan(values`gensym13: varargs[string, $]): string

defaultDarkPalette:

• palettes: const defaultDarkPalette

defaultLightPalette:

• palettes: const defaultLightPalette

dim:

• colors: proc dim(values`gensym40: varargs[string, $]): string

displayWidth:

• widths: proc displayWidth(value: string): int

foreground:

• colors: proc foreground(color: TerminalColor; values: varargs[string, `$`]): string

green:

• colors: proc green(values`gensym9: varargs[string, $]): string

hexColor:

• colors: proc hexColor(value: string): TerminalColor

hidden:

• colors: proc hidden(values`gensym48: varargs[string, $]): string

indexed:

• colors: proc indexed(index: range[0 .. 255]; values: varargs[string, `$`]): string

indexedColor:

• colors: proc indexedColor(index: range[0 .. 255]): TerminalColor

initTerminalPalette:

• palettes: proc initTerminalPalette(black: TerminalColor = colorBlack; red: TerminalColor = colorRed; green: TerminalColor = colorGreen; yellow: TerminalColor = colorYellow; blue: TerminalColor = colorBlue; magenta: TerminalColor = colorMagenta; cyan: TerminalColor = colorCyan; white: TerminalColor = colorWhite; brightBlack: TerminalColor = colorBrightBlack; brightRed: TerminalColor = colorBrightRed; brightGreen: TerminalColor = colorBrightGreen; brightYellow: TerminalColor = colorBrightYellow; brightBlue: TerminalColor = colorBrightBlue; brightMagenta: TerminalColor = colorBrightMagenta; brightCyan: TerminalColor = colorBrightCyan; brightWhite: TerminalColor = colorBrightWhite): TerminalPalette

initTerminalStyle:

• colors: proc initTerminalStyle(foreground = colorDefault; background = colorDefault; attributes: set[TextAttribute] = {}): TerminalStyle

italic:

• colors: proc italic(values`gensym41: varargs[string, $]): string

magenta:

• colors: proc magenta(values`gensym12: varargs[string, $]): string

negative:

• colors: proc negative(values`gensym45: varargs[string, $]): string

onIndexed:

• colors: proc onIndexed(index: range[0 .. 255]; values: varargs[string, `$`]): string

onRgb:

• colors: proc onRgb(red, green, blue: range[0 .. 255]; values: varargs[string, `$`]): string

overline:

• colors: proc overline(values`gensym50: varargs[string, $]): string

padAnsi:

• widths: proc padAnsi(value: string; width: int; alignment = alignLeft; padding = ' '): string

rapidBlink:

• colors: proc rapidBlink(values`gensym44: varargs[string, $]): string

red:

• colors: proc red(values`gensym8: varargs[string, $]): string

reverse:

• colors: proc reverse(values`gensym46: varargs[string, $]): string

rgb:

• colors: proc rgb(red, green, blue: range[0 .. 255]; values: varargs[string, `$`]): string

rgbColor:

• colors: proc rgbColor(red, green, blue: range[0 .. 255]): TerminalColor

sliceAnsi:

• widths: proc sliceAnsi(value: string; startCell, maxWidth: int): string

strikethrough:

• colors: proc strikethrough(values`gensym49: varargs[string, $]): string

stripAnsi:

• ansi: proc stripAnsi(value: string): string

style:

• colors: proc style(value: string; textStyle: TerminalStyle; enabled = true): string
• colors: proc style(values: varargs[string, `$`]; style: string): string

styled:

• colors: proc styled(textStyle: TerminalStyle; values: varargs[string, `$`]): string

taBlink:

• colors: TextAttribute.taBlink

taBold:

• colors: TextAttribute.taBold

taConceal:

• colors: TextAttribute.taConceal

taDim:

• colors: TextAttribute.taDim

taItalic:

• colors: TextAttribute.taItalic

taOverline:

• colors: TextAttribute.taOverline

taRapidBlink:

• colors: TextAttribute.taRapidBlink

taReverse:

• colors: TextAttribute.taReverse

taStrikethrough:

• colors: TextAttribute.taStrikethrough

taUnderline:

• colors: TextAttribute.taUnderline

tckAnsi16:

• colors: TerminalColorKind.tckAnsi16

tckAnsi256:

• colors: TerminalColorKind.tckAnsi256

tckDefault:

• colors: TerminalColorKind.tckDefault

tckRgb:

• colors: TerminalColorKind.tckRgb

termBgBlack:

• colors: const termBgBlack

termBgBlue:

• colors: const termBgBlue

termBgBrightBlack:

• colors: const termBgBrightBlack

termBgBrightBlue:

• colors: const termBgBrightBlue

termBgBrightCyan:

• colors: const termBgBrightCyan

termBgBrightGreen:

• colors: const termBgBrightGreen

termBgBrightMagenta:

• colors: const termBgBrightMagenta

termBgBrightRed:

• colors: const termBgBrightRed

termBgBrightWhite:

• colors: const termBgBrightWhite

termBgBrightYellow:

• colors: const termBgBrightYellow

termBgCyan:

• colors: const termBgCyan

termBgGreen:

• colors: const termBgGreen

termBgMagenta:

• colors: const termBgMagenta

termBgRed:

• colors: const termBgRed

termBgWhite:

• colors: const termBgWhite

termBgYellow:

• colors: const termBgYellow

termBlack:

• colors: const termBlack

termBlink:

• colors: const termBlink

termBlue:

• colors: const termBlue

termBold:

• colors: const termBold

termBrightBlack:

• colors: const termBrightBlack

termBrightBlue:

• colors: const termBrightBlue

termBrightCyan:

• colors: const termBrightCyan

termBrightGreen:

• colors: const termBrightGreen

termBrightMagenta:

• colors: const termBrightMagenta

termBrightRed:

• colors: const termBrightRed

termBrightWhite:

• colors: const termBrightWhite

termBrightYellow:

• colors: const termBrightYellow

termClear:

• colors: const termClear

termConceal:

• colors: const termConceal

termCyan:

• colors: const termCyan

termDim:

• colors: const termDim

termGreen:

• colors: const termGreen

termHidden:

• colors: const termHidden

TerminalColor:

• colors: object TerminalColor

TerminalColorKind:

• colors: enum TerminalColorKind

TerminalPalette:

• palettes: object TerminalPalette

TerminalStyle:

• colors: object TerminalStyle

termItalic:

• colors: const termItalic

termMagenta:

• colors: const termMagenta

termNegative:

• colors: const termNegative

termOverline:

• colors: const termOverline

termRapidBlink:

• colors: const termRapidBlink

termRed:

• colors: const termRed

termReverse:

• colors: const termReverse

termStrikethrough:

• colors: const termStrikethrough

termUnderline:

• colors: const termUnderline

termWhite:

• colors: const termWhite

termYellow:

• colors: const termYellow

TextAlignment:

• widths: enum TextAlignment

TextAttribute:

• colors: enum TextAttribute

tokenizeAnsi:

• ansi: proc tokenizeAnsi(value: string): seq[AnsiToken]

truncateAnsi:

• widths: proc truncateAnsi(value: string; maxWidth: int; suffix = "…"): string

underline:

• colors: proc underline(values`gensym42: varargs[string, $]): string

white:

• colors: proc white(values`gensym14: varargs[string, $]): string

wrapAnsi:

• widths: proc wrapAnsi(value: string; width: int; mode = wrapWords): seq[string]

wrapCharacters:

• widths: WrapMode.wrapCharacters

WrapMode:

• widths: enum WrapMode

wrapWords:

• widths: WrapMode.wrapWords

yellow:

• colors: proc yellow(values`gensym10: varargs[string, $]): string