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

    Interface TextFieldData

    Stateful data accepted by the Blessed textField adapter.

    interface TextFieldData {
        characters?: TextFieldCharacters;
        defaultValue?: string;
        disabled?: boolean;
        error?: string;
        hint?: string;
        label: string;
        onSubmit?: (value: string) => void;
        onValueChange?: (value: string) => void;
        placeholder?: string;
        required?: boolean;
        value?: string;
    }
    Index

    Properties

    characters? defaultValue? disabled? error? hint? label onSubmit? onValueChange? placeholder? required? value?

    Properties

    characters?: TextFieldCharacters

    Character tokens used by the pure renderer.

    defaultValue?: string

    Initial text 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.

    onSubmit?: (value: string) => void

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

    onValueChange?: (value: string) => 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.

    value?: string

    Controlled text value.

    Settings

    Member Visibility

    On This Page

    Properties