Class: Field<T, E, W>
Type parameters#
| Name | Type | Description |
|---|---|---|
T | unknown | Field value type. |
E | unknown | - |
W | unknown | - |
Hierarchy#
StateManager<FieldData<T,E,W>>↳
Field
Constructors#
constructor#
• new Field<T, E, W>(path, form)
Type parameters#
| Name | Type |
|---|---|
T | unknown |
E | unknown |
W | unknown |
Parameters#
| Name | Type |
|---|---|
path | FieldPath |
form | FormState<any, any, any, any> |
Overrides#
StateManager< FieldData<T, E, W\> \>.constructor
Properties#
form#
• Readonly form: FormState<any, any, any, any>
path#
• Readonly path: FieldPath
Methods#
acceptPendingValue#
â–¸ acceptPendingValue(resolve?): void
Parameters#
| Name | Type |
|---|---|
resolve? | (value: T, pendingValue: T) => T |
Returns#
void
blur#
â–¸ blur(): void
Returns#
void
focus#
â–¸ focus(): void
Returns#
void
getError#
â–¸ getError(): undefined | E
The current field error value.
Returns#
undefined | E
getInitialValue#
â–¸ getInitialValue(): T
The initial value set set by an update to the root form value state.
Returns#
T
getPendingValue#
â–¸ getPendingValue(): T
The pending value set set by an update to the root form value state.
Returns#
T
getState#
â–¸ getState(): FieldData<T, E, W>
Returns#
FieldData<T, E, W>
Inherited from#
StateManager.getState
getValue#
â–¸ getValue(): T
The current value of the field.
Returns#
T
getWarning#
â–¸ getWarning(): undefined | W
The current field warning value.
Returns#
undefined | W
isDetached#
â–¸ isDetached(): boolean
True if the current value is different from the pending value.
Returns#
boolean
isDirty#
â–¸ isDirty(): boolean
True if the current value is different from the initial value.
Returns#
boolean
isFocused#
â–¸ isFocused(): boolean
True if the field is currently focused.
Returns#
boolean
isTouched#
â–¸ isTouched(): boolean
True if the field value has been edited.
Returns#
boolean
isVisited#
â–¸ isVisited(): boolean
True if the field is has been or is currently focused.
Returns#
boolean
rejectPendingValue#
â–¸ rejectPendingValue(): void
Returns#
void
setValue#
â–¸ setValue(setValueAction): void
Parameters#
| Name | Type |
|---|---|
setValueAction | SetValueAction<T> |
Returns#
void
subscribe#
â–¸ subscribe(subscriber): Object
Parameters#
| Name | Type |
|---|---|
subscriber | () => void |
Returns#
Object
| Name | Type |
|---|---|
unsubscribe | () => void |
Inherited from#
StateManager.subscribe