rsuite 5.59.1 → 5.59.3-alpha.1

package/esm/Form/Form.d.ts

@@ -1,36 +1,64 @@
 import React from 'react';
 import { Schema } from 'schema-typed';
-import type { CheckResult } from 'schema-typed';
 import FormControl from '../FormControl';
 import FormControlLabel from '../FormControlLabel';
 import FormErrorMessage from '../FormErrorMessage';
 import FormGroup from '../FormGroup';
 import FormHelpText from '../FormHelpText';
 import { WithAsProps, TypeAttributes, RsRefForwardingComponent } from '../@types/common';
+import { FormInstance } from './hooks/useFormRef';
 export interface FormProps<T = Record<string, any>, errorMsgType = any, E = {
     [P in keyof T]?: errorMsgType;
 }> extends WithAsProps, Omit<React.FormHTMLAttributes<HTMLFormElement>, 'onChange' | 'onSubmit' | 'onError'> {
-    /** Set the left and right columns of the layout of the elements within the form */
+    /**
+     * Set the left and right columns of the layout of the elements within the form。
+     *
+     * @default 'vertical'
+     */
     layout?: 'horizontal' | 'vertical' | 'inline';
-    /** The fluid property allows the Input 100% of the form to fill the container, valid only in vertical layouts. */
+    /**
+     * The fluid property allows the Input 100% of the form to fill the container, valid only in vertical layouts.
+     */
     fluid?: boolean;
-    /** Current value of the input. Creates a controlled component */
-    formValue?: T;
-    /** Initial value */
-    formDefaultValue?: T;
-    /** Error message of form */
-    formError?: E;
-    /** Trigger the type of form validation */
+    /**
+     * Current value of the input. Creates a controlled component
+     */
+    formValue?: T | null;
+    /**
+     * Initial value
+     */
+    formDefaultValue?: T | null;
+    /**
+     * Error message of form
+     */
+    formError?: E | null;
+    /**
+     * Trigger the type of form validation.
+     *
+     * @default 'change'
+     */
     checkTrigger?: TypeAttributes.CheckTrigger;
-    /** SchemaModel object */
+    /**
+     * SchemaModel object
+     *
+     * @see https://github.com/rsuite/schema-typed
+     */
     model?: Schema;
-    /** Make the form readonly */
+    /**
+     * Make the form readonly
+     */
     readOnly?: boolean;
-    /** Render the form as plain text */
+    /**
+     * Render the form as plain text
+     */
     plaintext?: boolean;
-    /** Disable the form. */
+    /**
+     * Disable the form
+     */
     disabled?: boolean;
-    /** The error message comes from context */
+    /**
+     * The error message comes from context
+     */
     errorFromContext?: boolean;
     /**
      * The form data is nested.
@@ -46,33 +74,22 @@ export interface FormProps<T = Record<string, any>, errorMsgType = any, E = {
      * ```
      */
     nestedField?: boolean;
-    /** Callback fired when data changing */
+    /**
+     * Callback fired when data changing
+     */
     onChange?: (formValue: T, event?: React.SyntheticEvent) => void;
-    /** Callback fired when error checking */
+    /**
+     * Callback fired when error checking
+     */
     onError?: (formError: E) => void;
-    /** Callback fired when data cheking */
+    /**
+     * Callback fired when data cheking
+     */
     onCheck?: (formError: E) => void;
-    /** Callback fired when form submit */
-    onSubmit?: (checkStatus: boolean, event: React.FormEvent<HTMLFormElement>) => void;
-}
-export interface FormInstance<T = Record<string, any>, errorMsg = string, E = {
-    [P in keyof T]?: errorMsg;
-}> {
-    root: HTMLFormElement | null;
-    /** Verify form data */
-    check: (callback?: (formError: E) => void) => boolean;
-    /** Asynchronously check form data */
-    checkAsync: () => Promise<any>;
-    /** Check the data field */
-    checkForField: (fieldName: keyof T, callback?: (checkResult: CheckResult<errorMsg>) => void) => boolean;
-    /** Asynchronous verification as a data field */
-    checkForFieldAsync: (fieldName: keyof T) => Promise<CheckResult>;
-    /** Clear all error messages */
-    cleanErrors: (callback?: () => void) => void;
-    /** Clear the error message of the specified field */
-    cleanErrorForField: (fieldName: keyof E, callback?: () => void) => void;
-    /** All error messages are reset, and an initial value can be set */
-    resetErrors: (formError: E, callback?: () => void) => void;
+    /**
+     * Callback fired when form submit
+     */
+    onSubmit?: (checkPassed: boolean, event: React.FormEvent<HTMLFormElement>) => void;
 }
 export interface FormComponent extends RsRefForwardingComponent<'form', FormProps & {
     ref?: React.Ref<FormInstance>;

package/esm/Form/Form.js

@@ -1,12 +1,10 @@
 'use client';
 import _extends from "@babel/runtime/helpers/esm/extends";
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
-import React, { useMemo, useImperativeHandle, useRef } from 'react';
+import React from 'react';
 import PropTypes from 'prop-types';
-import omit from 'lodash/omit';
-import set from 'lodash/set';
 import { SchemaModel } from 'schema-typed';
-import FormContext, { FormValueContext } from './FormContext';
+import { FormValueProvider, FormProvider } from './FormContext';
 import FormControl from '../FormControl';
 import FormControlLabel from '../FormControlLabel';
 import FormErrorMessage from '../FormErrorMessage';
@@ -15,9 +13,11 @@ import FormHelpText from '../FormHelpText';
 import { useEventCallback } from '../utils';
 import { oneOf } from '../internals/propTypes';
 import useSchemaModel from './hooks/useSchemaModel';
-import useFormError from './hooks/useFormError';
+import useFormValidate from './hooks/useFormValidate';
 import useFormValue from './hooks/useFormValue';
 import useFormClassNames from './hooks/useFormClassNames';
+var defaultSchema = SchemaModel({});
+
 /**
  * The `Form` component is a form interface for collecting and validating user input.
  * @see https://rsuitejs.com/components/form
@@ -31,15 +31,15 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
     errorFromContext = _props$errorFromConte === void 0 ? true : _props$errorFromConte,
     _props$formDefaultVal = props.formDefaultValue,
     formDefaultValue = _props$formDefaultVal === void 0 ? {} : _props$formDefaultVal,
-    formValueProp = props.formValue,
-    formErrorProp = props.formError,
+    controlledFormValue = props.formValue,
+    controlledFormError = props.formError,
     fluid = props.fluid,
     _props$nestedField = props.nestedField,
     nestedField = _props$nestedField === void 0 ? false : _props$nestedField,
     _props$layout = props.layout,
     layout = _props$layout === void 0 ? 'vertical' : _props$layout,
     _props$model = props.model,
-    formModel = _props$model === void 0 ? SchemaModel({}) : _props$model,
+    formModel = _props$model === void 0 ? defaultSchema : _props$model,
     readOnly = props.readOnly,
     plaintext = props.plaintext,
     className = props.className,
@@ -54,6 +54,27 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
     getCombinedModel = _useSchemaModel.getCombinedModel,
     pushFieldRule = _useSchemaModel.pushFieldRule,
     removeFieldRule = _useSchemaModel.removeFieldRule;
+  var _useFormValue = useFormValue(controlledFormValue, {
+      formDefaultValue: formDefaultValue,
+      nestedField: nestedField
+    }),
+    formValue = _useFormValue.formValue,
+    onRemoveValue = _useFormValue.onRemoveValue,
+    setFieldValue = _useFormValue.setFieldValue;
+  var formValidateProps = {
+    ref: ref,
+    formValue: formValue,
+    getCombinedModel: getCombinedModel,
+    onCheck: onCheck,
+    onError: onError,
+    nestedField: nestedField
+  };
+  var _useFormValidate = useFormValidate(controlledFormError, formValidateProps),
+    formError = _useFormValidate.formError,
+    setFieldError = _useFormValidate.setFieldError,
+    onRemoveError = _useFormValidate.onRemoveError,
+    check = _useFormValidate.check,
+    formRef = _useFormValidate.formRef;
   var classes = useFormClassNames({
     classPrefix: classPrefix,
     className: className,
@@ -63,199 +84,57 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
     plaintext: plaintext,
     disabled: disabled
   });
-  var _useFormValue = useFormValue(formValueProp, formDefaultValue),
-    formValue = _useFormValue.formValue,
-    setFormValue = _useFormValue.setFormValue,
-    onRemoveValue = _useFormValue.onRemoveValue;
-  var _useFormError = useFormError(formErrorProp),
-    formError = _useFormError.formError,
-    setFormError = _useFormError.setFormError,
-    onRemoveError = _useFormError.onRemoveError;
-  /**
-   * Validate the form data and return a boolean.
-   * The error message after verification is returned in the callback.
-   * @param callback
-   */
-  var check = useEventCallback(function (callback) {
-    var formError = {};
-    var errorCount = 0;
-    var model = getCombinedModel();
-    Object.keys(model.getSchemaSpec()).forEach(function (key) {
-      var checkResult = model.checkForField(key, formValue || {});
-      if (checkResult.hasError === true) {
-        errorCount += 1;
-        formError[key] = (checkResult === null || checkResult === void 0 ? void 0 : checkResult.errorMessage) || checkResult;
-      }
-    });
-    setFormError(formError);
-    onCheck === null || onCheck === void 0 ? void 0 : onCheck(formError);
-    callback === null || callback === void 0 ? void 0 : callback(formError);
-    if (errorCount > 0) {
-      onError === null || onError === void 0 ? void 0 : onError(formError);
-      return false;
-    }
-    return true;
-  });
-
-  /**
-   * Check the data field
-   * @param fieldName
-   * @param callback
-   */
-  var checkForField = useEventCallback(function (fieldName, callback) {
-    var _extends2;
-    var model = getCombinedModel();
-    var checkResult = model.checkForField(fieldName, formValue || {});
-    var nextFormError = _extends({}, formError, (_extends2 = {}, _extends2[fieldName] = (checkResult === null || checkResult === void 0 ? void 0 : checkResult.errorMessage) || checkResult, _extends2));
-    setFormError(nextFormError);
-    onCheck === null || onCheck === void 0 ? void 0 : onCheck(nextFormError);
-    callback === null || callback === void 0 ? void 0 : callback(checkResult);
-    if (checkResult.hasError) {
-      onError === null || onError === void 0 ? void 0 : onError(nextFormError);
-    }
-    return !checkResult.hasError;
-  });
-
-  /**
-   * Check form data asynchronously and return a Promise
-   */
-  var checkAsync = useEventCallback(function () {
-    var promises = [];
-    var keys = [];
-    var model = getCombinedModel();
-    Object.keys(model.getSchemaSpec()).forEach(function (key) {
-      keys.push(key);
-      promises.push(model.checkForFieldAsync(key, formValue || {}));
-    });
-    return Promise.all(promises).then(function (values) {
-      var formError = {};
-      var errorCount = 0;
-      for (var i = 0; i < values.length; i++) {
-        if (values[i].hasError) {
-          errorCount += 1;
-          formError[keys[i]] = values[i].errorMessage;
-        }
-      }
-      onCheck === null || onCheck === void 0 ? void 0 : onCheck(formError);
-      setFormError(formError);
-      if (errorCount > 0) {
-        onError === null || onError === void 0 ? void 0 : onError(formError);
-      }
-      return {
-        hasError: errorCount > 0,
-        formError: formError
-      };
-    });
-  });
-
-  /**
-   * Asynchronously check form fields and return Promise
-   * @param fieldName
-   */
-  var checkForFieldAsync = useEventCallback(function (fieldName) {
-    var model = getCombinedModel();
-    return model.checkForFieldAsync(fieldName, formValue || {}).then(function (checkResult) {
-      var _extends3;
-      var nextFormError = _extends({}, formError, (_extends3 = {}, _extends3[fieldName] = checkResult.errorMessage, _extends3));
-      onCheck === null || onCheck === void 0 ? void 0 : onCheck(nextFormError);
-      setFormError(nextFormError);
-      if (checkResult.hasError) {
-        onError === null || onError === void 0 ? void 0 : onError(nextFormError);
-      }
-      return checkResult;
-    });
-  });
-  var cleanErrors = useEventCallback(function () {
-    setFormError({});
-  });
-  var cleanErrorForField = useEventCallback(function (fieldName) {
-    setFormError(omit(formError, [fieldName]));
-  });
-  var resetErrors = useEventCallback(function (formError) {
-    if (formError === void 0) {
-      formError = {};
-    }
-    setFormError(formError);
-  });
-  useImperativeHandle(ref, function () {
-    return {
-      root: rootRef.current,
-      check: check,
-      checkForField: checkForField,
-      checkAsync: checkAsync,
-      checkForFieldAsync: checkForFieldAsync,
-      cleanErrors: cleanErrors,
-      cleanErrorForField: cleanErrorForField,
-      resetErrors: resetErrors
-    };
-  });
-  var removeFieldError = useEventCallback(function (name) {
-    var formError = onRemoveError(name);
-    setFormError(formError);
-    onCheck === null || onCheck === void 0 ? void 0 : onCheck(formError);
-  });
   var removeFieldValue = useEventCallback(function (name) {
     var formValue = onRemoveValue(name);
     onChange === null || onChange === void 0 ? void 0 : onChange(formValue);
   });
+  var removeFieldError = useEventCallback(function (name) {
+    onRemoveError(name);
+  });
   var handleSubmit = useEventCallback(function (event) {
+    var _event$preventDefault, _event$stopPropagatio;
+    event === null || event === void 0 ? void 0 : (_event$preventDefault = event.preventDefault) === null || _event$preventDefault === void 0 ? void 0 : _event$preventDefault.call(event);
+    event === null || event === void 0 ? void 0 : (_event$stopPropagatio = event.stopPropagation) === null || _event$stopPropagatio === void 0 ? void 0 : _event$stopPropagatio.call(event);
     if (disabled || readOnly || plaintext) {
       return;
     }
-    event.preventDefault();
-    event.stopPropagation();
-    var checkStatus = check();
-    onSubmit === null || onSubmit === void 0 ? void 0 : onSubmit(checkStatus, event);
+    var checkResult = check();
+    onSubmit === null || onSubmit === void 0 ? void 0 : onSubmit(checkResult, event);
   });
-  var handleFieldError = useEventCallback(function (name, errorMessage) {
-    var _extends4;
-    var nextFormError = _extends({}, formError, (_extends4 = {}, _extends4[name] = errorMessage, _extends4));
-    setFormError(nextFormError);
-    onError === null || onError === void 0 ? void 0 : onError(nextFormError);
-    onCheck === null || onCheck === void 0 ? void 0 : onCheck(nextFormError);
+  var onFieldError = useEventCallback(function (name, checkResult) {
+    setFieldError(name, checkResult);
   });
-  var handleFieldSuccess = useEventCallback(function (name) {
+  var onFieldSuccess = useEventCallback(function (name) {
     removeFieldError(name);
   });
-  var setFieldValue = function setFieldValue(formValue, fieldName, fieldValue) {
-    var _extends5;
-    if (nestedField) {
-      return set(_extends({}, formValue), fieldName, fieldValue);
-    }
-    return _extends({}, formValue, (_extends5 = {}, _extends5[fieldName] = fieldValue, _extends5));
-  };
-  var handleFieldChange = useEventCallback(function (name, value, event) {
-    var nextFormValue = setFieldValue(formValue, name, value);
-    setFormValue(nextFormValue);
+  var onFieldChange = useEventCallback(function (name, value, event) {
+    var nextFormValue = setFieldValue(name, value);
     onChange === null || onChange === void 0 ? void 0 : onChange(nextFormValue, event);
   });
-  var rootRef = useRef(null);
-  var formContextValue = useMemo(function () {
-    return {
-      getCombinedModel: getCombinedModel,
-      checkTrigger: checkTrigger,
-      errorFromContext: errorFromContext,
-      readOnly: readOnly,
-      plaintext: plaintext,
-      disabled: disabled,
-      formError: formError,
-      nestedField: nestedField,
-      removeFieldValue: removeFieldValue,
-      removeFieldError: removeFieldError,
-      pushFieldRule: pushFieldRule,
-      removeFieldRule: removeFieldRule,
-      onFieldChange: handleFieldChange,
-      onFieldError: handleFieldError,
-      onFieldSuccess: handleFieldSuccess
-    };
-  }, [getCombinedModel, checkTrigger, errorFromContext, readOnly, plaintext, disabled, formError, nestedField, removeFieldValue, removeFieldError, pushFieldRule, removeFieldRule, handleFieldChange, handleFieldError, handleFieldSuccess]);
+  var formContextValue = {
+    errorFromContext: errorFromContext,
+    checkTrigger: checkTrigger,
+    plaintext: plaintext,
+    readOnly: readOnly,
+    disabled: disabled,
+    formError: formError,
+    nestedField: nestedField,
+    pushFieldRule: pushFieldRule,
+    getCombinedModel: getCombinedModel,
+    removeFieldValue: removeFieldValue,
+    removeFieldError: removeFieldError,
+    removeFieldRule: removeFieldRule,
+    onFieldSuccess: onFieldSuccess,
+    onFieldChange: onFieldChange,
+    onFieldError: onFieldError
+  };
   return /*#__PURE__*/React.createElement("form", _extends({}, rest, {
-    ref: rootRef,
+    ref: formRef,
     onSubmit: handleSubmit,
     className: classes
-  }), /*#__PURE__*/React.createElement(FormContext.Provider, {
+  }), /*#__PURE__*/React.createElement(FormProvider, {
     value: formContextValue
-  }, /*#__PURE__*/React.createElement(FormValueContext.Provider, {
+  }, /*#__PURE__*/React.createElement(FormValueProvider, {
     value: formValue
   }, children)));
 });

package/esm/Form/FormContext.d.ts

@@ -1,19 +1,20 @@
 import React from 'react';
 import { TypeAttributes } from '../@types/common';
-import type { Schema } from 'schema-typed';
+import type { Schema, CheckResult } from 'schema-typed';
 import type { FieldRuleType } from './hooks/useSchemaModel';
-interface TrulyFormContextValue<T = Record<string, any>, errorMsgType = any, E = {
+declare type RecordAny = Record<string, any>;
+interface TrulyFormContextValue<T = RecordAny, errorMsgType = any, E = {
     [P in keyof T]?: errorMsgType;
 }> {
-    getCombinedModel: () => Schema;
     formError: E;
     nestedField: boolean;
+    getCombinedModel: () => Schema;
     removeFieldValue: (name: string) => void;
     removeFieldError: (name: string) => void;
-    pushFieldRule: (name: string, fieldRule: FieldRuleType) => void;
     removeFieldRule: (name: string) => void;
+    pushFieldRule: (name: string, fieldRule: FieldRuleType) => void;
+    onFieldError: (name: string, fieldError: string | CheckResult) => void;
     onFieldChange: (name: string, value: any, event: React.SyntheticEvent) => void;
-    onFieldError: (name: string, errorMessage: string) => void;
     onFieldSuccess: (name: string) => void;
 }
 declare type ExternalPropsContextValue = {
@@ -24,8 +25,10 @@ declare type ExternalPropsContextValue = {
     disabled?: boolean;
 };
 declare type InitialContextType = Partial<Record<keyof TrulyFormContextValue, undefined>>;
-export declare type FormContextValue<T = Record<string, any>, errorMsgType = any> = (TrulyFormContextValue<T, errorMsgType> | InitialContextType) & ExternalPropsContextValue;
-export declare const FormContext: React.Context<FormContextValue<Record<string, any>, any>>;
-export declare const FormValueContext: React.Context<Record<string, any> | undefined>;
-export declare const FormPlaintextContext: React.Context<boolean>;
+export declare type FormContextValue<T = RecordAny, errorMsgType = any> = (TrulyFormContextValue<T, errorMsgType> | InitialContextType) & ExternalPropsContextValue;
+export declare const FormContext: React.Context<FormContextValue<RecordAny, any>>;
+export declare const FormValueContext: React.Context<RecordAny | undefined>;
+export declare const FormProvider: React.Provider<FormContextValue<RecordAny, any>>;
+export declare const FormValueProvider: React.Provider<RecordAny | undefined>;
+export declare function useFormContext<T = RecordAny, E = any>(): FormContextValue<T, E>;
 export default FormContext;

package/esm/Form/FormContext.js

@@ -1,6 +1,10 @@
 'use client';
-import React from 'react';
+import React, { useContext } from 'react';
 export var FormContext = /*#__PURE__*/React.createContext({});
 export var FormValueContext = /*#__PURE__*/React.createContext({});
-export var FormPlaintextContext = /*#__PURE__*/React.createContext(false);
+export var FormProvider = FormContext.Provider;
+export var FormValueProvider = FormValueContext.Provider;
+export function useFormContext() {
+  return useContext(FormContext);
+}
 export default FormContext;

package/esm/Form/hooks/useFormRef.d.ts

@@ -0,0 +1,55 @@
+/// <reference types="react" />
+import type { CheckResult } from 'schema-typed';
+export interface FormImperativeMethods<T = Record<string, any>, M = string, E = {
+    [P in keyof T]?: M;
+}> {
+    /**
+     * Verify form data
+     */
+    check: (callback?: (formError: E) => void) => boolean;
+    /**
+     * Asynchronously check form data
+     */
+    checkAsync: () => Promise<any>;
+    /**
+     * Check the data field
+     */
+    checkForField: (fieldName: keyof T, callback?: (checkResult: CheckResult<M>) => void) => boolean;
+    /**
+     * Asynchronous verification as a data field
+     */
+    checkForFieldAsync: (fieldName: keyof T) => Promise<CheckResult>;
+    /**
+     * Clear all error messages
+     */
+    cleanErrors: (callback?: () => void) => void;
+    /**
+     * Clear the error message of the specified field
+     */
+    cleanErrorForField: (fieldName: keyof E, callback?: () => void) => void;
+    /**
+     * All error messages are reset, and an initial value can be set
+     */
+    resetErrors: (formError?: E) => void;
+}
+export interface FormInstance<T = Record<string, any>, M = string, E = {
+    [P in keyof T]?: M;
+}> extends FormImperativeMethods<T, M, E> {
+    /**
+     * Form root element
+     */
+    root: HTMLFormElement | null;
+}
+interface FormRefProps<T = Record<string, any>, M = string, E = {
+    [P in keyof T]?: M;
+}> {
+    formError: E;
+    nestedField?: boolean;
+    setFormError: (formError: E) => void;
+    check: (callback?: (formError: E) => void) => boolean;
+    checkForField: (fieldName: keyof T, callback?: (checkResult: CheckResult<M>) => void) => boolean;
+    checkAsync: () => Promise<any>;
+    checkForFieldAsync: (fieldName: keyof T) => Promise<CheckResult>;
+}
+export default function useFormRef(ref: React.Ref<FormInstance>, props: FormRefProps): import("react").RefObject<HTMLFormElement>;
+export {};

package/esm/Form/hooks/useFormRef.js

@@ -0,0 +1,40 @@
+'use client';
+import { useRef, useImperativeHandle } from 'react';
+import omit from 'lodash/omit';
+import useEventCallback from '../../utils/useEventCallback';
+import { nameToPath } from '../../FormControl/utils';
+export default function useFormRef(ref, props) {
+  var rootRef = useRef(null);
+  var formError = props.formError,
+    setFormError = props.setFormError,
+    nestedField = props.nestedField,
+    check = props.check,
+    checkForField = props.checkForField,
+    checkAsync = props.checkAsync,
+    checkForFieldAsync = props.checkForFieldAsync;
+  var cleanErrors = useEventCallback(function () {
+    setFormError({});
+  });
+  var resetErrors = useEventCallback(function (formError) {
+    if (formError === void 0) {
+      formError = {};
+    }
+    setFormError(formError);
+  });
+  var cleanErrorForField = useEventCallback(function (fieldName) {
+    setFormError(omit(formError, [nestedField ? nameToPath(fieldName) : fieldName]));
+  });
+  useImperativeHandle(ref, function () {
+    return {
+      root: rootRef.current,
+      check: check,
+      checkForField: checkForField,
+      checkAsync: checkAsync,
+      checkForFieldAsync: checkForFieldAsync,
+      cleanErrors: cleanErrors,
+      cleanErrorForField: cleanErrorForField,
+      resetErrors: resetErrors
+    };
+  });
+  return rootRef;
+}

package/esm/Form/hooks/useFormValidate.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="react" />
+/// <reference types="lodash" />
+import type { CheckResult } from 'schema-typed';
+import { FormInstance } from './useFormRef';
+export interface FormErrorProps {
+    ref: React.Ref<FormInstance>;
+    formValue: any;
+    getCombinedModel: () => any;
+    onCheck?: (formError: any) => void;
+    onError?: (formError: any) => void;
+    nestedField?: boolean;
+}
+export default function useFormValidate(formError: any, props: FormErrorProps): {
+    formRef: import("react").RefObject<HTMLFormElement>;
+    formError: any;
+    check: (...args: any[]) => any;
+    setFieldError: (fieldName: string, checkResult: string | CheckResult) => any;
+    onRemoveError: (name: string) => import("lodash").Omit<any, string>;
+};