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

    Interface RenderSliderOptions

    Options accepted by renderSlider.

    interface RenderSliderOptions {
        max?: number;
        min?: number;
        step?: number;
        characters?: SliderCharacters;
        disabled?: boolean;
        formatValue?: (context: SliderValueContext) => string;
        focused?: boolean;
        label: string;
        value: number;
        width: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    max? min? step? characters? disabled? formatValue? focused? label value width

    Properties

    max?: number

    Inclusive upper bound.

    100

    min?: number

    Inclusive lower bound.

    0

    step?: number

    Positive increment anchored at min.

    1

    characters?: SliderCharacters

    Character tokens used for the track and state markers.

    disabled?: boolean

    Whether focus and value changes are unavailable.

    formatValue?: (context: SliderValueContext) => string

    Formats the text shown after the track. Return an empty string to hide it.

    focused?: boolean

    Whether the slider currently owns terminal focus.

    label: string

    Persistent, non-empty, single-line accessible label.

    value: number

    Current numeric value. Values are clamped and aligned to step.

    width: number

    Number of terminal cells reserved for the track, including the thumb.

    Settings

    Member Visibility

    On This Page

    Properties