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

    Interface FormFieldBinding

    Field binding accepted by the Blessed form adapter.

    interface FormFieldBinding {
        getValue: () => unknown;
        reset?: () => void;
        setValue?: (value: unknown) => boolean | undefined;
        defaultValue?: unknown;
        id: string;
        onValueChange?: (value: unknown, values: FormValues) => void;
        validate?: (value: unknown, values: FormValues) => string | undefined;
    }

    Hierarchy

    Index

    Properties

    getValue reset? setValue? defaultValue? id onValueChange? validate?

    Properties

    getValue: () => unknown

    Returns the current field value.

    reset?: () => void

    Resets the bound field element.

    setValue?: (value: unknown) => boolean | undefined

    Sets the bound field value after Form reset.

    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.

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

    Returns an error message when the current value is invalid.

    Settings

    Member Visibility

    On This Page

    Properties