Style API

Types

Style

pub const Style = struct {
    fg: ?Color = null,
    bg: ?Color = null,
    underline_color: ?Color = null,
    bold: bool = false,
    dim: bool = false,
    italic: bool = false,
    underline: bool = false,
    blink: bool = false,
    rapid_blink: bool = false,
    reverse: bool = false,
    hidden: bool = false,
    strikethrough: bool = false,
    super_script: bool = false,
    sub_script: bool = false,
    fraktur: bool = false,
    overline: bool = false,
    frame: bool = false,
    encircle: bool = false,
};

StyleOptions

pub const StyleOptions = struct {
    fg: ?Color = null,
    bg: ?Color = null,
    underline_color: ?Color = null,
    bold: bool = false,
    dim: bool = false,
    italic: bool = false,
    underline: bool = false,
    blink: bool = false,
    rapid_blink: bool = false,
    reverse: bool = false,
    hidden: bool = false,
    strikethrough: bool = false,
    super_script: bool = false,
    sub_script: bool = false,
    fraktur: bool = false,
    overline: bool = false,
    frame: bool = false,
    encircle: bool = false,
};

Functions

tint.style

pub fn style(opts: StyleOptions) Style

Creates a composable style with the given options.

Methods

Style.init

pub fn init(opts: StyleOptions) Style

Creates a new Style with the given options.

Style.with

pub fn with(self: Style, opts: StyleOptions) Style

Creates a new Style based on this one with the given overrides. Boolean fields are OR'd together.

Style.withFg

pub fn withFg(self: Style, c: Color) Style

Creates a new Style with the given foreground color.

Style.withBg

pub fn withBg(self: Style, c: Color) Style

Creates a new Style with the given background color.

Style.withUnderline

pub fn withUnderline(self: Style, c: Color) Style

Creates a new Style with the given underline color.

Style.compose

pub fn compose(a: Style, b: Style) Style

Merges two styles. Style b overrides colors from style a. Boolean fields are OR'd.

Style.toAnsi

pub fn toAnsi(self: Style) []const u8

Generates the complete ANSI escape sequence for this style.

Presets

tint.presets.err_style

pub fn err_style(fg: Color) Style

Bold text with given foreground color.

tint.presets.warning

pub fn warning(fg: Color) Style

Bold text with given foreground color.

tint.presets.success

pub fn success(fg: Color) Style

Bold text with given foreground color.

tint.presets.info

pub fn info(fg: Color) Style

Normal text with given foreground color.

tint.presets.debug

pub fn debug(fg: Color) Style

Dim text with given foreground color.

tint.presets.link

pub fn link(fg: Color) Style

Underlined text with given foreground color.

tint.presets.code

pub fn code(fg: Color, bg: Color) Style

Text with given foreground and background colors.

tint.presets.header

pub fn header(fg: Color) Style

Bold underlined text with given foreground color.

tint.presets.muted

pub fn muted(fg: Color) Style

Dim text with given foreground color.

tint.presets.highlight

pub fn highlight(fg: Color, bg: Color) Style

Bold text with given foreground and background colors.

tint.presets.strikethrough_text

pub fn strikethrough_text(fg: Color) Style

Strikethrough text with given foreground color.

tint.presets.blink_text

pub fn blink_text(fg: Color) Style

Blinking text with given foreground color.

tint.presets.reverse_text

pub fn reverse_text(fg: Color) Style

Reverse video text with given foreground color.

tint.presets.hidden_text

pub fn hidden_text(fg: Color) Style

Hidden text with given foreground color.

tint.presets.overlined

pub fn overlined(fg: Color) Style

Overlined text with given foreground color.

tint.presets.framed

pub fn framed(fg: Color) Style

Framed text with given foreground color.

tint.presets.encircled

pub fn encircled(fg: Color) Style

Encircled text with given foreground color.