rsuite 6.0.0-canary-20250416 → 6.0.0-canary-20250507

package/cjs/useFormControl/useFormControl.d.ts

@@ -0,0 +1,38 @@
+import React from 'react';
+import type { CheckType } from 'schema-typed';
+import type { CheckTriggerType } from '../internals/types';
+export interface UseFormControlProps {
+    /** The name of form field */
+    name: string;
+    /** The current value (controlled) */
+    value?: any;
+    /** The data validation trigger type */
+    checkTrigger?: CheckTriggerType;
+    /** Show error messages */
+    errorMessage?: React.ReactNode;
+    /** Asynchronous check value */
+    checkAsync?: boolean;
+    /** Remove field value and error message when component is unmounted */
+    shouldResetWithUnmount?: boolean;
+    /** Validation rule */
+    rule?: CheckType<unknown, any>;
+}
+/**
+ * Hook for accessing form control functionality.
+ * Must be used within a Form component.
+ *
+ * @param props The form control properties
+ * @returns Form control functionality for the specified field
+ */
+export declare function useFormControl(props: UseFormControlProps): {
+    value: any;
+    error: React.ReactNode;
+    plaintext: boolean | undefined;
+    readOnly: boolean | undefined;
+    disabled: boolean | undefined;
+    onChange: (...args: any[]) => any;
+    onCheck: (...args: any[]) => any;
+    onBlur: (...args: any[]) => any;
+    setValue: (value: any, shouldValidate?: boolean) => void;
+};
+export default useFormControl;

package/cjs/useFormControl/useFormControl.js

@@ -0,0 +1,138 @@
+'use client';
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+exports.useFormControl = useFormControl;
+var _react = require("react");
+var _FormContext = require("../Form/FormContext");
+var _hooks = require("../internals/hooks");
+var _useRegisterModel = require("./hooks/useRegisterModel");
+var _useField = require("./hooks/useField");
+/**
+ * Hook for accessing form control functionality.
+ * Must be used within a Form component.
+ *
+ * @param props The form control properties
+ * @returns Form control functionality for the specified field
+ */
+function useFormControl(props) {
+  const {
+    name,
+    value: controlledValue,
+    checkTrigger,
+    errorMessage,
+    checkAsync = false,
+    shouldResetWithUnmount = false,
+    rule
+  } = props;
+  const {
+    readOnly,
+    plaintext,
+    disabled,
+    errorFromContext,
+    formError,
+    nestedField,
+    onFieldChange,
+    removeFieldValue,
+    removeFieldError,
+    checkTrigger: contextCheckTrigger,
+    checkFieldForNextValue,
+    checkFieldAsyncForNextValue
+  } = (0, _FormContext.useFormContext)();
+
+  // Throw an error if not used within a Form component
+  if (!onFieldChange) {
+    console.error(`<useFormControl> must be used inside a component decorated with <Form>. And need to update React to 16.6.0 +.`);
+  }
+  const formValue = (0, _react.useContext)(_FormContext.FormValueContext);
+
+  // Register form field model
+  (0, _useRegisterModel.useRegisterModel)(name, rule);
+
+  // Cleanup on unmount if shouldResetWithUnmount is true
+  (0, _hooks.useWillUnmount)(() => {
+    if (shouldResetWithUnmount) {
+      removeFieldValue === null || removeFieldValue === void 0 || removeFieldValue(name);
+      removeFieldError === null || removeFieldError === void 0 || removeFieldError(name);
+    }
+  });
+
+  // Use the useField hook to handle field value and error
+  const {
+    fieldValue: value,
+    fieldError: error,
+    setFieldValue
+  } = (0, _useField.useField)({
+    name,
+    errorMessage,
+    formValue,
+    formError,
+    value: controlledValue,
+    nestedField,
+    errorFromContext
+  });
+  const trigger = checkTrigger || contextCheckTrigger;
+
+  // Handler for field check (validation)
+  const onCheck = (0, _hooks.useEventCallback)(value => {
+    // Don't perform validation when checkTrigger is null
+    if (trigger === null) {
+      return;
+    }
+    const nextFormValue = setFieldValue(name, value);
+    if (checkAsync) {
+      checkFieldAsyncForNextValue === null || checkFieldAsyncForNextValue === void 0 || checkFieldAsyncForNextValue(name, nextFormValue);
+    } else {
+      checkFieldForNextValue === null || checkFieldForNextValue === void 0 || checkFieldForNextValue(name, nextFormValue);
+    }
+  });
+
+  // Handler for field change
+  const onChange = (0, _hooks.useEventCallback)((value, event) => {
+    if (trigger === 'change') {
+      onCheck(value);
+    }
+    onFieldChange === null || onFieldChange === void 0 || onFieldChange(name, value, event);
+  });
+
+  // Handler for field blur
+  const onBlur = (0, _hooks.useEventCallback)(() => {
+    if (trigger === 'blur') {
+      onCheck(value);
+    }
+  });
+
+  /**
+   * Directly sets the field value without triggering validation or onChange events.
+   * Useful for programmatically updating field values.
+   * @param value The new value to set
+   * @param shouldValidate Whether to trigger validation (defaults to false)
+   */
+  const setValue = (0, _react.useCallback)(function (value, shouldValidate) {
+    if (shouldValidate === void 0) {
+      shouldValidate = false;
+    }
+    const nextFormValue = setFieldValue(name, value);
+    onFieldChange === null || onFieldChange === void 0 || onFieldChange(name, value);
+    if (shouldValidate && trigger !== null) {
+      if (checkAsync) {
+        checkFieldAsyncForNextValue === null || checkFieldAsyncForNextValue === void 0 || checkFieldAsyncForNextValue(name, nextFormValue);
+      } else {
+        checkFieldForNextValue === null || checkFieldForNextValue === void 0 || checkFieldForNextValue(name, nextFormValue);
+      }
+    }
+  }, [name, setFieldValue, trigger, checkAsync, checkFieldAsyncForNextValue, checkFieldForNextValue]);
+  return {
+    value,
+    error,
+    plaintext,
+    readOnly,
+    disabled,
+    onChange,
+    onCheck,
+    onBlur,
+    setValue
+  };
+}
+var _default = exports.default = useFormControl;

package/cjs/useToaster/useToaster.js

@@ -6,10 +6,7 @@ exports.__esModule = true;
 exports.default = void 0;
 var _react = require("react");
 var _toaster = _interopRequireDefault(require("../toaster"));
-var _CustomProvider = require("../CustomProvider/CustomProvider");
-// From CustomProvider/CustomProvider.tsx import CustomContext instead of directly from 'CustomProvider/index.ts'
-// because babel compiles commonjs, which causes CustomContext to be undefined
-
+var _CustomContext = require("../internals/Provider/CustomContext");
 /**
  * Toaster display brief, temporary notifications of actions, errors, or other events in an application.
  * It is often used with the Message and Notification components.
@@ -21,7 +18,7 @@ const useToaster = () => {
   const {
     toasters,
     toastContainer
-  } = (0, _react.useContext)(_CustomProvider.CustomContext);
+  } = (0, _react.useContext)(_CustomContext.CustomContext);
   return (0, _react.useMemo)(() => ({
     /**
      * Push a toast message.