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

    Interface FormFieldDefinition

    Options used to register one field with createFormState.

    interface FormFieldDefinition {
        defaultValue?: unknown;
        id: string;
        onValueChange?: (value: unknown, values: FormValues) => void;
        value?: unknown;
        validate?: (value: unknown, values: FormValues) => string | undefined;
    }
    Index

    Properties

    defaultValue? id onValueChange? value? validate?

    Properties

    defaultValue?: unknown

    Initial value used by uncontrolled reset.

    id: string

    Stable field id.

    onValueChange?: (value: unknown, values: FormValues) => void

    Called when a field value changes.

    value?: unknown

    Controlled field value.

    validate?: (value: unknown, values: FormValues) => string | undefined

    Returns an error message when the current value is invalid.

    Settings

    Member Visibility

    On This Page

    Properties