blessed-components - v1.20.0
    Preparing search index...

    Interface ProgressStackData

    Stateful data accepted by the Blessed progressStack adapter.

    interface ProgressStackData {
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">;
        characters?: readonly string[];
        tone?: keyof ThemeColors;
        formatValue?: (context: ProgressStackValueContext) => string;
        height?: number;
        showLegend?: boolean;
        segments: readonly ProgressStackSegment[];
        total?: number;
        width: number;
    }

    Hierarchy

    Index

    Properties

    backgroundTone? borderTone? theme? capabilities? characters? tone? formatValue? height? showLegend? segments total? width

    Properties

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    theme?: Theme

    Semantic terminal theme.

    capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">

    Explicit terminal capabilities used for deterministic rendering.

    characters?: readonly string[]

    Custom segment characters.

    tone?: keyof ThemeColors

    Semantic foreground token.

    'foreground'

    formatValue?: (context: ProgressStackValueContext) => string

    Formats legend value text.

    ({ percentage }) => ${percentage}%``

    height?: number

    Maximum rendered line count.

    showLegend?: boolean

    Whether legend rows are rendered under the track.

    true

    segments: readonly ProgressStackSegment[]

    Ordered segments to render.

    total?: number

    Total value represented by the full track.

    Defaults to the sum of segment values.

    width: number

    Fixed track width measured in terminal cells.

    Settings

    Member Visibility

    On This Page

    Properties