rsuite 5.47.0 → 5.48.0

package/cjs/Dropdown/DropdownSeparator.js

@@ -10,7 +10,7 @@ var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 /**
- * The <Dropdown.Separator> API
+ * The `<Dropdown.Separator>` API
  *
  * Renders a non-focusable and non-interactive `separator`
  * Per ARIA APG https://www.w3.org/WAI/ARIA/apg/patterns/menu/

package/cjs/FlexboxGrid/FlexboxGrid.d.ts

@@ -9,5 +9,9 @@ export interface FlexboxGridProps extends WithAsProps {
 interface FlexboxGridCompont extends RsRefForwardingComponent<'div', FlexboxGridProps> {
     Item: typeof FlexboxGridItem;
 }
+/**
+ * The FlexboxGrid component is a box that can be used to layout other components.
+ * @see https://rsuitejs.com/components/flexbox-grid
+ */
 declare const FlexboxGrid: FlexboxGridCompont;
 export default FlexboxGrid;

package/cjs/FlexboxGrid/FlexboxGrid.js

@@ -10,6 +10,10 @@ var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _FlexboxGridItem = _interopRequireDefault(require("./FlexboxGridItem"));
+/**
+ * The FlexboxGrid component is a box that can be used to layout other components.
+ * @see https://rsuitejs.com/components/flexbox-grid
+ */
 var FlexboxGrid = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/FlexboxGrid/FlexboxGridItem.d.ts

@@ -5,5 +5,9 @@ export interface FlexboxGridItemProps extends WithAsProps {
     /** grid orders for sorting */
     order?: number;
 }
+/**
+ * The `FlexboxGrid.Item` component is used to specify the layout of the child element in the `FlexboxGrid` component.
+ * @see https://rsuitejs.com/components/flexbox-grid
+ */
 declare const FlexboxGridItem: RsRefForwardingComponent<'div', FlexboxGridItemProps>;
 export default FlexboxGridItem;

package/cjs/FlexboxGrid/FlexboxGridItem.js

@@ -9,6 +9,10 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
+/**
+ * The `FlexboxGrid.Item` component is used to specify the layout of the child element in the `FlexboxGrid` component.
+ * @see https://rsuitejs.com/components/flexbox-grid
+ */
 var FlexboxGridItem = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _withClassPrefix;
   var _props$as = props.as,

package/cjs/Footer/Footer.d.ts

@@ -1,4 +1,8 @@
 import { ComponentProps } from '../utils/createComponent';
 export declare type FooterProps = ComponentProps;
+/**
+ * The `<Footer>` component is used to specify the footer of the page.
+ * @see https://rsuitejs.com/components/container/
+ */
 declare const Footer: import("../@types/common").RsRefForwardingComponent<"footer", ComponentProps>;
 export default Footer;

package/cjs/Footer/Footer.js

@@ -5,6 +5,10 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 exports.__esModule = true;
 exports.default = void 0;
 var _createComponent = _interopRequireDefault(require("../utils/createComponent"));
+/**
+ * The `<Footer>` component is used to specify the footer of the page.
+ * @see https://rsuitejs.com/components/container/
+ */
 var Footer = (0, _createComponent.default)({
   name: 'Footer',
   componentAs: 'footer'

package/cjs/Form/Form.d.ts

@@ -69,5 +69,9 @@ export interface FormComponent extends RsRefForwardingComponent<'form', FormProp
     Group: typeof FormGroup;
     HelpText: typeof FormHelpText;
 }
+/**
+ * The `Form` component is a form interface for collecting and validating user input.
+ * @see https://rsuitejs.com/components/form
+ */
 declare const Form: FormComponent;
 export default Form;

package/cjs/Form/Form.js

@@ -20,6 +20,10 @@ var _FormHelpText = _interopRequireDefault(require("../FormHelpText"));
 var _useFormClassNames = require("./useFormClassNames");
 var _useSchemaModel2 = _interopRequireDefault(require("./useSchemaModel"));
 var _utils = require("../utils");
+/**
+ * The `Form` component is a form interface for collecting and validating user input.
+ * @see https://rsuitejs.com/components/form
+ */
 var Form = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$checkTrigger = props.checkTrigger,
     checkTrigger = _props$checkTrigger === void 0 ? 'change' : _props$checkTrigger,

package/cjs/FormControl/FormControl.d.ts

@@ -39,5 +39,9 @@ interface FormControlComponent extends React.FC<FormControlProps> {
         accepter?: Accepter;
     } & React.ComponentPropsWithRef<Accepter>): React.ReactElement | null;
 }
+/**
+ * The `<Form.Control>` component is used to wrap the components that need to be validated.
+ * @see https://rsuitejs.com/components/form/
+ */
 declare const FormControl: FormControlComponent;
 export default FormControl;

package/cjs/FormControl/FormControl.js

@@ -23,6 +23,10 @@ var _templateObject;
  * Props that FormControl passes to its accepter
  */
 
+/**
+ * The `<Form.Control>` component is used to wrap the components that need to be validated.
+ * @see https://rsuitejs.com/components/form/
+ */
 var FormControl = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _accepterProps;
   var _useContext = (0, _react.useContext)(_FormContext.default),

package/cjs/FormControlLabel/FormControlLabel.d.ts

@@ -4,5 +4,9 @@ export interface FormControlLabelProps extends WithAsProps, React.LabelHTMLAttri
     /** Attribute of the html label tag, defaults to the controlId of the FormGroup */
     htmlFor?: string;
 }
+/**
+ * The `<Form.ControlLabel>` component renders a label with required indicator, for form controls.
+ * @see https://rsuitejs.com/components/form/
+ */
 declare const FormControlLabel: RsRefForwardingComponent<'label', FormControlLabelProps>;
 export default FormControlLabel;

package/cjs/FormControlLabel/FormControlLabel.js

@@ -11,6 +11,10 @@ var _react = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _FormGroup = require("../FormGroup/FormGroup");
+/**
+ * The `<Form.ControlLabel>` component renders a label with required indicator, for form controls.
+ * @see https://rsuitejs.com/components/form/
+ */
 var FormControlLabel = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'label' : _props$as,

package/cjs/FormErrorMessage/FormErrorMessage.d.ts

@@ -5,5 +5,9 @@ export interface FormErrorMessageProps extends WithAsProps {
     /** The placement of error messages */
     placement?: TypeAttributes.Placement8;
 }
+/**
+ * The `<Form.ErrorMessage>` component is used to display error messages in the form.
+ * @see https://rsuitejs.com/components/form/
+ */
 declare const FormErrorMessage: RsRefForwardingComponent<'div', FormErrorMessageProps>;
 export default FormErrorMessage;

package/cjs/FormErrorMessage/FormErrorMessage.js

@@ -12,6 +12,10 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 var _kebabCase = _interopRequireDefault(require("lodash/kebabCase"));
 var _utils = require("../utils");
 var _templateObject, _templateObject2;
+/**
+ * The `<Form.ErrorMessage>` component is used to display error messages in the form.
+ * @see https://rsuitejs.com/components/form/
+ */
 var FormErrorMessage = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _prefix;
   var _props$as = props.as,

package/cjs/FormGroup/FormGroup.d.ts

@@ -10,5 +10,9 @@ export interface FormGroupProps extends WithAsProps {
 export declare const FormGroupContext: React.Context<{
     controlId?: string | undefined;
 }>;
+/**
+ * The `<Form.Group>` component is the easiest way to add some structure to forms.
+ * @see https://rsuitejs.com/components/form/
+ */
 declare const FormGroup: RsRefForwardingComponent<'div', FormGroupProps>;
 export default FormGroup;

package/cjs/FormGroup/FormGroup.js

@@ -11,6 +11,11 @@ var _react = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var FormGroupContext = /*#__PURE__*/_react.default.createContext({});
+
+/**
+ * The `<Form.Group>` component is the easiest way to add some structure to forms.
+ * @see https://rsuitejs.com/components/form/
+ */
 exports.FormGroupContext = FormGroupContext;
 var FormGroup = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,

package/cjs/FormHelpText/FormHelpText.d.ts

@@ -3,5 +3,9 @@ export interface FormHelpTextProps extends WithAsProps {
     /** Whether to show through the Tooltip component */
     tooltip?: boolean;
 }
+/**
+ * The `<Form.HelpText>` component is used to display help information in the form.
+ * @see https://rsuitejs.com/components/form/
+ */
 declare const FormHelpText: RsRefForwardingComponent<'span', FormHelpTextProps>;
 export default FormHelpText;

package/cjs/FormHelpText/FormHelpText.js

@@ -14,6 +14,10 @@ var _Whisper = _interopRequireDefault(require("../Whisper"));
 var _utils = require("../utils");
 var _FormGroup = require("../FormGroup/FormGroup");
 var _HelpO = _interopRequireDefault(require("@rsuite/icons/legacy/HelpO"));
+/**
+ * The `<Form.HelpText>` component is used to display help information in the form.
+ * @see https://rsuitejs.com/components/form/
+ */
 var FormHelpText = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'span' : _props$as,

package/cjs/Grid/Grid.d.ts

@@ -3,5 +3,9 @@ export interface GridProps extends WithAsProps {
     /** Fluid layout */
     fluid?: boolean;
 }
+/**
+ * The Grid component is used to specify the layout of child elements in rows and columns.
+ * @see https://rsuitejs.com/components/grid
+ */
 declare const Grid: RsRefForwardingComponent<'div', GridProps>;
 export default Grid;

package/cjs/Grid/Grid.js

@@ -9,6 +9,10 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
+/**
+ * The Grid component is used to specify the layout of child elements in rows and columns.
+ * @see https://rsuitejs.com/components/grid
+ */
 var Grid = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/Header/Header.d.ts

@@ -1,4 +1,8 @@
 import { ComponentProps } from '../utils/createComponent';
 export declare type HeaderProps = ComponentProps;
+/**
+ * The `<Header>` component is used to specify the header of the page.
+ * @see https://rsuitejs.com/components/container/
+ */
 declare const Header: import("../@types/common").RsRefForwardingComponent<"header", ComponentProps>;
 export default Header;

package/cjs/Header/Header.js

@@ -5,6 +5,10 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 exports.__esModule = true;
 exports.default = void 0;
 var _createComponent = _interopRequireDefault(require("../utils/createComponent"));
+/**
+ * The `<Header>` component is used to specify the header of the page.
+ * @see https://rsuitejs.com/components/container/
+ */
 var Header = (0, _createComponent.default)({
   name: 'Header',
   componentAs: 'header'

package/cjs/IconButton/IconButton.d.ts

@@ -10,6 +10,10 @@ export interface IconButtonProps extends ButtonProps {
     /** The placement of icon */
     placement?: 'left' | 'right';
 }
+/**
+ * The `IconButton` component is used to specify a button with icon.
+ * @see https://rsuitejs.com/components/button
+ */
 declare const IconButton: RsRefForwardingComponent<typeof Button, IconButtonProps & {
     ref?: React.Ref<HTMLElement>;
 }>;

package/cjs/IconButton/IconButton.js

@@ -10,6 +10,10 @@ var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _Button = _interopRequireDefault(require("../Button"));
+/**
+ * The `IconButton` component is used to specify a button with icon.
+ * @see https://rsuitejs.com/components/button
+ */
 var IconButton = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var icon = props.icon,
     _props$placement = props.placement,

package/cjs/Input/Input.d.ts

@@ -17,5 +17,9 @@ export interface InputProps extends WithAsProps, Omit<React.InputHTMLAttributes<
     /** Called on press enter */
     onPressEnter?: React.KeyboardEventHandler<HTMLInputElement>;
 }
+/**
+ * The `<Input>` component is used to get user input in a text field.
+ * @see https://rsuitejs.com/components/input
+ */
 declare const Input: RsRefForwardingComponent<'input', InputProps>;
 export default Input;

package/cjs/Input/Input.js

@@ -13,6 +13,10 @@ var _FormGroup = require("../FormGroup/FormGroup");
 var _InputGroup = require("../InputGroup/InputGroup");
 var _Plaintext = _interopRequireDefault(require("../Plaintext"));
 var _utils = require("../utils");
+/**
+ * The `<Input>` component is used to get user input in a text field.
+ * @see https://rsuitejs.com/components/input
+ */
 var Input = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var className = props.className,
     _props$classPrefix = props.classPrefix,

package/cjs/InputGroup/InputGroup.d.ts

@@ -20,5 +20,9 @@ export interface InputGroupComponent extends RsRefForwardingComponent<'div', Inp
     Addon: typeof InputGroupAddon;
     Button: typeof InputGroupButton;
 }
+/**
+ * The `InputGroup` component is used to specify an input field with an add-on.
+ * @see https://rsuitejs.com/components/input/#input-group
+ */
 declare const InputGroup: InputGroupComponent;
 export default InputGroup;

package/cjs/InputGroup/InputGroup.js

@@ -14,6 +14,10 @@ var _InputGroupButton = _interopRequireDefault(require("./InputGroupButton"));
 var _utils = require("../utils");
 var InputGroupContext = /*#__PURE__*/_react.default.createContext(null);
 exports.InputGroupContext = InputGroupContext;
+/**
+ * The `InputGroup` component is used to specify an input field with an add-on.
+ * @see https://rsuitejs.com/components/input/#input-group
+ */
 var InputGroup = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/InputGroup/InputGroupAddon.d.ts

@@ -4,5 +4,9 @@ export interface InputGroupAddonProps extends WithAsProps, React.HTMLAttributes<
     /** An Input group addon can show that it is disabled */
     disabled?: boolean;
 }
+/**
+ * The `InputGroup.Addon` component is used to specify an input field with an add-on.
+ * @see https://rsuitejs.com/components/input/#input-group
+ */
 declare const InputGroupAddon: RsRefForwardingComponent<'span', InputGroupAddonProps>;
 export default InputGroupAddon;

package/cjs/InputGroup/InputGroupAddon.js

@@ -9,6 +9,10 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
+/**
+ * The `InputGroup.Addon` component is used to specify an input field with an add-on.
+ * @see https://rsuitejs.com/components/input/#input-group
+ */
 var InputGroupAddon = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'span' : _props$as,

package/cjs/InputGroup/InputGroupButton.d.ts

@@ -1,4 +1,8 @@
 import React from 'react';
 import { ButtonProps } from '../Button';
+/**
+ * The `InputGroup.Button` component is used to specify an input field with an add-on.
+ * @see https://rsuitejs.com/components/input/#input-group
+ */
 declare const InputGroupButton: React.ForwardRefExoticComponent<ButtonProps & React.RefAttributes<any>>;
 export default InputGroupButton;

package/cjs/InputGroup/InputGroupButton.js

@@ -9,6 +9,10 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 var _react = _interopRequireDefault(require("react"));
 var _utils = require("../utils");
 var _Button = _interopRequireDefault(require("../Button"));
+/**
+ * The `InputGroup.Button` component is used to specify an input field with an add-on.
+ * @see https://rsuitejs.com/components/input/#input-group
+ */
 var InputGroupButton = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$classPrefix = props.classPrefix,
     classPrefix = _props$classPrefix === void 0 ? 'input-group-btn' : _props$classPrefix,

package/cjs/InputNumber/InputNumber.d.ts

@@ -21,5 +21,9 @@ export interface InputNumberProps<T = number | string> extends Omit<React.InputH
     scrollable?: boolean;
     onWheel?: (event: React.WheelEvent) => void;
 }
+/**
+ * The `InputNumber` component is used to enter a numerical value.
+ * @see https://rsuitejs.com/components/input-number
+ */
 declare const InputNumber: React.ForwardRefExoticComponent<InputNumberProps<string | number> & React.RefAttributes<unknown>>;
 export default InputNumber;

package/cjs/InputNumber/InputNumber.js

@@ -72,6 +72,11 @@ function valueReachesMin(value, min) {
   }
   return false;
 }
+
+/**
+ * The `InputNumber` component is used to enter a numerical value.
+ * @see https://rsuitejs.com/components/input-number
+ */
 var InputNumber = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? _InputGroup.default : _props$as,

package/cjs/InputPicker/InputPicker.d.ts

@@ -29,5 +29,10 @@ export interface InputPickerProps<T = ValueType> extends FormControlPickerProps<
      */
     shouldDisplayCreateOption?: (searchKeyword: string, filteredData: InputItemDataType[]) => boolean;
 }
+/**
+ * Single item selector with text box input.
+ *
+ * @see https://rsuitejs.com/components/input-picker
+ */
 declare const InputPicker: PickerComponent<InputPickerProps>;
 export default InputPicker;

package/cjs/InputPicker/InputPicker.js

@@ -30,6 +30,11 @@ var _InputAutosize = _interopRequireDefault(require("./InputAutosize"));
 var _InputSearch = _interopRequireDefault(require("./InputSearch"));
 var _InputPickerContext = _interopRequireDefault(require("./InputPickerContext"));
 var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5;
+/**
+ * Single item selector with text box input.
+ *
+ * @see https://rsuitejs.com/components/input-picker
+ */
 var InputPicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _merge;
   var _props$as = props.as,

package/cjs/List/List.d.ts

@@ -10,5 +10,9 @@ export interface ListProps extends WithAsProps, SortConfig {
 export interface ListComponent extends RsRefForwardingComponent<'div', ListProps> {
     Item: typeof ListItem;
 }
+/**
+ * The `List` component is used to specify the layout of the list.
+ * @see https://rsuitejs.com/components/list
+ */
 declare const List: ListComponent;
 export default List;

package/cjs/List/List.js

@@ -13,6 +13,10 @@ var _useSortHelper2 = _interopRequireDefault(require("./helper/useSortHelper"));
 var _utils = require("../utils");
 var _ListContext = _interopRequireDefault(require("./ListContext"));
 var _ListItem = _interopRequireDefault(require("./ListItem"));
+/**
+ * The `List` component is used to specify the layout of the list.
+ * @see https://rsuitejs.com/components/list
+ */
 var List = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/List/ListItem.d.ts

@@ -7,5 +7,9 @@ export interface ListItemProps extends WithAsProps, React.HTMLAttributes<HTMLEle
     disabled?: boolean;
     size?: 'lg' | 'md' | 'sm';
 }
+/**
+ * The `List.Item` component is used to specify the layout of the list item.
+ * @see https://rsuitejs.com/components/list
+ */
 declare const ListItem: React.ForwardRefExoticComponent<ListItemProps & React.RefAttributes<HTMLDivElement>>;
 export default ListItem;

package/cjs/List/ListItem.js

@@ -11,6 +11,10 @@ var _react = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _ListContext = _interopRequireDefault(require("./ListContext"));
+/**
+ * The `List.Item` component is used to specify the layout of the list item.
+ * @see https://rsuitejs.com/components/list
+ */
 var ListItem = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/Loader/Loader.d.ts

@@ -16,5 +16,9 @@ export interface LoaderProps extends WithAsProps {
     /** A loader can have different sizes */
     size?: TypeAttributes.Size;
 }
+/**
+ * The `Loader` component is used to indicate the loading state of a page or a section.
+ * @see https://rsuitejs.com/components/loader
+ */
 declare const Loader: RsRefForwardingComponent<'div', LoaderProps>;
 export default Loader;

package/cjs/Loader/Loader.js

@@ -9,6 +9,10 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
+/**
+ * The `Loader` component is used to indicate the loading state of a page or a section.
+ * @see https://rsuitejs.com/components/loader
+ */
 var Loader = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/MaskedInput/TextMask.d.ts

@@ -32,6 +32,10 @@ export declare type TextMaskProps = TextMaskBaseProps & React.HTMLAttributes<HTM
     readOnly?: boolean;
     disabled?: boolean;
 };
+/**
+ * The `TextMask` component is used to format the user input data.
+ * @see https://rsuitejs.com/components/input/#masked-input
+ */
 declare const TextMask: React.ForwardRefExoticComponent<TextMaskBaseProps & React.HTMLAttributes<HTMLInputElement> & {
     /** Custom rendering DOM */
     render?: ((ref: React.Ref<HTMLInputElement>, props: React.HTMLAttributes<HTMLInputElement>) => any) | undefined;

package/cjs/MaskedInput/TextMask.js

@@ -21,6 +21,11 @@ var defaultRender = function defaultRender(ref, props) {
     ref: ref
   }, props));
 };
+
+/**
+ * The `TextMask` component is used to format the user input data.
+ * @see https://rsuitejs.com/components/input/#masked-input
+ */
 var TextMask = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var mask = props.mask,
     _props$guide = props.guide,

package/cjs/MaskedInput/createTextMaskInputElement.js

@@ -10,11 +10,9 @@ var _isNumber = _interopRequireDefault(require("lodash/isNumber"));
 var _adjustCaretPosition = _interopRequireDefault(require("./adjustCaretPosition"));
 var _conformToMask2 = _interopRequireDefault(require("./conformToMask"));
 var _utilities = require("./utilities");
+var _safeSetSelection = _interopRequireDefault(require("../utils/safeSetSelection"));
 var emptyString = '';
-var strNone = 'none';
 var strObject = 'object';
-var isAndroid = typeof navigator !== 'undefined' && /Android/i.test(navigator.userAgent);
-var defer = typeof requestAnimationFrame !== 'undefined' ? requestAnimationFrame : setTimeout;
 function createTextMaskInputElement(config) {
   // Anything that we will need to keep between `update` calls, we will store in this `state` object.
   var state = {
@@ -146,7 +144,7 @@ function createTextMaskInputElement(config) {
         // indicate rejection. Or return just a string when there are no piped characters.
         // If the `pipe` returns `false` or a string, the block below turns it into an object that the rest
         // of the code can work with.
-        if (pipeResults === false) {
+        if (typeof pipeResults === 'boolean' && pipeResults === false) {
           // If the `pipe` rejects `conformedValue`, we use the `previousConformedValue`, and set `rejected` to `true`.
           pipeResults = {
             value: previousConformedValue,
@@ -191,22 +189,14 @@ function createTextMaskInputElement(config) {
         return;
       }
       inputElement.value = inputElementValue; // set the input value
-      safeSetSelection(inputElement, adjustedCaretPosition); // adjust caret position
+
+      if (typeof adjustedCaretPosition === 'number') {
+        (0, _safeSetSelection.default)(inputElement, adjustedCaretPosition, adjustedCaretPosition); // adjust caret position
+      }
     }
   };
 }
 
-function safeSetSelection(element, selectionPosition) {
-  if (document.activeElement === element) {
-    if (isAndroid) {
-      defer(function () {
-        return element.setSelectionRange(selectionPosition, selectionPosition, strNone);
-      }, 0);
-    } else {
-      element.setSelectionRange(selectionPosition, selectionPosition, strNone);
-    }
-  }
-}
 function getSafeRawValue(inputValue) {
   if ((0, _isString.default)(inputValue)) {
     return inputValue;

package/cjs/Message/Message.d.ts

@@ -24,5 +24,9 @@ export interface MessageProps extends WithAsProps {
     /** Callback after the message is removed */
     onClose?: (event?: React.MouseEvent<HTMLButtonElement>) => void;
 }
+/**
+ * The `Message` component is used to display important messages to users.
+ * @see https://rsuitejs.com/components/message
+ */
 declare const Message: RsRefForwardingComponent<'div', MessageProps>;
 export default Message;

package/cjs/Message/Message.js

@@ -14,6 +14,10 @@ var _utils = require("../utils");
 var _CloseButton = _interopRequireDefault(require("../CloseButton"));
 var _ToastContext = _interopRequireDefault(require("../toaster/ToastContext"));
 var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5;
+/**
+ * The `Message` component is used to display important messages to users.
+ * @see https://rsuitejs.com/components/message
+ */
 var Message = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _withClassPrefix;
   var _props$as = props.as,

package/cjs/Modal/Modal.d.ts

@@ -35,5 +35,9 @@ interface ModalComponent extends RsRefForwardingComponent<'div', ModalProps> {
     Footer: typeof ModalFooter;
     Dialog: typeof ModalDialog;
 }
+/**
+ * The `Modal` component is used to show content in a layer above the app.
+ * @see https://rsuitejs.com/components/modal
+ */
 declare const Modal: ModalComponent;
 export default Modal;

package/cjs/Modal/Modal.js

@@ -28,6 +28,10 @@ var _deprecatePropType = _interopRequireDefault(require("../utils/deprecatePropT
 var _DrawerContext = _interopRequireDefault(require("../Drawer/DrawerContext"));
 var _templateObject, _templateObject2;
 var modalSizes = ['xs', 'sm', 'md', 'lg', 'full'];
+/**
+ * The `Modal` component is used to show content in a layer above the app.
+ * @see https://rsuitejs.com/components/modal
+ */
 var Modal = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _prefix;
   var className = props.className,

package/cjs/MultiCascader/MultiCascader.d.ts

@@ -34,5 +34,9 @@ export interface MultiCascaderProps<T = ValueType> extends FormControlPickerProp
     /** Asynchronously load the children of the tree node. */
     getChildren?: (node: ItemDataType) => ItemDataType[] | Promise<ItemDataType[]>;
 }
+/**
+ * The `MultiCascader` component is used to select multiple values from cascading options.
+ * @see https://rsuitejs.com/components/multi-cascader/
+ */
 declare const MultiCascader: PickerComponent<MultiCascaderProps>;
 export default MultiCascader;