@qsxy/element-plus-react 1.0.0-next.1 → 1.0.0-next.3

package/dist/Tree/utils/treeUtil.d.ts

@@ -3,8 +3,20 @@ import { TreeNodeProps } from '../TreeNode';
 import { BasicDataNode, DataEntity, DataNode, EventDataNode, FieldNames, FlattenNode, GetKey, Key } from '../typings';
 export declare function getKey(key: Key, pos: string): Key;
 export declare function fillFieldNames(fieldNames?: FieldNames): Required<FieldNames>;
+/**
+ * Warning if TreeNode do not provides key
+ */
 export declare function warningWithoutKey(treeData: DataNode[], fieldNames: FieldNames): void;
+/**
+ * Convert `children` of Tree into `treeData` structure.
+ */
 export declare function convertTreeToData<T = DataNode>(rootNodes: React.ReactElement): T[];
+/**
+ * Flat nest tree data into flatten list. This is used for virtual list render.
+ * @param treeNodeList Origin data node list
+ * @param expandedKeys
+ * need expanded keys, provides `true` means all expanded (used in `rc-tree-select`).
+ */
 export declare function flattenTreeData(treeNodeList: DataNode[], expandedKeys: Key[] | true, fieldNames: FieldNames): FlattenNode[];
 type ExternalGetKey = GetKey<DataNode> | string;
 interface TraverseDataNodesConfig {
@@ -12,6 +24,10 @@ interface TraverseDataNodesConfig {
     externalGetKey?: ExternalGetKey;
     fieldNames?: FieldNames;
 }
+/**
+ * Traverse all the data by `treeData`.
+ * Please not use it out of the `rc-tree` since we may refactor this code.
+ */
 export declare function traverseDataNodes<T = DataNode>(dataNodes: T[], callback: (data: {
     node: T;
     index: number;
@@ -25,6 +41,9 @@ interface Wrapper {
     posEntities: Record<string, DataEntity>;
     keyEntities: Record<Key, DataEntity>;
 }
+/**
+ * Convert `treeData` into entity records.
+ */
 export declare function convertDataToEntities<T = DataNode>(dataNodes: T[], { initWrapper, processEntity, onProcessFinished, externalGetKey, childrenPropName, fieldNames, }?: {
     initWrapper?: (wrapper: Wrapper) => Wrapper;
     processEntity?: (entity: DataEntity, wrapper: Wrapper) => void;
@@ -32,7 +51,9 @@ export declare function convertDataToEntities<T = DataNode>(dataNodes: T[], { in
     externalGetKey?: ExternalGetKey;
     childrenPropName?: string;
     fieldNames?: FieldNames;
-}, legacyExternalGetKey?: ExternalGetKey): {
+}, 
+/** @deprecated Use `config.externalGetKey` instead */
+legacyExternalGetKey?: ExternalGetKey): {
     posEntities: {};
     keyEntities: {};
 };
@@ -47,6 +68,9 @@ export interface TreeNodeRequiredProps<TreeDataType extends BasicDataNode = Data
     dropPosition: number;
     keyEntities: Record<Key, DataEntity<TreeDataType>>;
 }
+/**
+ * Get TreeNode props with Tree props.
+ */
 export declare function getTreeNodeProps<TreeDataType extends BasicDataNode = DataNode>(key: Key, { expandedKeys, selectedKeys, loadedKeys, loadingKeys, checkedKeys, halfCheckedKeys, dragOverNodeKey, dropPosition, keyEntities }: TreeNodeRequiredProps<TreeDataType>): {
     eventKey: Key;
     expanded: boolean;

package/dist/TreeSelect/TreeSelect.js

@@ -51,6 +51,20 @@ var import_Util = require("../Util");
 var import_hooks = require("../hooks");
 var import_Utils = require("./Utils");
 function InternalTreeSelect(props, ref) {
+  props = {
+    clearable: true,
+    collapseTags: true,
+    checkStrictly: true,
+    disabled: false,
+    selectable: true,
+    filterable: true,
+    placeholder: "请选择",
+    noDataText: "无数据",
+    loadingText: /* @__PURE__ */ import_react.default.createElement("span", null, /* @__PURE__ */ import_react.default.createElement(import_Icon.Icon, { prefix: "fas", name: "spinner", spin: true }), " 加载中..."),
+    fieldNames: { title: "title", key: "key", children: "children" },
+    onBeforeClick: () => true,
+    ...props
+  };
   const {
     placeholder,
     clearable,
@@ -504,18 +518,5 @@ function InternalTreeSelect(props, ref) {
 }
 var ForwardTreeSelect = (0, import_react.forwardRef)(InternalTreeSelect);
 var TreeSelect = ForwardTreeSelect;
-TreeSelect.defaultProps = {
-  clearable: true,
-  collapseTags: true,
-  checkStrictly: true,
-  disabled: false,
-  selectable: true,
-  filterable: true,
-  placeholder: "请选择",
-  noDataText: "无数据",
-  loadingText: /* @__PURE__ */ import_react.default.createElement("span", null, /* @__PURE__ */ import_react.default.createElement(import_Icon.Icon, { prefix: "fas", name: "spinner", spin: true }), " 加载中..."),
-  fieldNames: { title: "title", key: "key", children: "children" },
-  onBeforeClick: () => true
-};
 TreeSelect.displayName = "TreeSelect";
 var TreeSelect_default = TreeSelect;

package/dist/TreeSelect/Utils.d.ts

@@ -1,2 +1,3 @@
 import { DataNode } from '../Tree';
+/** 单选不可选父级 */
 export declare const parentNotSelectable: (treeData?: DataNode[]) => DataNode<any>[];

package/dist/TreeSelect/typings.d.ts

@@ -16,25 +16,44 @@ export type TreeSelectRef = {
     setVisible: (value: boolean) => void;
 };
 export interface TreeSelectProps<T = DataNode, V = ValueType> extends Omit<FormControlBaseProps<V>, 'onChange'>, Omit<TreeProps<T>, 'children' | 'style'>, Omit<BaseProps, 'children'>, NativeProps, AnimationEventProps {
+    /** 表单提交给后台表示节点名称的name */
     labelName?: string;
+    /** 是否可以清空选项 */
     clearable?: boolean;
+    /** 占位符 */
     placeholder?: string;
     filterable?: boolean;
+    /** 选择任意级别 */
     checkStrictly?: boolean;
+    /** 多选时是否将选中值按文字的形式展示 */
     collapseTags?: boolean;
+    /** 是否纯文本模式，即无边框 */
     plain?: boolean;
+    /**  */
     required?: boolean;
+    /** 下拉项最大宽度 */
     maxWidth?: number;
+    /** 表单校验错误提示 */
     error?: boolean;
+    /** 表单校验警告提示 */
     warning?: boolean;
+    /** 表是否加载中 */
     loading?: boolean;
+    /** 输入框前置内容，只对 type="text" 有效 */
     prepend?: React.ReactElement<any> | string | number;
+    /** 输入框后置内容，只对 type="text" 有效 */
     append?: React.ReactElement | string | number;
+    /** 选项为空时显示的文字 */
     noDataText?: React.ReactElement | string;
+    /** 远程加载时显示的文字 */
     loadingText?: React.ReactElement | string;
+    /** 点击节点前的回调，返回true触发onClick事件和onSelect事件 */
     onBeforeClick?: (node: T, event: React.MouseEvent<any>) => boolean;
+    /** 点击节点事件 */
     onClickNode?: (node: T, event: React.MouseEvent<any>) => boolean;
+    /** 选中值发生变化时触发 */
     onChange?: (value: ValueType | Key[], label?: string | string[]) => void;
+    /** 数据加载成功时调用 */
     onLoadSuccess?: (value: ValueType | Key[], label?: string[]) => void;
 }
 export type SelectInfo<T> = {

package/dist/Upload/Upload.js

@@ -41,6 +41,15 @@ var import_UploadList = __toESM(require("./UploadList"));
 var import_use_handlers = require("./use-handlers");
 var Upload = (0, import_react.memo)(
   (0, import_react.forwardRef)((props, ref) => {
+    props = {
+      action: "#",
+      method: "post",
+      name: "file",
+      showFileList: true,
+      listType: "text",
+      autoUpload: true,
+      ...props
+    };
     const { listType, accept, onPreview, showFileList, formatter, trigger, tip } = props;
     const uploadRef = (0, import_react.useRef)(null);
     const disabled = (0, import_hooks.useDisabled)(props.disabled);
@@ -97,13 +106,5 @@ var Upload = (0, import_react.memo)(
     )));
   })
 );
-Upload.defaultProps = {
-  action: "#",
-  method: "post",
-  name: "file",
-  showFileList: true,
-  listType: "text",
-  autoUpload: true
-};
 Upload.displayName = "ElUpload";
 var Upload_default = Upload;

package/dist/Upload/UploadList.js

@@ -42,13 +42,14 @@ var UploadList = (props) => {
   const { listType, files = [], handlePreview, onRemove, formatter, append } = props;
   const { b, bm, be, is } = (0, import_hooks.useClassNames)("upload");
   const disabled = (0, import_hooks.useDisabled)(props.disabled);
+  const nodeRef = (0, import_react.useRef)(null);
   const handleRemove = (0, import_react.useCallback)(
     (file) => {
       onRemove == null ? void 0 : onRemove(file);
     },
     [onRemove]
   );
-  return /* @__PURE__ */ import_react.default.createElement("ul", { className: (0, import_classnames.default)(b`list`, bm("list", listType), is({ disabled })) }, files.map((file, i) => /* @__PURE__ */ import_react.default.createElement(import_Transition.Transition, { key: `tr_${file.uid || file.name}${i}`, name: b("list", false), visible: true, transitionAppear: true, unmountOnExit: true, display: "" }, /* @__PURE__ */ import_react.default.createElement("li", { key: `${file.uid || file.name}${i}`, className: (0, import_classnames.default)(
+  return /* @__PURE__ */ import_react.default.createElement("ul", { className: (0, import_classnames.default)(b`list`, bm("list", listType), is({ disabled })) }, files.map((file, i) => /* @__PURE__ */ import_react.default.createElement(import_Transition.Transition, { nodeRef, key: `tr_${file.uid || file.name}${i}`, name: b("list", false), visible: true, transitionAppear: true, unmountOnExit: true, display: "" }, /* @__PURE__ */ import_react.default.createElement("li", { ref: nodeRef, key: `${file.uid || file.name}${i}`, className: (0, import_classnames.default)(
     be("list", "item"),
     is(file.status)
     /* , { focusing } */

package/dist/Upload/typings.d.ts

@@ -1,38 +1,64 @@
 import React from 'react';
 import { BaseProps, NativeProps } from '../types/common';
 export interface UploadBaseProps {
+    /** 请求 URL */
     action: string;
+    /** 设置上传的请求头部 */
     headers?: Headers | Record<string, any>;
+    /** 设置上传请求方法 */
     method?: 'post' | 'get';
+    /** 是否支持多选文件 */
     multiple?: boolean;
+    /** 上传时附带的额外参数 */
     data?: Record<string, any> | ((rawFile: UploadRawFile) => Promise<Record<string, any>>) | ((rawFile: UploadRawFile) => Record<string, any>);
+    /** 上传的文件字段名 */
     name?: string;
+    /** 是否启用拖拽上传 */
     drag?: boolean;
+    /** 支持发送 cookie 凭证信息 */
     withCredentials?: boolean;
+    /** 是否显示已上传文件列表 */
     showFileList?: boolean;
+    /** 接受上传的文件类型 */
     accept?: string;
     type?: string;
+    /** 默认上传文件 */
     fileList?: UploadUserFile[];
+    /** 文件列表的类型 */
     listType?: 'text' | 'picture' | 'picture-card';
+    /** 是否自动上传文件 */
     autoUpload?: boolean;
+    /** 覆盖默认的 Xhr 行为，允许自行实现上传文件的请求 */
     httpRequest?: (options: UploadRequestOptions) => XMLHttpRequest | Promise<unknown>;
+    /** 是否禁用上传 */
     disabled?: boolean;
+    /** 允许上传文件的最大数量 */
     limit?: number;
 }
 export interface UploadHooks {
+    /** 上传文件之前的钩子，参数为上传的文件， 若返回false或者返回 Promise 且被 reject，则停止上传。 */
     beforeUpload?: (rawFile: UploadRawFile) => Awaitable<void | undefined | null | boolean | File | Blob>;
+    /** 删除文件之前的钩子，参数为上传的文件和文件列表， 若返回 false 或者返回 Promise 且被 reject，则停止删除。 */
     beforeRemove?: (uploadFile: UploadFile, uploadFiles: UploadFiles) => Awaitable<boolean>;
+    /** 文件列表移除文件时的钩子 */
     onRemove?: (uploadFile: UploadFile, uploadFiles: UploadFiles) => void;
+    /** 文件状态改变时的钩子，添加文件、上传成功和上传失败时都会被调用 */
     onChange?: (uploadFile: UploadFile, uploadFiles: UploadFiles) => void;
+    /** 点击文件列表中已上传的文件时的钩子 */
     onPreview?: (uploadFile: UploadFile) => void;
+    /** 文件上传成功时的钩子 */
     onSuccess?: (response: any, uploadFile: UploadFile, uploadFiles: UploadFiles) => void;
+    /** 文件上传时的钩子 */
     onProgress?: (evt: UploadProgressEvent, uploadFile: UploadFile, uploadFiles: UploadFiles) => void;
+    /** 文件上传失败时的钩子 */
     onError?: (error: Error, uploadFile: UploadFile, uploadFiles: UploadFiles) => void;
+    /** 当超出限制时，执行的钩子函数 */
     onExceed?: (files: File[], uploadFiles: UploadUserFile[]) => void;
 }
 export interface UploadContentProps extends UploadBaseProps, BaseProps {
     beforeUpload?: UploadHooks['beforeUpload'];
     onRemove?: (file: UploadFile | UploadRawFile) => void;
+    /** 手动选择文件 */
     onStart?: (rawFile: UploadRawFile) => void;
     onSuccess?: (response: any, rawFile: UploadRawFile) => unknown;
     onProgress?: (evt: UploadProgressEvent, rawFile: UploadRawFile) => void;
@@ -44,15 +70,23 @@ export interface UploadContentRef {
     upload: (rawFile: UploadRawFile) => Promise<void>;
 }
 export interface UploadRef {
+    /** 取消上传请求 */
     abort: (file?: UploadFile) => void;
+    /** 手动上传文件列表 */
     submit: () => void;
+    /** 清空已上传的文件列表（该方法不支持在 before-upload 中调用） */
     clearFiles: (status?: Array<'ready' | 'uploading' | 'success' | 'fail'>) => void;
+    /** 手动选择文件 */
     handleStart: (rawFile: UploadRawFile) => void;
+    /** 手动移除文件。 file 和rawFile 已被合并。 rawFile 将在 v2.2.0 中移除 */
     handleRemove: (file: UploadFile | UploadRawFile) => void;
 }
 export interface UploadProps extends UploadBaseProps, UploadHooks, BaseProps, NativeProps {
+    /** 缩略图模板的内容 */
     formatter?: (file: UploadFile) => React.ReactElement;
+    /** 触发文件选择框的内容 */
     trigger?: React.ReactElement;
+    /** 提示说明文字 */
     tip?: React.ReactElement;
 }
 export interface UploadListProps {

package/dist/Upload/use-handlers.d.ts

@@ -3,6 +3,7 @@ import { UploadContentRef, UploadFile, UploadFiles, UploadProps, UploadRawFile,
 export declare const useHandlers: (props: Omit<UploadProps, 'fileList'> & {
     fileList: UploadFiles;
 }, uploadRef: RefObject<UploadContentRef | undefined>) => {
+    /** @description two-way binding ref from props `fileList` */
     uploadFiles: UploadFiles;
     setUploadFiles: (value: UploadFiles) => void;
     abort: (file: UploadFile) => void;

package/dist/Upload/use-handlers.js

@@ -43,7 +43,7 @@ var revokeObjectURL = (file) => {
   }
 };
 var useHandlers = (props, uploadRef) => {
-  const { fileList, listType, onError, onChange, onProgress, onSuccess, beforeRemove, onRemove } = props;
+  const { fileList, listType = "text", onError, onChange, onProgress, onSuccess, beforeRemove, onRemove } = props;
   const uploadFilesRef = (0, import_react.useRef)();
   const [uploadFiles, setUploadFiles, isControlled] = (0, import_hooks.useControlled)(fileList, []);
   const { forceUpdate } = (0, import_hooks.useForceUpdate)();

package/dist/Util/Math.d.ts

@@ -1,5 +1,39 @@
+/**
+ * 乘法 - js运算精度丢失问题
+ * @param arg1  数1
+ * @param arg2  数2
+ * 0.0023 * 100 ==> 0.22999999999999998
+ * {{ 0.0023 | multiply(100) }} ==> 0.23
+ */
 export declare function floatMultiply(arg1: number | string, arg2: number | string): number;
+/**
+ * 除法 - js运算精度丢失问题
+ * @param arg1  数1
+ * @param arg2  数2
+ * 0.0023 / 0.00001 ==> 229.99999999999997
+ * {{ 0.0023 | divide(0.00001) }} ==> 230
+ */
 export declare function floatDivide(arg1: number | string, arg2: number | string): number;
+/**
+ * 加法 - js运算精度丢失问题
+ * @param arg1  数1
+ * @param arg2  数2
+ * 0.0023 + 0.00000000000001 ==> 0.0023000000000099998
+ * {{ 0.0023 | plus(0.00000000000001) }} ==> 0.00230000000001
+ */
 export declare function floatAdd(arg1: string | number, arg2: string | number): number;
+/**
+ * 减法 - js运算精度丢失问题
+ * @param arg1  数1
+ * @param arg2  数2
+ * 0.0023 - 0.00000011  ==>  0.0022998899999999997
+ * {{ 0.0023 | minus( 0.00000011 ) }}  ==>  0.00229989
+ */
 export declare function floatSub(arg1: string | number, arg2: string | number): number;
+/**
+ * 格式化数字，带精度
+ * @param value 数字
+ * @param precision 精度
+ * @returns
+ */
 export declare const formatNumber: (value: number, precision: number) => string;

package/dist/Util/base.d.ts

@@ -1,8 +1,29 @@
+/**
+ * 判断对象是否为空
+ * @param {Object} val 被判断的对象
+ * @returns {Boolean} 返回true或false
+ */
 export declare function isEmpty(val: any): boolean;
+/**
+ * 判断对象是否不为空
+ * @param {Object} val 被判断的对象
+ * @returns  {Boolean} 返回true或false
+ */
 export declare function isNotEmpty(val: any): boolean;
+/**
+ * 随机序列，包含数字和字母
+ * @param {Number} n 序列的个数
+ * @returns {String} 返回序列
+ */
 export declare function randomCode(n: number): string;
 export declare function getScrollWidth(elem: HTMLElement): number;
 export declare function warning(valid: boolean, message: string): void;
+/**
+ * 创建隐形表单下载方法
+ * @param url 下载地址
+ * @param params 参数列表
+ * @param pther method：请求方式，target：是否新窗口
+ */
 export declare const download: (url: string, params: {
     name: string;
     value: string;
@@ -17,3 +38,4 @@ export declare const isNumber: (val: any) => val is number;
 export declare const isString: (val: any) => boolean;
 export declare const isStringNumber: (val: string) => boolean;
 export declare function addUnit(value?: string | number, defaultUnit?: string): string;
+export declare function mergeDefaultProps<T extends object>(defaultProps: Partial<T>, props: T): T;

package/dist/Util/base.js

@@ -40,6 +40,7 @@ __export(base_exports, {
   isString: () => isString,
   isStringNumber: () => isStringNumber,
   isUndefined: () => isUndefined,
+  mergeDefaultProps: () => mergeDefaultProps,
   randomCode: () => randomCode,
   warning: () => warning
 });
@@ -203,6 +204,9 @@ function addUnit(value, defaultUnit = "px") {
     return value;
   }
 }
+function mergeDefaultProps(defaultProps = {}, props) {
+  return { ...defaultProps, ...props ?? {} };
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   addUnit,
@@ -216,6 +220,7 @@ function addUnit(value, defaultUnit = "px") {
   isString,
   isStringNumber,
   isUndefined,
+  mergeDefaultProps,
   randomCode,
   warning
 });

package/dist/Util/shallowEqual.d.ts

@@ -1,2 +1,13 @@
+/**
+ * From: https://github.com/facebook/fbjs/blob/master/packages/fbjs/src/core/shallowEqual.js
+ * @providesModule shallowEqual
+ * @typechecks
+ * @flow
+ */
+/**
+ * Performs equality by iterating through keys on an object and returning false
+ * when any key has values which are not strictly equal between the arguments.
+ * Returns true when the values of all keys are strictly equal.
+ */
 declare function shallowEqual(objA: any, objB: any): boolean;
 export default shallowEqual;

package/dist/Util/treeUtils.d.ts

@@ -3,5 +3,13 @@ interface FieldNames {
     parentIdKey?: string;
     childrenKey?: string;
 }
+/**
+ * 非递归实现
+ * 每一项都有parentId，根元素
+ * @param list
+ * @param rootId 根元素id
+ * @param param2 可配晋参数
+ * @returns
+ */
 export declare const generateTree: <T>(list: T[], rootId: string | number, { idKey, parentIdKey, childrenKey }?: FieldNames) => T[];
 export {};

package/dist/VirtualList/Filler.d.ts

@@ -2,10 +2,15 @@ import React from 'react';
 import { ComponentChildren } from '../types/common';
 interface FillerProps {
     prefixCls?: string;
+    /** Virtual filler height. Should be `count * itemMinHeight` */
     height: number;
+    /** Set offset of visible items. Should be the top of start item position */
     offset?: number;
     children: ComponentChildren;
     onInnerResize?: () => void;
 }
+/**
+ * Fill component to provided the scroll content real height.
+ */
 declare const Filler: React.ForwardRefExoticComponent<FillerProps & React.RefAttributes<HTMLDivElement>>;
 export default Filler;

package/dist/VirtualList/VirtualList.d.ts

@@ -21,11 +21,14 @@ export interface ListProps<T = any> extends Omit<React.AllHTMLAttributes<any>, '
     height?: number;
     itemHeight?: number;
     style?: React.CSSProperties;
+    /** If not match virtual scroll condition, Set List still use height of container. */
     fullHeight?: boolean;
     itemKey: Key | ((item: T) => Key);
     component?: string | FC<any> | ComponentClass<any>;
+    /** Set `false` will always use real scroll instead of virtual one */
     virtual?: boolean;
     onScroll?: React.UIEventHandler<HTMLElement>;
+    /** Trigger when render list item changed */
     onVisibleChange?: (visibleList: T[], fullList: T[]) => void;
 }
 export declare function RawList<T>(props: ListProps<T>, ref: Ref<ListRef>): React.JSX.Element;

package/dist/VirtualList/hooks/useLayoutEffect.d.ts

@@ -1,3 +1,6 @@
 import { useEffect } from 'react';
+/**
+ * Wrap `useLayoutEffect` which will not throw warning message in test env
+ */
 declare const useLayoutEffect: typeof useEffect;
 export default useLayoutEffect;

package/dist/VirtualList/utils/algorithmUtil.d.ts

@@ -1,5 +1,22 @@
 import { Key } from 'react';
+/**
+ * Get index with specific start index one by one. e.g.
+ * min: 3, max: 9, start: 6
+ *
+ * Return index is:
+ * [0]: 6
+ * [1]: 7
+ * [2]: 5
+ * [3]: 8
+ * [4]: 4
+ * [5]: 9
+ * [6]: 3
+ */
 export declare function getIndexByStartLoc(min: number, max: number, start: number, index: number): number;
+/**
+ * We assume that 2 list has only 1 item diff and others keeping the order.
+ * So we can use dichotomy algorithm to find changed one.
+ */
 export declare function findListDiffIndex<T>(originList: T[], targetList: T[], getKey: (item: T) => Key): {
     index: number;
     multiple: boolean;

package/dist/VirtualList/utils/findDOMNode.d.ts

@@ -1,2 +1,5 @@
 import React from 'react';
+/**
+ * Return if a node is a DOM node. Else will return by `findDOMNode`
+ */
 export default function findDOMNode<T = Element | Text>(node: React.ReactElement | HTMLElement): T;

package/dist/hooks/animationPropsUtils.d.ts

@@ -1,3 +1,15 @@
 import { TransitionProps } from '../Transition';
 export declare const animationAllProps: string[];
+/**
+ * Returns an array of objects consisting of: props of html input element and rest.
+ * @author	Parker
+ * @CreateTime	2022/4/8 17:46:40
+ * @LastEditor	Parker
+ * @ModifyTime	2022/4/22 15:38:45
+ * @param {object} props A ReactElement props object
+ * @param {Object} [options={}]
+ * @param {Array} [options.htmlProps] An array of html input props
+ * @param {boolean} [options.includeAria] Includes all input props that starts with "aria-"
+ * @returns {[{}, {}]} An array of objects
+ */
 export declare const partitionAnimationProps: (props: any, options?: any) => [TransitionProps, any];

package/dist/hooks/htmlPropsUtils.d.ts

@@ -2,4 +2,12 @@ import React from 'react';
 export declare const htmlInputAttrs: string[];
 export declare const htmlInputEvents: string[];
 export declare const htmlInputProps: string[];
+/**
+ * Returns an array of objects consisting of: props of html input element and rest.
+ * @param {object} props A ReactElement props object
+ * @param {Object} [options={}]
+ * @param {Array} [options.htmlProps] An array of html input props
+ * @param {boolean} [options.includeAria] Includes all input props that starts with "aria-"
+ * @returns {[{}, {}]} An array of objects
+ */
 export declare const partitionHTMLProps: (props: any, options?: any) => [React.AllHTMLAttributes<any>, any];

package/dist/hooks/popperPropsUtils.d.ts

@@ -1,3 +1,15 @@
 import { PopperProps } from '../Popper';
 export declare const popperAllProps: string[];
+/**
+ * Returns an array of objects consisting of: props of html input element and rest.
+ * @author	Parker
+ * @CreateTime	2022/4/8 17:46:40
+ * @LastEditor	Parker
+ * @ModifyTime	2025/2/22 11:48:08
+ * @param {object} props A ReactElement props object
+ * @param {Object} [options={}]
+ * @param {Array} [options.htmlProps] An array of html input props
+ * @param {boolean} [options.includeAria] Includes all input props that starts with "aria-"
+ * @returns {[{}, {}]} An array of objects
+ */
 export declare const partitionPopperPropsUtils: (props: any, options?: any) => [Partial<PopperProps>, any];

package/dist/hooks/treePropsUtils.d.ts

@@ -1,3 +1,15 @@
 import { DirectoryTreeProps } from '../Tree';
 export declare const treeAllProps: string[];
+/**
+ * Returns an array of objects consisting of: props of html input element and rest.
+ * @author	Parker
+ * @CreateTime	2022/4/8 17:46:40
+ * @LastEditor	Parker
+ * @ModifyTime	2022/4/21 10:06:19
+ * @param {object} props A ReactElement props object
+ * @param {Object} [options={}]
+ * @param {Array} [options.htmlProps] An array of html input props
+ * @param {boolean} [options.includeAria] Includes all input props that starts with "aria-"
+ * @returns {[{}, {}]} An array of objects
+ */
 export declare const partitionTreePropsUtils: (props: any, options?: any) => [DirectoryTreeProps<any>, any];

package/dist/hooks/useChildrenInstance.d.ts

@@ -1,4 +1,15 @@
 import React from 'react';
 import { ComponentChildren } from '../types/common';
+/**
+ * 获取特定名称的子组件
+ * @author	Parker
+ * @CreateTime	2022/3/30下午2:08:36
+ * @LastEditor	Parker
+ * @ModifyTime	2022/9/23 14:44:20
+ * @param componentChildren 子组件
+ * @param compName 目标组件名称 （`displayName`属性）
+ * @param virtualCompName 子组件中的需要继续乡下递归查找的组件名称（`displayName`属性）
+ * @returns 返回获取组件的函数以供随时调用
+ */
 declare function useChildrenInstance<T, S = T>(compName: string | string[], ...virtualCompName: string[]): (componentChildren: ComponentChildren) => React.ReactElement<S>[];
 export default useChildrenInstance;