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

    Interface RenderTextFieldOptions

    Options accepted by renderTextField.

    interface RenderTextFieldOptions {
        characters?: TextFieldCharacters;
        disabled?: boolean;
        error?: string;
        focused?: boolean;
        height?: number;
        hint?: string;
        label: string;
        placeholder?: string;
        required?: boolean;
        value?: string;
        width: number;
    }
    Index

    Properties

    characters? disabled? error? focused? height? hint? label placeholder? required? value? width

    Properties

    characters?: TextFieldCharacters

    Character tokens used by the field and supporting text.

    disabled?: boolean

    Whether focus and editing are unavailable.

    error?: string

    Error text. When present it takes precedence over hint.

    focused?: boolean

    Whether the input currently owns terminal focus.

    height?: number

    Maximum rendered height.

    hint?: string

    Hint text shown when no error is present.

    label: string

    Field label.

    placeholder?: string

    Placeholder shown when value is empty.

    required?: boolean

    Whether the label should include a required indicator.

    value?: string

    Current text value.

    width: number

    Maximum terminal-cell width of each line.

    Settings

    Member Visibility

    On This Page

    Properties