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

    Interface FormFieldData

    Stateful data accepted by the Blessed formField adapter.

    interface FormFieldData {
        characters?: FormFieldCharacters;
        control: string;
        error?: string;
        hint?: string;
        label: string;
        required?: boolean;
    }
    Index

    Properties

    characters? control error? hint? label required?

    Properties

    characters?: FormFieldCharacters

    Character tokens used by the pure renderer.

    control: string

    Rendered control content, usually from another component renderer.

    error?: string

    Error text. When present it takes precedence over hint.

    hint?: string

    Hint text shown when no error is present.

    label: string

    Form field label.

    required?: boolean

    Whether the label should include a required indicator.

    Settings

    Member Visibility

    On This Page

    Properties