Skip to content

API Reference / @gtkx/forms / Control

Type Alias: Control<TFieldValues, TContext, TTransformedValues>

Control<TFieldValues, TContext, TTransformedValues> = object

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:698

Type Parameters

TFieldValues

TFieldValues extends FieldValues = FieldValues

TContext

TContext = any

TTransformedValues

TTransformedValues = TFieldValues

Properties

_defaultValues

_defaultValues: Partial<DefaultValues<TFieldValues>>

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:717


_disableForm

_disableForm: (disabled?) => void

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:731

Parameters

disabled?

boolean

Returns

void


_fields

_fields: FieldRefs

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:714


_focusError

_focusError: () => boolean | undefined

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:730

Returns

boolean | undefined


_formState

_formState: FormState<TFieldValues>

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:712


_formValues

_formValues: FieldValues

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:715


_getDirty

_getDirty: GetIsDirty

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:710


_getFieldArray

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

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:720

Type Parameters

TFieldArrayValues

TFieldArrayValues

Parameters

name

InternalFieldName

Returns

Partial<TFieldArrayValues>[]


_getWatch

_getWatch: WatchInternal<TFieldValues>

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:718


_names

_names: Names

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:701


_options

_options: UseFormProps<TFieldValues, TContext, TTransformedValues>

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:709


_proxyFormState

_proxyFormState: ReadFormState

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:716


_removeUnmounted

_removeUnmounted: Noop

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:700


_reset

_reset: UseFormReset<TFieldValues>

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:708


_resetDefaultValues

_resetDefaultValues: Noop

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:711


_runSchema

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

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:726

Parameters

names

InternalFieldName[]

Returns

Promise<{ errors: FieldErrors; }>


_setDisabledField

_setDisabledField: (props) => void

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:722

Parameters

props
disabled?

boolean

name

FieldName<any>

Returns

void


_setErrors

_setErrors: (errors) => void

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:721

Parameters

errors

FieldErrors<TFieldValues>

Returns

void


_setFieldArray

_setFieldArray: BatchFieldArrayUpdate

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:719


_setValid

_setValid: (shouldUpdateValid?) => void

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:713

Parameters

shouldUpdateValid?

boolean

Returns

void


_state

_state: object

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:702

action

action: boolean

actionArrayLengths

actionArrayLengths: Map<InternalFieldName, number>

mount

mount: boolean

watch

watch: boolean


_subjects

_subjects: Subjects<TFieldValues>

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:699


_subscribe

_subscribe: FromSubscribe<TFieldValues>

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:732


_updateIsValidating

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

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:729

Parameters

names?

InternalFieldName[]

isValidating?

boolean

Returns

void


getFieldState

getFieldState: UseFormGetFieldState<TFieldValues>

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:736


handleSubmit

handleSubmit: UseFormHandleSubmit<TFieldValues, TTransformedValues>

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:734


register

register: UseFormRegister<TFieldValues>

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:733


setError

setError: UseFormSetError<TFieldValues>

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:737


unregister

unregister: UseFormUnregister<TFieldValues>

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/form.d.ts:735

Released under the MPL-2.0 License.