Interface FormStateModel

Controlled or uncontrolled form registry and validation model.

interface FormStateModel {
    errors(): FormErrors;
    fieldValue(id: string): unknown;
    registerField(field: FormFieldDefinition): void;
    reset(): FormValues;
    setOptions(options: CreateFormStateOptions): void;
    setValue(id: string, value: unknown): boolean;
    submit(): FormSubmitResult;
    unregisterField(id: string): void;
    validate(): FormErrors;
    values(): FormValues;
}

Index

Methods

errors fieldValue registerField reset setOptions setValue submit unregisterField validate values

Methods

errors

errors(): FormErrors
Returns current validation errors.

Returns FormErrors
- Defined in components/input/form/index.ts:63

fieldValue

fieldValue(id: string): unknown
Returns one field value.
Parameters
- id: string
Returns unknown
- Defined in components/input/form/index.ts:66

registerField

registerField(field: FormFieldDefinition): void
Registers one field.
Parameters
- field: FormFieldDefinition
Returns void
- Defined in components/input/form/index.ts:69

reset

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

Returns FormValues
- Defined in components/input/form/index.ts:72

setOptions

setOptions(options: CreateFormStateOptions): void
Replaces callbacks and field definitions.
Parameters
- options: CreateFormStateOptions
Returns void
- Defined in components/input/form/index.ts:75

setValue

setValue(id: string, value: unknown): boolean
Sets a field value and reports whether the field exists.
Parameters
- id: string
- value: unknown
Returns boolean
- Defined in components/input/form/index.ts:78

submit

submit(): FormSubmitResult
Validates and submits current values.

Returns FormSubmitResult
- Defined in components/input/form/index.ts:81

unregisterField

unregisterField(id: string): void
Removes one field.
Parameters
- id: string
Returns void
- Defined in components/input/form/index.ts:84

validate

validate(): FormErrors
Validates current values and returns errors.

Returns FormErrors
- Defined in components/input/form/index.ts:87

values

values(): FormValues
Returns current values.

Returns FormValues
- Defined in components/input/form/index.ts:90