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

    Interface SliderHandle

    Imperative handle returned by slider.

    interface SliderHandle {
        decrement(): boolean;
        focus(): void;
        increment(): boolean;
        setToMax(): boolean;
        setToMin(): boolean;
        setValue(value: number): boolean;
        value(): number;
        element: BoxElement;
        destroy(): void;
        setData(data: SliderData): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    element: BoxElement

    Underlying Blessed element available for standard element operations.

    Methods

    • Moves to the configured maximum and reports whether the value changed.

      Returns boolean

    • Moves to the configured minimum and reports whether the value changed.

      Returns boolean

    • Sets, clamps, and aligns an enabled value.

      Parameters

      • value: number

      Returns boolean