rsuite 5.11.0 → 5.12.0

package/esm/Form/Form.js

@@ -12,6 +12,7 @@ import FormErrorMessage from '../FormErrorMessage';
 import FormGroup from '../FormGroup';
 import FormHelpText from '../FormHelpText';
 import { useFormClassNames } from './useFormClassNames';
+import useSchemaModel from './useSchemaModel';
 var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$checkTrigger = props.checkTrigger,
       checkTrigger = _props$checkTrigger === void 0 ? 'change' : _props$checkTrigger,
@@ -27,7 +28,7 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
       _props$layout = props.layout,
       layout = _props$layout === void 0 ? 'vertical' : _props$layout,
       _props$model = props.model,
-      model = _props$model === void 0 ? SchemaModel({}) : _props$model,
+      formModel = _props$model === void 0 ? SchemaModel({}) : _props$model,
       readOnly = props.readOnly,
       plaintext = props.plaintext,
       className = props.className,
@@ -39,6 +40,11 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
       onChange = props.onChange,
       rest = _objectWithoutPropertiesLoose(props, ["checkTrigger", "classPrefix", "errorFromContext", "formDefaultValue", "formValue", "formError", "fluid", "layout", "model", "readOnly", "plaintext", "className", "children", "disabled", "onSubmit", "onCheck", "onError", "onChange"]);
 
+  var _useSchemaModel = useSchemaModel(formModel),
+      getCombinedModel = _useSchemaModel.getCombinedModel,
+      pushFieldRule = _useSchemaModel.pushFieldRule,
+      removeFieldRule = _useSchemaModel.removeFieldRule;
+
   var classes = useFormClassNames({
     classPrefix: classPrefix,
     className: className,
@@ -73,6 +79,7 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
     var formValue = getFormValue() || {};
     var formError = {};
     var errorCount = 0;
+    var model = getCombinedModel();
     Object.keys(model.spec).forEach(function (key) {
       var checkResult = model.checkForField(key, formValue);
 
@@ -91,7 +98,7 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
     }
 
     return true;
-  }, [onCheck, onError, model, getFormValue]);
+  }, [getFormValue, getCombinedModel, onCheck, onError]);
   /**
    * Check the data field
    * @param fieldName
@@ -102,6 +109,7 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
     var _extends2;
 
     var formValue = getFormValue() || {};
+    var model = getCombinedModel();
     var checkResult = model.checkForField(fieldName, formValue);
 
     var formError = _extends({}, getFormError(), (_extends2 = {}, _extends2[fieldName] = (checkResult === null || checkResult === void 0 ? void 0 : checkResult.errorMessage) || checkResult, _extends2));
@@ -115,7 +123,7 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
     }
 
     return !checkResult.hasError;
-  }, [model, getFormValue, getFormError, onCheck, onError]);
+  }, [getFormValue, getCombinedModel, getFormError, onCheck, onError]);
   /**
    * Check form data asynchronously and return a Promise
    */
@@ -124,6 +132,7 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
     var formValue = getFormValue() || {};
     var promises = [];
     var keys = [];
+    var model = getCombinedModel();
     Object.keys(model.spec).forEach(function (key) {
       keys.push(key);
       promises.push(model.checkForFieldAsync(key, formValue));
@@ -151,7 +160,7 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
         formError: formError
       };
     });
-  }, [model, getFormValue, onCheck, onError]);
+  }, [getFormValue, getCombinedModel, onCheck, onError]);
   /**
    * Asynchronously check form fields and return Promise
    * @param fieldName
@@ -159,6 +168,7 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
 
   var checkForFieldAsync = useCallback(function (fieldName) {
     var formValue = getFormValue() || {};
+    var model = getCombinedModel();
     return model.checkForFieldAsync(fieldName, formValue).then(function (checkResult) {
       var _extends3;
 
@@ -173,7 +183,7 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
 
       return checkResult;
     });
-  }, [model, getFormValue, getFormError, onCheck, onError]);
+  }, [getFormValue, getCombinedModel, getFormError, onCheck, onError]);
   var cleanErrors = useCallback(function () {
     setFormError({});
   }, []);
@@ -244,7 +254,7 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var rootRef = useRef(null);
   var formContextValue = useMemo(function () {
     return {
-      model: model,
+      getCombinedModel: getCombinedModel,
       checkTrigger: checkTrigger,
       formDefaultValue: formDefaultValue,
       errorFromContext: errorFromContext,
@@ -254,11 +264,13 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
       formError: getFormError(),
       removeFieldValue: removeFieldValue,
       removeFieldError: removeFieldError,
+      pushFieldRule: pushFieldRule,
+      removeFieldRule: removeFieldRule,
       onFieldChange: handleFieldChange,
       onFieldError: handleFieldError,
       onFieldSuccess: handleFieldSuccess
     };
-  }, [model, checkTrigger, formDefaultValue, errorFromContext, readOnly, plaintext, disabled, getFormError, removeFieldValue, removeFieldError, handleFieldChange, handleFieldError, handleFieldSuccess]);
+  }, [getCombinedModel, checkTrigger, formDefaultValue, errorFromContext, readOnly, plaintext, disabled, getFormError, removeFieldValue, removeFieldError, pushFieldRule, removeFieldRule, handleFieldChange, handleFieldError, handleFieldSuccess]);
   return /*#__PURE__*/React.createElement("form", _extends({}, rest, {
     ref: rootRef,
     onSubmit: handleSubmit,

package/esm/Form/FormContext.d.ts

@@ -1,26 +1,31 @@
 import React from 'react';
-import { Schema } from 'schema-typed';
 import { TypeAttributes } from '../@types/common';
-export interface FormContextValue<T = Record<string, any>, errorMsgType = any, E = {
+import type { Schema } from 'schema-typed';
+import type { FieldRuleType } from './useSchemaModel';
+interface TrulyFormContextValue<T = Record<string, any>, errorMsgType = any, E = {
     [P in keyof T]?: errorMsgType;
 }> {
-    model?: Schema;
+    getCombinedModel: () => Schema;
+    formError: E;
+    removeFieldValue: (name: string) => void;
+    removeFieldError: (name: string) => void;
+    pushFieldRule: (name: string, fieldRule: FieldRuleType) => void;
+    removeFieldRule: (name: string) => void;
+    onFieldChange: (name: string, value: any, event: React.SyntheticEvent) => void;
+    onFieldError: (name: string, errorMessage: string) => void;
+    onFieldSuccess: (name: string) => void;
+}
+declare type ExternalPropsContextValue<T> = {
     checkTrigger?: TypeAttributes.CheckTrigger;
     formDefaultValue?: T;
     errorFromContext?: boolean;
     readOnly?: boolean;
     plaintext?: boolean;
     disabled?: boolean;
-    formError?: E;
-    removeFieldValue?: (name: string) => void;
-    removeFieldError?: (name: string) => void;
-    onFieldChange?: (name: string, value: any, event: React.SyntheticEvent) => void;
-    onFieldError?: (name: string, errorMessage: string) => void;
-    onFieldSuccess?: (name: string) => void;
-}
-export declare const FormContext: React.Context<FormContextValue<Record<string, any>, any, {
-    [x: string]: any;
-}>>;
+};
+declare type InitialContextType = Partial<Record<keyof TrulyFormContextValue, undefined>>;
+export declare type FormContextValue<T = Record<string, any>, errorMsgType = any> = (TrulyFormContextValue<T, errorMsgType> | InitialContextType) & ExternalPropsContextValue<T>;
+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 default FormContext;

package/esm/Form/useSchemaModel.d.ts

@@ -0,0 +1,9 @@
+import type { MutableRefObject } from 'react';
+import type { CheckType, Schema } from 'schema-typed';
+export declare type FieldRuleType = MutableRefObject<CheckType<unknown, any> | undefined>;
+declare function useSchemaModel(formModel: Schema): {
+    getCombinedModel: () => Schema<any, string>;
+    pushFieldRule: (name: string, fieldRule: FieldRuleType) => void;
+    removeFieldRule: (name: string) => void;
+};
+export default useSchemaModel;

package/esm/Form/useSchemaModel.js

@@ -0,0 +1,39 @@
+import { SchemaModel } from 'schema-typed';
+import { useRef, useCallback } from 'react';
+
+function useSchemaModel(formModel) {
+  var subRulesRef = useRef([]);
+  var pushFieldRule = useCallback(function (name, fieldRule) {
+    subRulesRef.current.push({
+      name: name,
+      fieldRule: fieldRule
+    });
+  }, []);
+  var removeFieldRule = useCallback(function (name) {
+    var index = subRulesRef.current.findIndex(function (v) {
+      return v.name === name;
+    });
+    subRulesRef.current.splice(index, 1);
+  }, []);
+  var getCombinedModel = useCallback(function () {
+    var realSubRules = subRulesRef.current.filter(function (v) {
+      return Boolean(v.fieldRule.current);
+    });
+    return SchemaModel.combine(formModel, SchemaModel(realSubRules.map(function (_ref) {
+      var _ref2;
+
+      var name = _ref.name,
+          fieldRule = _ref.fieldRule;
+      return _ref2 = {}, _ref2[name] = fieldRule.current, _ref2;
+    }).reduce(function (a, b) {
+      return Object.assign(a, b);
+    }, {})));
+  }, [formModel]);
+  return {
+    getCombinedModel: getCombinedModel,
+    pushFieldRule: pushFieldRule,
+    removeFieldRule: removeFieldRule
+  };
+}
+
+export default useSchemaModel;

package/esm/FormControl/FormControl.d.ts

@@ -1,6 +1,7 @@
 import React from 'react';
 import Input from '../Input';
 import { TypeAttributes, FormControlBaseProps, WithAsProps } from '../@types/common';
+import type { CheckType } from 'schema-typed';
 /**
  * Props that FormControl passes to its accepter
  */
@@ -30,6 +31,8 @@ export interface FormControlProps<P = any, ValueType = any> extends WithAsProps,
     checkAsync?: boolean;
     /** Remove field value and error message when component is unmounted  */
     shouldResetWithUnmount?: boolean;
+    /** Validation rule */
+    rule?: CheckType<unknown, any>;
 }
 interface FormControlComponent extends React.FC<FormControlProps> {
     <Accepter extends React.ElementType = typeof Input>(props: FormControlProps & {

package/esm/FormControl/FormControl.js

@@ -13,10 +13,7 @@ import { useClassNames } from '../utils';
 import FormContext, { FormValueContext } from '../Form/FormContext';
 import { FormGroupContext } from '../FormGroup/FormGroup';
 import { useWillUnmount } from '../utils';
-/**
- * Props that FormControl passes to its accepter
- */
-
+import useRegisterModel from './useRegisterModel';
 var FormControl = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _useContext = useContext(FormContext),
       readOnlyContext = _useContext.readOnly,
@@ -28,10 +25,12 @@ var FormControl = /*#__PURE__*/React.forwardRef(function (props, ref) {
       formError = _useContext.formError,
       removeFieldValue = _useContext.removeFieldValue,
       removeFieldError = _useContext.removeFieldError,
+      pushFieldRule = _useContext.pushFieldRule,
+      removeFieldRule = _useContext.removeFieldRule,
       onFieldChange = _useContext.onFieldChange,
       onFieldError = _useContext.onFieldError,
       onFieldSuccess = _useContext.onFieldSuccess,
-      model = _useContext.model,
+      getCombinedModel = _useContext.getCombinedModel,
       contextCheckTrigger = _useContext.checkTrigger;
 
   var _props$as = props.as,
@@ -59,7 +58,8 @@ var FormControl = /*#__PURE__*/React.forwardRef(function (props, ref) {
       defaultValue = props.defaultValue,
       _props$shouldResetWit = props.shouldResetWithUnmount,
       shouldResetWithUnmount = _props$shouldResetWit === void 0 ? false : _props$shouldResetWit,
-      rest = _objectWithoutPropertiesLoose(props, ["as", "accepter", "classPrefix", "className", "checkAsync", "checkTrigger", "errorPlacement", "errorMessage", "name", "value", "readOnly", "plaintext", "disabled", "onChange", "onBlur", "defaultValue", "shouldResetWithUnmount"]);
+      rule = props.rule,
+      rest = _objectWithoutPropertiesLoose(props, ["as", "accepter", "classPrefix", "className", "checkAsync", "checkTrigger", "errorPlacement", "errorMessage", "name", "value", "readOnly", "plaintext", "disabled", "onChange", "onBlur", "defaultValue", "shouldResetWithUnmount", "rule"]);
 
   var _useContext2 = useContext(FormGroupContext),
       controlId = _useContext2.controlId;
@@ -68,6 +68,7 @@ var FormControl = /*#__PURE__*/React.forwardRef(function (props, ref) {
     throw new Error("\n      <FormControl> must be inside a component decorated with <Form>.\n      And need to update React to 16.6.0 +.\n    ");
   }
 
+  useRegisterModel(name, pushFieldRule, removeFieldRule, rule);
   useWillUnmount(function () {
     if (shouldResetWithUnmount) {
       removeFieldValue === null || removeFieldValue === void 0 ? void 0 : removeFieldValue(name);
@@ -114,6 +115,8 @@ var FormControl = /*#__PURE__*/React.forwardRef(function (props, ref) {
 
     var nextFormValue = _extends({}, formValue, (_extends2 = {}, _extends2[name] = value, _extends2));
 
+    var model = getCombinedModel();
+
     if (checkAsync) {
       return model === null || model === void 0 ? void 0 : model.checkForFieldAsync(name, nextFormValue).then(function (checkResult) {
         return callbackEvents(checkResult);

package/esm/FormControl/useRegisterModel.d.ts

@@ -0,0 +1,4 @@
+import type { FieldRuleType } from '../Form/useSchemaModel';
+import type { CheckType } from 'schema-typed';
+declare function useRegisterModel(name: string, pushFieldRule: (n: string, r: FieldRuleType) => void, removeFieldRule: (n: string) => void, rule?: CheckType<unknown, any>): void;
+export default useRegisterModel;

package/esm/FormControl/useRegisterModel.js

@@ -0,0 +1,14 @@
+import { useRef, useEffect } from 'react';
+
+function useRegisterModel(name, pushFieldRule, removeFieldRule, rule) {
+  var refRule = useRef(rule);
+  refRule.current = rule;
+  useEffect(function () {
+    pushFieldRule(name, refRule);
+    return function () {
+      removeFieldRule(name);
+    };
+  }, [name, pushFieldRule, removeFieldRule]);
+}
+
+export default useRegisterModel;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rsuite",
-  "version": "5.11.0",
+  "version": "5.12.0",
   "description": "A suite of react components",
   "main": "cjs/index.js",
   "module": "esm/index.js",