Interface FormHandle

Imperative handle returned by form.

interface FormHandle {
    errors(): FormErrors;
    focusNext(): void;
    focusPrevious(): void;
    registerField(field: FormFieldBinding): void;
    reset(): FormValues;
    submit(): FormSubmitResult;
    unregisterField(id: string): void;
    validate(): FormErrors;
    values(): FormValues;
    element: FormElement;
    destroy(): void;
    setData(data: FormData): void;
}

Hierarchy (View Summary)

BlessedComponentHandle<FormData, blessed.Widgets.FormElement<FormValues>>
- FormHandle

Index

Properties

Methods

errors focusNext focusPrevious registerField reset submit unregisterField validate values destroy setData

Properties

`Readonly`element

element: FormElement

Underlying Blessed element available for standard element operations.

Methods

errors

errors(): FormErrors
Returns current validation errors.

Returns FormErrors
- Defined in adapters/blessed/form.ts:50

focusNext

focusNext(): void
Focuses the next child form element.

Returns void
- Defined in adapters/blessed/form.ts:53

focusPrevious

focusPrevious(): void
Focuses the previous child form element.

Returns void
- Defined in adapters/blessed/form.ts:56

registerField

registerField(field: FormFieldBinding): void
Registers one field binding.
Parameters
- field: FormFieldBinding
Returns void
- Defined in adapters/blessed/form.ts:59

reset

reset(): FormValues
Resets fields and returns current values.

Returns FormValues
- Defined in adapters/blessed/form.ts:62

submit

submit(): FormSubmitResult
Submits the form and returns validation result.

Returns FormSubmitResult
- Defined in adapters/blessed/form.ts:65

unregisterField

unregisterField(id: string): void
Removes one field binding.
Parameters
- id: string
Returns void
- Defined in adapters/blessed/form.ts:68

validate

validate(): FormErrors
Validates current values.

Returns FormErrors
- Defined in adapters/blessed/form.ts:71

values

values(): FormValues
Returns current values.

Returns FormValues
- Defined in adapters/blessed/form.ts:74

destroy

destroy(): void
Destroys and detaches the owned element without destroying its parent.

Returns void
Inherited from BlessedComponentHandle.destroy
- Defined in adapters/blessed/types.ts:23

setData

setData(data: FormData): void
Re-renders component content using complete replacement data.

The element identity is preserved. Call screen.render() explicitly when one or more updates should become visible.
Parameters
- data: FormData
Returns void
Inherited from BlessedComponentHandle.setData
- Defined in adapters/blessed/types.ts:31