Documents / Namespace: Form

Namespace: Form

Table of contents

Namespaces

• ErrorList
• Item
• List
• Provider

Functions

• ErrorList
• Item
• List
• Provider
• useForm
• useFormInstance
• useWatch

Functions

ErrorList

▸ ErrorList(props, context?): ReactNode

Parameters

Name	Type
props	ErrorListProps
context?	any

Returns

ReactNode

---

Item

▸ Item<T>(props): Element

FormItem, can be used without Form.

// use inline type
<FormItem type='string' id='name' />

// use custom type
<FormItem id='password'>
  <Input.Password />
</>

Type parameters

Name	Type
T	any

Parameters

Name	Type
props	FormItemProps<T>

Returns

Element

---

List

▸ List(props, context?): ReactNode

Parameters

Name	Type
props	FormListProps
context?	any

Returns

ReactNode

---

Provider

▸ Provider(props, context?): ReactNode

Parameters

Name	Type
props	FormProviderProps
context?	any

Returns

ReactNode

---

useForm

▸ useForm<Values>(form?): [FormInstance<Values>]

Type parameters

Name	Type
Values	any

Parameters

Name	Type
form?	FormInstance<Values>

Returns

[FormInstance<Values>]

---

useFormInstance

▸ useFormInstance<Value>(): FormInstance<Value>

Type parameters

Name	Type
Value	any

Returns

FormInstance<Value>

---

useWatch

▸ useWatch<TDependencies1, TForm, TDependencies2, TDependencies3, TDependencies4>(dependencies, form?): GetGeneric<TForm>[TDependencies1][TDependencies2][TDependencies3][TDependencies4]

Type parameters

Name	Type
TDependencies1	extends string | number | symbol
TForm	extends FormInstance<any>
TDependencies2	extends string | number | symbol
TDependencies3	extends string | number | symbol
TDependencies4	extends string | number | symbol

Parameters

Name	Type
dependencies	[TDependencies1, TDependencies2, TDependencies3, TDependencies4]
form?	TForm | WatchOptions<TForm>

Returns

GetGeneric<TForm>[TDependencies1][TDependencies2][TDependencies3][TDependencies4]

▸ useWatch<TDependencies1, TForm, TDependencies2, TDependencies3>(dependencies, form?): GetGeneric<TForm>[TDependencies1][TDependencies2][TDependencies3]

Type parameters

Name	Type
TDependencies1	extends string | number | symbol
TForm	extends FormInstance<any>
TDependencies2	extends string | number | symbol
TDependencies3	extends string | number | symbol

Parameters

Name	Type
dependencies	[TDependencies1, TDependencies2, TDependencies3]
form?	TForm | WatchOptions<TForm>

Returns

GetGeneric<TForm>[TDependencies1][TDependencies2][TDependencies3]

▸ useWatch<TDependencies1, TForm, TDependencies2>(dependencies, form?): GetGeneric<TForm>[TDependencies1][TDependencies2]

Type parameters

Name	Type
TDependencies1	extends string | number | symbol
TForm	extends FormInstance<any>
TDependencies2	extends string | number | symbol

Parameters

Name	Type
dependencies	[TDependencies1, TDependencies2]
form?	TForm | WatchOptions<TForm>

Returns

GetGeneric<TForm>[TDependencies1][TDependencies2]

▸ useWatch<TDependencies, TForm>(dependencies, form?): GetGeneric<TForm>[TDependencies]

Type parameters

Name	Type
TDependencies	extends string | number | symbol
TForm	extends FormInstance<any>

Parameters

Name	Type
dependencies	TDependencies | [TDependencies]
form?	TForm | WatchOptions<TForm>

Returns

GetGeneric<TForm>[TDependencies]

▸ useWatch<TForm>(dependencies, form?): GetGeneric<TForm>

Type parameters

Name	Type
TForm	extends FormInstance<any>

Parameters

Name	Type
dependencies	[]
form?	TForm | WatchOptions<TForm>

Returns

GetGeneric<TForm>

▸ useWatch<TForm, TSelected>(selector, form?): TSelected

Type parameters

Name	Type
TForm	extends FormInstance<any>
TSelected	unknown

Parameters

Name	Type
selector	(values: ReturnPromise<ReturnType<TForm["validateFields"]>>) => TSelected
form?	TForm | WatchOptions<TForm>

Returns

TSelected

▸ useWatch<ValueType, TSelected>(selector, form?): TSelected

Type parameters

Name	Type
ValueType	Store
TSelected	unknown

Parameters

Name	Type
selector	(values: ValueType) => TSelected
form?	FormInstance<any> | WatchOptions<FormInstance<any>>

Returns

TSelected

▸ useWatch<TForm>(dependencies, form?): any

Type parameters

Name	Type
TForm	extends FormInstance<any>

Parameters

Name	Type
dependencies	any
form?	TForm | WatchOptions<TForm>

Returns

any

▸ useWatch<ValueType>(dependencies, form?): ValueType

Type parameters

Name	Type
ValueType	Store

Parameters

Name	Type
dependencies	any
form?	FormInstance<any> | WatchOptions<FormInstance<any>>

Returns

ValueType