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

    Interface NumberFieldHandle

    Imperative handle returned by numberField.

    interface NumberFieldHandle {
        clear(): boolean;
        decrement(): boolean;
        focus(): void;
        increment(): boolean;
        setInput(input: string): boolean;
        setValue(value: number | undefined): boolean;
        submit(): boolean;
        value(): number | undefined;
        element: TextboxElement;
        destroy(): void;
        setData(data: NumberFieldData): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    element: TextboxElement

    Underlying Blessed element available for standard element operations.

    Methods

    • Parses and sets an enabled text input and reports whether editing occurred.

      Parameters

      • input: string

      Returns boolean

    • Sets an enabled numeric value and reports whether editing occurred.

      Parameters

      • value: number | undefined

      Returns boolean