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

    Interface MetricBarsData<TMetric>

    Stateful data accepted by the Blessed metricBars adapter.

    interface MetricBarsData<TMetric extends MetricBarItem = MetricBarItem> {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        tone?: keyof ThemeColors;
        barWidth: number;
        characters?: ProgressBarCharacters;
        emptyText?: string;
        formatValue?: (context: MetricBarValueContext<TMetric>) => string;
        label?: string;
        max?: number;
        metrics: readonly TMetric[];
        min?: number;
        value?: string | number;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? theme? tone? barWidth characters? emptyText? formatValue? label? max? metrics min? value?

    Properties

    capabilities?: Pick<TerminalCapabilities, "colorLevel">

    Explicit color capability used for deterministic rendering.

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    theme?: Theme

    Semantic terminal theme.

    tone?: keyof ThemeColors

    Semantic foreground token.

    'foreground'

    barWidth: number

    Positive integer width of every progress track.

    characters?: ProgressBarCharacters

    Shared filled and empty track characters.

    { filled: '█', empty: '░' }

    emptyText?: string

    Text returned when metrics is empty.

    'No metrics'

    formatValue?: (context: MetricBarValueContext<TMetric>) => string

    Formats trailing text for each row.

    Context includes percentage, clamped numeric value, and original typed metric object.

    Percentage text inherited from ProgressBar

    label?: string

    Optional overall heading label rendered above the rows.

    max?: number

    Shared upper domain bound.

    100

    metrics: readonly TMetric[]

    Ordered metrics. The input array and objects are never mutated.

    min?: number

    Shared lower domain bound.

    0

    value?: string | number

    Optional overall heading value rendered next to label.

    Settings

    Member Visibility

    On This Page

    Properties