@chromakit/core
    Preparing search index...

    Interface ProgressBarOptions

    Options to customize progressBar.

    interface ProgressBarOptions {
        bgColor?: string;
        border?: boolean;
        char?: string;
        color?: string;
        emptyChar?: string;
        gradient?: string[];
        label?: string;
        showPercent?: boolean;
        width?: number;
    }
    Index

    Properties

    bgColor? border? char? color? emptyChar? gradient? label? showPercent? width?

    Properties

    bgColor?: string

    Intended background color for the unfilled portion.

    Note: This implementation colors the foreground of emptyChar using color, which is usually invisible for spaces. If you need a visible background, either:

    1. use a visible emptyChar (e.g., · or ░), or
    2. switch to a background SGR helper (e.g., rgbToAnsiBg) so the blanks are painted. :contentReference[oaicite:2]{index=2}
    border?: boolean

    Enclose the bar in square brackets, e.g. "[████░░]".

    false

    char?: string

    Character used for the filled portion.

    Defaults to the FULL BLOCK character "█" (U+2588, Unicode Block Elements), which typically occupies one terminal cell and looks solid on most fonts. :contentReference[oaicite:0]{index=0} If you target maximum portability, consider ASCII alternatives (e.g., # or =).

    "█"

    color?: string

    Foreground color for the filled portion (e.g., "cyan" or "#00ffff").

    Applied via ANSI SGR (e.g., ESC[38;2;r;g;bm on truecolor terminals). :contentReference[oaicite:1]{index=1}

    emptyChar?: string

    Character used for the unfilled portion.

    " " (space)

    gradient?: string[]

    Optional multi-stop gradient for the filled segment (overrides ProgressBarOptions.color).

    Uses gradientText to color each filled character from left→right. This emits per-char truecolor SGR sequences and resets at the end. :contentReference[oaicite:3]{index=3}

    label?: string

    Optional label prefix (e.g., "Build" → "Build ███... 42%").

    ""

    showPercent?: boolean

    Show a rounded percentage suffix (e.g., " 73%").

    true

    width?: number

    Total bar width in characters (excluding optional border and label).

    40

    Settings

    Member Visibility

    On This Page

    Properties