ReferencePackages@mwillbanks/tuil-formAPI

useRegisterTerminalField

function exported by @mwillbanks/tuil-form.

function

Public function exported by @mwillbanks/tuil-form.

export function useRegisterTerminalField<T>(
  field: TerminalFieldBinding<T>,
  enabled = true,
  externalField?: AdaptedTanStackField<T>,
): void;

Parameters

Member	Type	Required	Description	Related types
`field`	`TerminalFieldBinding<T>`	Yes	Supplies the `field` value as `TerminalFieldBinding<T>`.	`TerminalFieldBinding`
`enabled`	`unknown`	No	Supplies the `enabled` value as `unknown`.	—
`externalField`	`AdaptedTanStackField<T>`	No	Supplies the `externalField` value as `AdaptedTanStackField<T>`.	`AdaptedTanStackField`

Returns

void — Returns a value that satisfies void.

Related types: —

Throws

No thrown errors are documented for this declaration.

A custom React Hook that returns an extended instance of the `FormApi` class. This API encapsulates all the necessary functionalities related to the form. It allows you to manage form state, handle submissions, and interact with form fields

useStore

export exported by @mwillbanks/tuil-form.

useRegisterTerminalField

function

Members

Parameters

Returns

Throws

Source

Package

On this page