Interface: CreateFormHookOptions<TFormComponents, TFieldComponents>#

Defined in: packages/react-form/src/AppForm/createFormHookTypes.public.ts:143

Configures the components and reusable defaults returned by createFormHook.

Default objects are shallowly applied before the corresponding usage-site options. A usage-site property always takes precedence, including when its value is explicitly undefined.

Example#

const { useAppForm } = createFormHook({
  formComponents: {},
  fieldComponents: {
    TextField,
  },
  defaultFormOptions: {
    errorVisibility: ({ fieldState }) => fieldState.meta.isBlurred,
  },
  defaultFieldOptions: {
    errorBoundary: true,
  },
})

Extends#

• ReactFormComponentMap<TFormComponents, TFieldComponents>

Type Parameters#

TFormComponents#

TFormComponents extends Record<string, FunctionComponent<any>>

Library-managed. Do not specify explicitly.

TFieldComponents#

TFieldComponents extends Record<string, FunctionComponent<any>>

Library-managed. Do not specify explicitly.

Properties#

defaultFieldOptions?#

optional defaultFieldOptions?: CreateFormHookDefaultFieldOptions;

Defined in: packages/react-form/src/AppForm/createFormHookTypes.public.ts:175

Defaults for direct form.Field and form.ArrayField components.

Options passed to the component override these defaults, including when an option is explicitly undefined. These defaults do not apply to group.Field or group.ArrayField.

Example#

defaultFieldOptions: {
  errorVisibility: ({ fieldState }) => fieldState.meta.isBlurred,
},

defaultFormGroupOptions?#

optional defaultFormGroupOptions?: CreateFormHookDefaultFormGroupOptions;

Defined in: packages/react-form/src/AppForm/createFormHookTypes.public.ts:191

Defaults for every form.FormGroup component.

Options passed to the component override these defaults, including when an option is explicitly undefined.

Example#

defaultFormGroupOptions: {
  onSubmitInvalid: ({ groupApi }) => {
    console.error('Invalid group', groupApi.name)
  },
},

defaultFormOptions?#

optional defaultFormOptions?: CreateFormHookDefaultFormOptions;

Defined in: packages/react-form/src/AppForm/createFormHookTypes.public.ts:160

Defaults for every form created by useAppForm.

Options passed to useAppForm override these defaults, including when an option is explicitly undefined.

Example#

defaultFormOptions: {
  errorVisibility: ({ state }) => state.submissionAttempts > 0,
},

fieldComponents#

fieldComponents: TFieldComponents;

Defined in: packages/react-form/src/AppForm/componentMap.public.ts:8

Inherited from#

ReactFormComponentMap.fieldComponents

formComponents#

formComponents: TFormComponents;

Defined in: packages/react-form/src/AppForm/componentMap.public.ts:7

Inherited from#

ReactFormComponentMap.formComponents