GTKX

API Reference / @gtkx/forms / Control

Type Alias: Control<TFieldValues, TContext, TTransformedValues> ​

Control<TFieldValues, TContext, TTransformedValues> = object

Type Parameters ​

TFieldValues ​

TFieldValues extends FieldValues = FieldValues

TContext ​

TContext = any

TTransformedValues ​

TTransformedValues = TFieldValues

Properties ​

_defaultValues ​

_defaultValues: Partial<DefaultValues<TFieldValues>>

_disableForm ​

_disableForm: (disabled?) => void

Parameters ​

disabled? ​

boolean

Returns ​

void

_fields ​

_fields: FieldRefs

_focusError ​

_focusError: () => boolean | undefined

Returns ​

boolean | undefined

_formState ​

_formState: FormState<TFieldValues>

_formValues ​

_formValues: FieldValues

_getDirty ​

_getDirty: GetIsDirty

_getFieldArray ​

_getFieldArray: <TFieldArrayValues>(name) => Partial<TFieldArrayValues>[]

Type Parameters ​

TFieldArrayValues ​

TFieldArrayValues

Parameters ​

name ​

InternalFieldName

Returns ​

Partial<TFieldArrayValues>[]

_getWatch ​

_getWatch: WatchInternal<TFieldValues>

_names ​

_names: Names

_options ​

_options: UseFormProps<TFieldValues, TContext, TTransformedValues>

_proxyFormState ​

_proxyFormState: ReadFormState

_removeUnmounted ​

_removeUnmounted: Noop

_reset ​

_reset: UseFormReset<TFieldValues>

_resetDefaultValues ​

_resetDefaultValues: Noop

_runSchema ​

_runSchema: (names) => Promise<{ errors: FieldErrors; }>

Parameters ​

names ​

InternalFieldName[]

Returns ​

Promise<{ errors: FieldErrors; }>

_setDisabledField ​

_setDisabledField: (props) => void

Parameters ​

props ​
disabled? ​

boolean

name ​

FieldName<any>

Returns ​

void

_setErrors ​

_setErrors: (errors) => void

Parameters ​

errors ​

FieldErrors<TFieldValues>

Returns ​

void

_setFieldArray ​

_setFieldArray: BatchFieldArrayUpdate

_setValid ​

_setValid: (shouldUpdateValid?) => void

Parameters ​

shouldUpdateValid? ​

boolean

Returns ​

void

_state ​

_state: object

action ​

action: boolean

actionArrayLengths ​

actionArrayLengths: Map<InternalFieldName, number>

mount ​

mount: boolean

watch ​

watch: boolean

_subjects ​

_subjects: Subjects<TFieldValues>

_subscribe ​

_subscribe: FromSubscribe<TFieldValues>

_updateIsValidating ​

_updateIsValidating: (names?, isValidating?) => void

Parameters ​

names? ​

InternalFieldName[]

isValidating? ​

boolean

Returns ​

void

getFieldState ​

getFieldState: UseFormGetFieldState<TFieldValues>

handleSubmit ​

handleSubmit: UseFormHandleSubmit<TFieldValues, TTransformedValues>

register ​

register: UseFormRegister<TFieldValues>

setError ​

setError: UseFormSetError<TFieldValues>

unregister ​

unregister: UseFormUnregister<TFieldValues>