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

    Interface NumberFieldData

    Stateful data accepted by the Blessed numberField adapter.

    interface NumberFieldData {
        characters?: NumberFieldCharacters;
        defaultValue?: number;
        disabled?: boolean;
        error?: string;
        hint?: string;
        label: string;
        max?: number;
        min?: number;
        onInvalidInput?: (
            input: string,
            reason: "empty" | "invalid" | "below-min" | "above-max",
        ) => void;
        onSubmit?: (value: number) => void;
        onValueChange?: (value: number | undefined) => void;
        placeholder?: string;
        required?: boolean;
        showStepper?: boolean;
        step?: number;
        value?: number;
    }
    Index

    Properties

    characters? defaultValue? disabled? error? hint? label max? min? onInvalidInput? onSubmit? onValueChange? placeholder? required? showStepper? step? value?

    Properties

    characters?: NumberFieldCharacters

    Character tokens used by the pure renderer.

    defaultValue?: number

    Initial numeric value for uncontrolled usage.

    disabled?: boolean

    Whether focus and editing are unavailable.

    error?: string

    Error text. When present it takes precedence over hint.

    hint?: string

    Hint text shown when no error is present.

    label: string

    Field label.

    max?: number

    Inclusive maximum accepted value.

    min?: number

    Inclusive minimum accepted value.

    onInvalidInput?: (
        input: string,
        reason: "empty" | "invalid" | "below-min" | "above-max",
    ) => void

    Called when parsing user text fails.

    onSubmit?: (value: number) => void

    Called when the user or imperative API requests a submitted value.

    onValueChange?: (value: number | undefined) => void

    Called after user or imperative edits request a value change.

    placeholder?: string

    Placeholder shown when value is empty.

    required?: boolean

    Whether the label should include a required indicator.

    showStepper?: boolean

    Whether to show decrement/increment affordances.

    step?: number

    Increment/decrement amount.

    value?: number

    Controlled numeric value.

    Settings

    Member Visibility

    On This Page

    Properties