Interface FormInstance

Public controller returned by createForm.

interface FormInstance {
    destroy(): void;
    getValues(): FormValues;
    reset(): void;
    setValues(values: FormValues): void;
    validate(): boolean;
}

Index

Methods

destroy getValues reset setValues validate

Methods

destroy

destroy(): void
Remove event listeners and DOM owned by the form.

Returns void
- Defined in index.ts:81

getValues

getValues(): FormValues
Return a defensive copy of current values.

Returns FormValues
- Defined in index.ts:73

reset

reset(): void
Restore initial values and clear touched, dirty, and error state.

Returns void
- Defined in index.ts:79

setValues

setValues(values: FormValues): void
Merge values into known schema fields and re-render.
Parameters
- values: FormValues
Returns void
- Defined in index.ts:75

validate

validate(): boolean
Validate visible fields and return whether the form is valid.

Returns boolean
- Defined in index.ts:77