nimterm/style

This page is generated from the module’s exported API and ## documentation comments.

Semantic terminal styles. Backends decide how styles are serialized.

Types

ColorKind = enum
  colorDefault, colorAnsi16, colorAnsi256, colorRgb

ColorValue = object
  kind*: ColorKind
  value*: int
  r*: int
  g*: int
  b*: int

TextAttribute = enum
  attrBold, attrDim, attrItalic, attrUnderline, attrReverse, attrStrikethrough

Style = object
  foreground*: ColorValue
  background*: ColorValue
  attributes*: set[TextAttribute]

proc defaultColor(): ColorValue {.raises: [], tags: [], forbids: [].}

Returns: ColorValue.

proc ansi16(index: int): ColorValue {.raises: [], tags: [], forbids: [].}

Returns: ColorValue.

Name	Type	Default
`index`	`int`

proc ansi256(index: int): ColorValue {.raises: [], tags: [], forbids: [].}

Returns: ColorValue.

Name	Type	Default
`index`	`int`

proc rgb(r, g, b: int): ColorValue {.raises: [], tags: [], forbids: [].}

Returns: ColorValue.

proc defaultStyle(): Style {.raises: [], tags: [], forbids: [].}

Returns: Style.

proc withForeground(style: Style; color: ColorValue): Style {.raises: [],
    tags: [], forbids: [].}

Returns: Style.

Name	Type	Default
`style`	`Style`
`color`	`ColorValue`

proc withBackground(style: Style; color: ColorValue): Style {.raises: [],
    tags: [], forbids: [].}

Returns: Style.

Name	Type	Default
`style`	`Style`
`color`	`ColorValue`

proc withAttribute(style: Style; attribute: TextAttribute): Style {.raises: [],
    tags: [], forbids: [].}

Returns: Style.

Name	Type	Default
`style`	`Style`
`attribute`	`TextAttribute`