API Documentation / Form
Class: Form<T, VFK>
Class to management form state.
Type parameters
| Name | Type | Description |
|---|---|---|
T | extends FormType = FormType | |
VFK | extends string = string | - |
Constructors
constructor
• new Form<T, VFK>(args)
Type parameters
| Name | Type |
|---|---|
T | extends FormType = FormType |
VFK | extends string = string |
Parameters
| Name | Type |
|---|---|
args | Object |
args.defaultValues? | UnpackNestedValue<DeepPartial<T>> |
args.initValues | UnpackNestedValue<T> |
args.readonly? | boolean |
args.touchType? | "FOCUS" | "BLUR" |
Properties
touchType
• touchType: "FOCUS" | "BLUR" = 'BLUR'
Defined in
Accessors
state
• get state(): FormState<T, VFK>
Returns
FormState<T, VFK>
Methods
arrayAppend
▸ arrayAppend<N>(name, v): void
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
v | ArrayItem<KeyPathValue<T, N>> |
Returns
void
arrayInsert
▸ arrayInsert<N>(name, index, v): void
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
index | number |
v | ArrayItem<KeyPathValue<T, N>> |
Returns
void
arrayMove
▸ arrayMove<N>(name, fromIndex, toIndex): void
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
fromIndex | number |
toIndex | number |
Returns
void
arrayPrepend
▸ arrayPrepend<N>(name, v): void
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
v | ArrayItem<KeyPathValue<T, N>> |
Returns
void
arrayRemove
▸ arrayRemove<N>(name, index): void
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
index | number |
Returns
void
arrayReplace
▸ arrayReplace<N>(name, v): void
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
v | KeyPathValue<T, N> |
Returns
void
arraySwap
▸ arraySwap<N>(name, fromIndex, toIndex): void
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
fromIndex | number |
toIndex | number |
Returns
void
arrayUpdate
▸ arrayUpdate<N>(name, index, v): void
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
index | number |
v | ArrayItem<KeyPathValue<T, N>> |
Returns
void
deletePathValue
▸ deletePathValue<N>(name): void
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
Returns
void
deleteValue
▸ deleteValue<N>(name): void
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
Returns
void
fieldError
▸ fieldError<N>(name, reportType?): null | FieldError
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type | Default value |
|---|---|---|
name | N | undefined |
reportType | "all" | "formTouched" | "fieldTouched" | "allTouched" | "anyTouched" | 'anyTouched' |
Returns
null | FieldError
fieldState
▸ fieldState<N>(name): null | FieldState
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
Returns
null | FieldState
getPathValue
▸ getPathValue<N>(name): KeyPathValue<T, N>
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
Returns
KeyPathValue<T, N>
getPathValueRef
▸ getPathValueRef<N>(name): ComputedRef<KeyPathValue<T, N>>
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
Returns
ComputedRef<KeyPathValue<T, N>>
getValue
▸ getValue<N>(name): KeyPathValue<T, N>
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
Returns
KeyPathValue<T, N>
getValueRef
▸ getValueRef<N>(name): ComputedRef<KeyPathValue<T, N>>
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
Returns
ComputedRef<KeyPathValue<T, N>>
isChanged
▸ isChanged<N>(name): boolean
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
Returns
boolean
isDirty
▸ isDirty<N>(name): boolean
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
Returns
boolean
isError
▸ isError<N>(name): boolean
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
Returns
boolean
isTouched
▸ isTouched<N>(name): boolean
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
Returns
boolean
isValidating
▸ isValidating<N>(name): boolean
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
Returns
boolean
isVirtualError
▸ isVirtualError<N>(name): boolean
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
Returns
boolean
isVirtualValidating
▸ isVirtualValidating<N>(name): boolean
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
Returns
boolean
mount
▸ mount(): void
Returns
void
notify
▸ notify(type, name?): void
Parameters
| Name | Type |
|---|---|
type | "UPDATE" | "DELETE" | "RESET" |
name? | string |
Returns
void
registerField
▸ registerField<N, Deps, Transform>(name, args?): Object
Type parameters
| Name | Type |
|---|---|
N | extends string |
Deps | any |
Transform | KeyPathValue<T, N> |
Parameters
| Name | Type |
|---|---|
name | N |
args | Object |
args.debounce? | number |
args.defaultValue? | KeyPathValue<T, N> |
args.deps? | () => Deps |
args.immediate? | boolean |
args.isEqual? | (v: KeyPathValue<T, N>, d: KeyPathValue<T, N>) => boolean |
args.onFocus? | () => void |
args.rules? | FieldRule<Transform, Deps>[] |
args.transform? | (v: KeyPathValue<T, N>) => Transform |
args.value? | KeyPathValue<T, N> |
Returns
Object
| Name | Type |
|---|---|
field | FieldClass<T, N, Deps, Transform, VFK> |
register | () => void |
registerVirtualField
▸ registerVirtualField<N, V>(name, args): Object
Type parameters
| Name | Type |
|---|---|
N | extends string = VFK |
V | any |
Parameters
| Name | Type |
|---|---|
name | N |
args | Object |
args.debounce? | number |
args.immediate? | boolean |
args.rules? | VirtualFieldRule<V>[] |
args.value | () => V |
Returns
Object
| Name | Type |
|---|---|
field | VirtualFieldClass<T, V> |
register | () => void |
reset
▸ reset(args?): void
Parameters
| Name | Type |
|---|---|
args | Object |
args.defaultValues? | UnpackNestedValue<DeepPartial<T>> |
args.keepChanged? | boolean |
args.keepDefaultValues? | boolean |
args.keepIsSubmitted? | boolean |
args.keepSubmitCount? | boolean |
args.keepTouched? | boolean |
args.keepValues? | boolean |
args.values? | UnpackNestedValue<T> |
Returns
void
resetField
▸ resetField<N>(name, args?): void
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
args | Object |
args.defaultValue? | KeyPathValue<T, N> |
args.keepChanged? | boolean |
args.keepTouched? | boolean |
args.keepValue? | boolean |
args.value? | KeyPathValue<T, N> |
Returns
void
runInAction
▸ runInAction(fn): void
Parameters
| Name | Type |
|---|---|
fn | (...args: any[]) => void |
Returns
void
setFocus
▸ setFocus<N>(name): void
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
Returns
void
setPathValue
▸ setPathValue<N>(name, value): void
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
value | KeyPathValue<T, N> |
Returns
void
setTouched
▸ setTouched<N>(name, touched?): void
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type | Default value |
|---|---|---|
name | N | undefined |
touched | boolean | true |
Returns
void
setValue
▸ setValue<N>(name, value): void
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
value | KeyPathValue<T, N> |
Returns
void
submit
▸ submit(args?): void
Parameters
| Name | Type |
|---|---|
args | Object |
args.onError? | (error: FieldError) => void |
args.onSuccess? | (data: UnpackNestedValue<T>) => void |
Returns
void
subscribe
▸ subscribe(subscriber): () => void
Parameters
| Name | Type |
|---|---|
subscriber | (type: "UPDATE" | "DELETE" | "RESET", name?: string) => void |
Returns
fn
▸ (): void
Returns
void
unmount
▸ unmount(): void
Returns
void
unregisterField
▸ unregisterField<N>(name, args?): void
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
args | Object |
args.removeValue? | boolean |
Returns
void
unregisterVirtualField
▸ unregisterVirtualField<N>(name): void
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
Returns
void
virtualFieldError
▸ virtualFieldError<N>(name, reportType?): null | FieldError
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type | Default value |
|---|---|---|
name | N | undefined |
reportType | "all" | "formTouched" | 'formTouched' |
Returns
null | FieldError
virtualFieldState
▸ virtualFieldState<N>(name): null | VirtualFieldState
Type parameters
| Name | Type |
|---|---|
N | extends string |
Parameters
| Name | Type |
|---|---|
name | N |
Returns
null | VirtualFieldState