Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

§Variables

appendErrors
Controller

Component based on useController hook to work with controlled component.

FormProvider

A provider component that propagates the useForm methods to all children components via React Context API. To be used with useFormContext.

get
useFormContext

This custom hook allows you to access the form context. useFormContext is intended to be used in deeply nested structures, where it would become inconvenient to pass the context as a prop. To be used with FormProvider.

§Functions

Form

Form component to manage submission.

set
useController

Custom hook to work with controlled component, this function provide you with both form and field level state. Re-render is isolated at the hook level.

useFieldArray

A custom hook that exposes convenient methods to perform operations with a list of dynamic inputs that need to be appended, updated, removed etc. • DemoVideo

useForm

Custom hook to manage the entire form.

useFormState

This custom hook allows you to subscribe to each form state, and isolate the re-render at the custom hook level. It has its scope in terms of form state subscription, so it would not affect other useFormState and useForm. Using this hook can reduce the re-render impact on large and complex form application.

useWatch

Subscribe to the entire form values change and re-render at the hook level.

§Interfaces

ResolverOptions

§Type Aliases

ArrayPath

Type which eagerly collects all paths through a type which point to an array type.

BatchFieldArrayUpdate
BrowserNativeObject
ChangeHandler
Control
ControllerFieldState
ControllerProps

Render function to provide the control for the field.

ControllerRenderProps
CriteriaMode
CustomElement
DeepMap
DeepPartial
DeepPartialSkipArrayKey
DeepRequired
DefaultValues
DelayCallback
EmptyObject
ErrorOption
EventType
Field
FieldArray
FieldArrayMethodProps

useFieldArray focus option, ability to toggle focus on and off with shouldFocus and setting focus by either field index or name.

FieldArrayPath

See ArrayPath

FieldArrayPathValue

See PathValue

FieldArrayWithId

useFieldArray returned fields with unique id

FieldElement
FieldError
FieldErrors
FieldErrorsImpl
FieldName
FieldNamesMarkedBoolean
FieldPath

See Path

FieldPathByValue

Type which eagerly collects all paths through a fieldType that matches a give type

FieldPathValue

See PathValue

FieldPathValues

Type to evaluate the type which the given paths point to.

FieldRefs
FieldValue
FieldValues
FormProps
FormProviderProps
FormState
FormStateProxy
FormStateSubjectRef
FormSubmitHandler
GetIsDirty
GlobalError
InputValidationRules
InternalFieldErrors
InternalFieldName
InternalNameSet
IsAny

Checks whether the type is any See https://stackoverflow.com/a/49928360/3406963

IsEqual

Checks whether T1 can be exactly (mutually) assigned to T2

IsFlatObject
IsNever

Checks whether the type is never

KeepStateOptions
LiteralUnion
MaxType
Merge
Message
MinType
Mode
MultipleFieldErrors
Names
NativeFieldValue
NestedValue deprecated
NonUndefined
Noop
Path

Type which eagerly collects all paths through a type

PathString

Type alias to string which describes a lodash-like path through an object. E.g. 'foo.bar.0.baz'

PathValue

Type to evaluate the type which the given path points to.

Primitive
ReadFormState
Ref
RefCallBack
RegisterOptions
Resolver
ResolverError
ResolverResult
ResolverSuccess
SetFieldValue
SetFocusOptions
SetValueConfig
Subjects
SubmitErrorHandler
SubmitHandler
TriggerConfig
UnpackNestedValue deprecated
UseControllerProps
UseControllerReturn
UseFieldArrayAppend

Append field/fields to the end of your fields and focus. The input value will be registered during this action.

UseFieldArrayInsert

Insert field/fields at particular position and focus.

UseFieldArrayMove

Move field array by supplying from and to index

UseFieldArrayPrepend

Prepend field/fields to the start of the fields and optionally focus. The input value will be registered during this action.

UseFieldArrayProps
UseFieldArrayRemove

Remove field/fields at particular position.

UseFieldArrayReplace

Replace the entire field array values.

UseFieldArrayReturn
UseFieldArraySwap

Swap field array by supplying from and to index

UseFieldArrayUpdate

Update field/fields at particular position.

UseFormClearErrors

Clear the entire form errors.

UseFormGetFieldState

This method will return individual field states. It will be useful when you are trying to retrieve the nested value field state in a typesafe approach.

UseFormGetValues
UseFormHandleSubmit

Validate the entire form. Handle submit and error callback.

UseFormProps
UseFormRegister

Register field into hook form with or without the actual DOM ref. You can invoke register anywhere in the component including at useEffect.

UseFormRegisterReturn
UseFormReset

Reset at the entire form state.

UseFormResetField

Reset a field state and reference.

UseFormReturn
UseFormSetError

Set an error for the field. When set an error which is not associated to a field then manual clearErrors invoke is required.

UseFormSetFocus

Set focus on a registered field. You can start to invoke this method after all fields are mounted to the DOM.

UseFormSetValue

Set a single field value, or a group of fields value.

UseFormStateProps
UseFormStateReturn
UseFormTrigger

Trigger field or form validation

UseFormUnregister

Unregister a field reference and remove its value.

UseFormWatch
UseWatchProps
Validate
ValidateResult
ValidationMode
ValidationRule
ValidationValue
ValidationValueMessage
WatchInternal
WatchObserver