Circle V2 API Docs
    Preparing search index...

    Type Alias Control<TFieldValues, TContext, TTransformedValues>

    type Control<
        TFieldValues extends FieldValues = FieldValues,
        TContext = any,
        TTransformedValues = TFieldValues,
    > = {
        _defaultValues: Partial<DefaultValues<TFieldValues>>;
        _disableForm: (disabled?: boolean) => void;
        _fields: FieldRefs;
        _focusError: () => boolean | undefined;
        _formState: FormState<TFieldValues>;
        _formValues: FieldValues;
        _getDirty: GetIsDirty;
        _getFieldArray: <TFieldArrayValues>(
            name: InternalFieldName,
        ) => Partial<TFieldArrayValues>[];
        _getWatch: WatchInternal<TFieldValues>;
        _names: Names;
        _options: UseFormProps<TFieldValues, TContext, TTransformedValues>;
        _proxyFormState: ReadFormState;
        _removeUnmounted: Noop;
        _reset: UseFormReset<TFieldValues>;
        _resetDefaultValues: Noop;
        _runSchema: (
            names: InternalFieldName[],
        ) => Promise<{ errors: FieldErrors }>;
        _setDisabledField: (
            props: { disabled?: boolean; name: FieldName<any> },
        ) => void;
        _setErrors: (errors: FieldErrors<TFieldValues>) => void;
        _setFieldArray: BatchFieldArrayUpdate;
        _setValid: (shouldUpdateValid?: boolean) => void;
        _state: { action: boolean; mount: boolean; watch: boolean };
        _subjects: Subjects<TFieldValues>;
        _subscribe: FromSubscribe<TFieldValues>;
        _updateIsValidating: (
            names?: InternalFieldName[],
            isValidating?: boolean,
        ) => void;
        getFieldState: UseFormGetFieldState<TFieldValues>;
        handleSubmit: UseFormHandleSubmit<TFieldValues, TTransformedValues>;
        register: UseFormRegister<TFieldValues>;
        setError: UseFormSetError<TFieldValues>;
        unregister: UseFormUnregister<TFieldValues>;
    }

    Type Parameters

    Index

    Properties

    _defaultValues: Partial<DefaultValues<TFieldValues>>
    _disableForm: (disabled?: boolean) => void
    _fields: FieldRefs
    _focusError: () => boolean | undefined
    _formState: FormState<TFieldValues>
    _formValues: FieldValues
    _getDirty: GetIsDirty
    _getFieldArray: <TFieldArrayValues>(
        name: InternalFieldName,
    ) => Partial<TFieldArrayValues>[]
    _getWatch: WatchInternal<TFieldValues>
    _names: Names
    _options: UseFormProps<TFieldValues, TContext, TTransformedValues>
    _proxyFormState: ReadFormState
    _removeUnmounted: Noop
    _reset: UseFormReset<TFieldValues>
    _resetDefaultValues: Noop
    _runSchema: (names: InternalFieldName[]) => Promise<{ errors: FieldErrors }>
    _setDisabledField: (props: { disabled?: boolean; name: FieldName<any> }) => void
    _setErrors: (errors: FieldErrors<TFieldValues>) => void
    _setFieldArray: BatchFieldArrayUpdate
    _setValid: (shouldUpdateValid?: boolean) => void
    _state: { action: boolean; mount: boolean; watch: boolean }
    _subjects: Subjects<TFieldValues>
    _subscribe: FromSubscribe<TFieldValues>
    _updateIsValidating: (
        names?: InternalFieldName[],
        isValidating?: boolean,
    ) => void
    getFieldState: UseFormGetFieldState<TFieldValues>
    handleSubmit: UseFormHandleSubmit<TFieldValues, TTransformedValues>
    setError: UseFormSetError<TFieldValues>
    unregister: UseFormUnregister<TFieldValues>