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

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;

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;

package/dist/hooks/useClassNames.d.ts

@@ -14,16 +14,94 @@ export type ClassNameM = {
     ebm: (sub: string, prefix: string, modifier: string, compName?: boolean) => string;
     is: (...classes: ClassValue[]) => string;
 };
+/**
+ * Add a prefix to all classNames.
+ *
+ * @param str prefix of className
+ * @returns { wb, merge, prefix }
+ *  - wb: A function of combining className and adding a prefix to each className.
+ *    At the same time, the default `classPrefix` is the first className.
+ *  - merge: A merge className function.
+ *  - prefix: Add a prefix to className
+ */
 declare function useClassNames(str: string, classPrefix?: string): {
+    /**
+     * 如果组件前缀是'button':
+     *
+     * wb('red', { active: true }) => 'el-button el-button-red el-button-active'
+     *
+     * wb('red', { active: true }, false) => 'el-button el-red el-active'
+     */
     wb: (...classes: ClassValue[]) => string;
+    /**
+     * 如果组件前缀是'button':
+     *
+     * b('red', { active: true }) => 'el-button-red el-button-active'
+     *
+     * b('red', { active: true }, false) => 'el-red el-active'
+     */
     b: (...classes: ClassValue[]) => string;
+    /**
+     * 如果组件前缀是'button':
+     *
+     * e('red', { active: true }) => 'el-button__red el-button__active'
+     *
+     * e('red', { active: true }, false) => 'r__red r__active'
+     */
     e: (...classes: ClassValue[]) => string;
+    /**
+     * 如果组件前缀是'button':
+     *
+     * m('red', { active: true }) => 'el-button--red el-button--active'
+     *
+     * m('red', { active: true }, false) => 'el--red el--active'
+     */
     m: (...classes: ClassValue[]) => string;
+    /**
+     * 如果组件前缀是'button':
+     *
+     * be('red', 'active') => 'el-button-red__active'
+     *
+     * be('red', 'active', false) => 'el-red__active'
+     */
     be: (prefix: string, sub: string, compName?: boolean) => string;
+    /**
+     * 如果组件前缀是'button':
+     *
+     * em( 'color", 'active') => 'el-button__color--active'
+     *
+     * em( 'color", 'active', false) => 'r__color--active'
+     */
     em: (sub: string, modifier: string, compName?: boolean) => string;
+    /**
+     * 如果组件前缀是'button':
+     *
+     * be( 'color", 'active') => 'el-button-color--active'
+     *
+     * be( 'color", 'active', false) => 'el-color--active'
+     */
     bm: (prefix: string, modifier: string, compName?: boolean) => string;
+    /**
+     * 如果组件前缀是'button':
+     *
+     * bem('red', 'color", 'active') => 'el-button-red__color--active'
+     *
+     * bem('red', 'color", 'active', false) => 'el-red__color--active'
+     */
     bem: (prefix: string, sub: string, modifier: string, compName?: boolean) => string;
+    /**
+     * 如果组件前缀是'button':
+     *
+     * ebm('close', 'icon", 'hidden') => 'el-button__close-icon--hidden'
+     *
+     * ebm('close', 'icon", 'hidden', false) => 'r__close-icon--hidden'
+     */
     ebm: (sub: string, prefix: string, modifier: string, compName?: boolean) => string;
+    /**
+     * 如果组件前缀是'button':
+     *
+     * is('block', { block: true }) => 'is-block'
+     */
     is: (...classes: ClassValue[]) => string;
 };
 export default useClassNames;

package/dist/hooks/useControlled.d.ts

@@ -1,2 +1,10 @@
+/**
+ * A hook for controlled value management.
+ * In the case of passing the controlled value, the controlled value is returned, otherwise the value in state is returned.
+ * Generally used for a component including controlled and uncontrolled modes.
+ * @param controlledValue
+ * @param defaultValue
+ * @param formatValue
+ */
 declare function useControlled<T>(controlledValue: T, defaultValue?: T): [T, (value: T) => void, boolean];
 export default useControlled;

package/dist/hooks/useForceUpdate.d.ts

@@ -1,3 +1,4 @@
+/** 强制刷新 */
 export declare const useForceUpdate: () => {
     forceUpdate: () => void;
 };

package/dist/index.d.ts

@@ -106,5 +106,6 @@ export type { DividerProps } from './Divider';
 export { PopupManager, download, genFileId, generateTree, getScrollWidth, isEmpty, isNotEmpty, randomCode } from './Util';
 export * from './hooks';
 export type { AnimationEventProps, BaseProps, FormControlBaseProps, NativeProps, StandardProps, TooltipBaseProps, TypeAttributes } from './types/common';
+/** 全局配置 */
 export { ConfigProvider } from './ConfigProvider';
 export type { ConfigProviderProps } from './ConfigProvider';

package/dist/theme-chalk/link/index.scss

@@ -1,88 +1,3 @@
-// @use 'sass:map';
-
-// @use '../../Common/styles/mixins/mixins' as *;
-// @use '../../Common/styles/mixins/var' as *;
-// @use '../../Common/styles/mixins/utils' as *;
-// @use '../../Common/styles/common/var' as *;
-
-// @include b(link) {
-//     @include set-component-css-var('link', $link);
-// }
-
-// @include b(link) {
-//     display: inline-flex;
-//     flex-direction: row;
-//     align-items: center;
-//     justify-content: center;
-//     vertical-align: middle;
-//     position: relative;
-//     text-decoration: none;
-//     outline: none;
-//     cursor: pointer;
-//     padding: 0;
-//     font-size: getCssVar('link', 'font-size');
-//     font-weight: getCssVar('link', 'font-weight');
-
-//     color: getCssVar('link', 'text-color');
-
-//     &:hover {
-//         color: getCssVar('link', 'hover-text-color');
-//     }
-
-//     @include when(underline) {
-//         &:hover:after {
-//             content: '';
-//             position: absolute;
-//             left: 0;
-//             right: 0;
-//             height: 0;
-//             bottom: 0;
-//             border-bottom: 1px solid getCssVar('link', 'hover-text-color');
-//         }
-//     }
-
-//     @include when(disabled) {
-//         color: getCssVar('link', 'disabled-text-color');
-//         cursor: not-allowed;
-//     }
-
-//     & [class*='#{$namespace}-icon-'] {
-//         & + span {
-//             margin-left: 5px;
-//         }
-//     }
-
-//     &.#{$namespace}-link--default {
-//         &:after {
-//             border-color: getCssVar('link', 'hover-text-color');
-//         }
-//     }
-
-//     @include e(inner) {
-//         display: inline-flex;
-//         justify-content: center;
-//         align-items: center;
-//     }
-
-//     @each $type in $types {
-//         &.#{$namespace}-link--#{$type} {
-//             @include css-var-from-global(('link', 'text-color'), ('color', $type));
-//             @include css-var-from-global(('link', 'hover-text-color'), ('color', $type, 'light-3'));
-//             @include css-var-from-global(('link', 'disabled-text-color'), ('color', $type, 'light-5'));
-
-//             &:after {
-//                 border-color: getCssVar('link', 'text-color');
-//             }
-
-//             @include when(underline) {
-//                 &:hover:after {
-//                     border-color: getCssVar('link', 'text-color');
-//                 }
-//             }
-//         }
-//     }
-// }
-
 @use '../common/var';
 .#{$namespace}-link {
     --#{$namespace}-link-font-size: 14px;

package/dist/types/common.d.ts

@@ -12,29 +12,49 @@ export declare namespace TypeAttributes {
 export type ComponentChildren = React.ReactNode | React.ReactNode[];
 export interface FormControlBaseProps<ValueType = React.AllHTMLAttributes<HTMLInputElement>['value']> {
     name?: string;
+    /** 初始值 */
     defaultValue?: ValueType;
+    /** 值（可控） */
     value?: ValueType;
+    /** 选中值发生变化时触发 */
     onChange?: (value: ValueType | boolean, event?: React.ChangeEvent<any>) => void;
+    /** 禁用 */
     disabled?: boolean;
+    /** 尺寸 */
     size?: TypeAttributes.Size;
+    /** Render the control as plain text */
+    /** 只读 */
     readOnly?: boolean;
+    /** 样式前缀 */
     classPrefix?: string;
 }
+/** 基础参数 */
 export interface BaseProps<S = ComponentChildren> {
+    /** 组件 CSS 类的前缀 */
     classPrefix?: string;
+    /** 下拉面板自定义内联样式 */
     popperStyle?: React.CSSProperties;
+    /** 子组件 */
     children?: S;
 }
 export type NativeProps<S extends string = never> = {
+    /** 自定义样式 */
     className?: string;
+    /** 自定义内联样式 */
     style?: React.CSSProperties & Partial<Record<S, string>>;
 };
 export interface AnimationEventProps {
+    /** 显示前动画过渡的回调函数 */
     beforeEnter?: (node?: null | HTMLElement | Text) => void;
+    /** 显示中动画过渡的回调函数 */
     onEnter?: (node?: null | HTMLElement | Text) => void;
+    /** 显示后动画过渡的回调函数 */
     afterEnter?: (node?: null | HTMLElement | Text) => void;
+    /** 退出前动画过渡的回调函数 */
     beforeLeave?: (node?: null | HTMLElement | Text) => void;
+    /** 退出中动画过渡的回调函数 */
     onLeave?: (node?: null | HTMLElement | Text) => void;
+    /** 退出后动画过渡的回调函数 */
     afterLeave?: (node?: null | HTMLElement | Text) => void;
 }
 export interface TooltipBaseProps<T extends EventTarget> {
@@ -44,8 +64,12 @@ export interface TooltipBaseProps<T extends EventTarget> {
     onContextMenu?: (event?: React.MouseEvent<T>) => void;
 }
 export interface StandardProps extends React.HTMLAttributes<HTMLElement> {
+    /** The prefix of the component CSS class */
     classPrefix?: string;
+    /** 自定义样式 */
     className?: string;
+    /** 自定义内联样式 */
     style?: React.CSSProperties;
+    /** 子组件 */
     children?: ComponentChildren;
 }

package/dist/types/type.d.ts

@@ -1,4 +1,9 @@
 export declare const tuple: <T extends string[]>(...args: T) => T;
 export declare const tupleNum: <T extends number[]>(...args: T) => T;
+/**
+ * https://stackoverflow.com/a/59187769 Extract the type of an element of an array/tuple without
+ * performing indexing
+ */
 export type ElementOf<T> = T extends (infer E)[] ? E : T extends readonly (infer F)[] ? F : never;
+/** https://github.com/Microsoft/TypeScript/issues/29729 */
 export type LiteralUnion<T extends U, U> = T | (U & {});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qsxy/element-plus-react",
-  "version": "1.0.0-next.2",
+  "version": "1.0.0-next.3",
   "description": "element-plus-react",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",