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

    Interface ProgressListData

    Stateful data accepted by the Blessed progressList adapter.

    interface ProgressListData {
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">;
        characters?: ProgressBarCharacters;
        tone?: keyof ThemeColors;
        formatValue?: (context: ProgressBarValueContext) => string;
        height?: number;
        items: readonly ProgressListItem[];
        labelGap?: number;
        labelWidth?: number;
        max?: number;
        min?: number;
        showValue?: boolean;
        trackWidth?: number;
        valueGap?: number;
        width?: number;
    }

    Hierarchy

    Index

    Properties

    backgroundTone? borderTone? theme? capabilities? characters? tone? formatValue? height? items labelGap? labelWidth? max? min? showValue? trackWidth? valueGap? 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?: ProgressBarCharacters

    Custom track characters.

    tone?: keyof ThemeColors

    Semantic foreground token.

    'foreground'

    formatValue?: (context: ProgressBarValueContext) => string

    Formats row value text.

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

    height?: number

    Maximum rendered line count.

    items: readonly ProgressListItem[]

    Ordered rows to render.

    labelGap?: number

    Gap between label and track.

    1

    labelWidth?: number

    Fixed label width. Defaults to the widest sanitized label.

    max?: number

    Default upper bound for rows.

    100

    min?: number

    Default lower bound for rows.

    0

    showValue?: boolean

    Whether value text is rendered after the track.

    true

    trackWidth?: number

    Fixed track width. Defaults to available width, or 10.

    valueGap?: number

    Gap between track and value.

    1

    width?: number

    Maximum rendered row width measured in terminal cells.

    Settings

    Member Visibility

    On This Page

    Properties