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

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

@@ -1,110 +1,436 @@
+/**
+ * @ignore
+ * some key-codes definition and utils from closure-library
+ * @author yiminghe@gmail.com
+ */
 declare const KeyCode: {
+    /**
+     * MAC_ENTER
+     */
     MAC_ENTER: number;
+    /**
+     * BACKSPACE
+     */
     BACKSPACE: number;
+    /**
+     * TAB
+     */
     TAB: number;
+    /**
+     * NUMLOCK on FF/Safari Mac
+     */
     NUM_CENTER: number;
+    /**
+     * ENTER
+     */
     ENTER: number;
+    /**
+     * SHIFT
+     */
     SHIFT: number;
+    /**
+     * CTRL
+     */
     CTRL: number;
+    /**
+     * ALT
+     */
     ALT: number;
+    /**
+     * PAUSE
+     */
     PAUSE: number;
+    /**
+     * CAPS_LOCK
+     */
     CAPS_LOCK: number;
+    /**
+     * ESC
+     */
     ESC: number;
+    /**
+     * SPACE
+     */
     SPACE: number;
+    /**
+     * PAGE_UP
+     */
     PAGE_UP: number;
+    /**
+     * PAGE_DOWN
+     */
     PAGE_DOWN: number;
+    /**
+     * END
+     */
     END: number;
+    /**
+     * HOME
+     */
     HOME: number;
+    /**
+     * LEFT
+     */
     LEFT: number;
+    /**
+     * UP
+     */
     UP: number;
+    /**
+     * RIGHT
+     */
     RIGHT: number;
+    /**
+     * DOWN
+     */
     DOWN: number;
+    /**
+     * PRINT_SCREEN
+     */
     PRINT_SCREEN: number;
+    /**
+     * INSERT
+     */
     INSERT: number;
+    /**
+     * DELETE
+     */
     DELETE: number;
+    /**
+     * ZERO
+     */
     ZERO: number;
+    /**
+     * ONE
+     */
     ONE: number;
+    /**
+     * TWO
+     */
     TWO: number;
+    /**
+     * THREE
+     */
     THREE: number;
+    /**
+     * FOUR
+     */
     FOUR: number;
+    /**
+     * FIVE
+     */
     FIVE: number;
+    /**
+     * SIX
+     */
     SIX: number;
+    /**
+     * SEVEN
+     */
     SEVEN: number;
+    /**
+     * EIGHT
+     */
     EIGHT: number;
+    /**
+     * NINE
+     */
     NINE: number;
+    /**
+     * QUESTION_MARK
+     */
     QUESTION_MARK: number;
+    /**
+     * A
+     */
     A: number;
+    /**
+     * B
+     */
     B: number;
+    /**
+     * C
+     */
     C: number;
+    /**
+     * D
+     */
     D: number;
+    /**
+     * E
+     */
     E: number;
+    /**
+     * F
+     */
     F: number;
+    /**
+     * G
+     */
     G: number;
+    /**
+     * H
+     */
     H: number;
+    /**
+     * I
+     */
     I: number;
+    /**
+     * J
+     */
     J: number;
+    /**
+     * K
+     */
     K: number;
+    /**
+     * L
+     */
     L: number;
+    /**
+     * M
+     */
     M: number;
+    /**
+     * N
+     */
     N: number;
+    /**
+     * O
+     */
     O: number;
+    /**
+     * P
+     */
     P: number;
+    /**
+     * Q
+     */
     Q: number;
+    /**
+     * R
+     */
     R: number;
+    /**
+     * S
+     */
     S: number;
+    /**
+     * T
+     */
     T: number;
+    /**
+     * U
+     */
     U: number;
+    /**
+     * V
+     */
     V: number;
+    /**
+     * W
+     */
     W: number;
+    /**
+     * X
+     */
     X: number;
+    /**
+     * Y
+     */
     Y: number;
+    /**
+     * Z
+     */
     Z: number;
+    /**
+     * META
+     */
     META: number;
+    /**
+     * WIN_KEY_RIGHT
+     */
     WIN_KEY_RIGHT: number;
+    /**
+     * CONTEXT_MENU
+     */
     CONTEXT_MENU: number;
+    /**
+     * NUM_ZERO
+     */
     NUM_ZERO: number;
+    /**
+     * NUM_ONE
+     */
     NUM_ONE: number;
+    /**
+     * NUM_TWO
+     */
     NUM_TWO: number;
+    /**
+     * NUM_THREE
+     */
     NUM_THREE: number;
+    /**
+     * NUM_FOUR
+     */
     NUM_FOUR: number;
+    /**
+     * NUM_FIVE
+     */
     NUM_FIVE: number;
+    /**
+     * NUM_SIX
+     */
     NUM_SIX: number;
+    /**
+     * NUM_SEVEN
+     */
     NUM_SEVEN: number;
+    /**
+     * NUM_EIGHT
+     */
     NUM_EIGHT: number;
+    /**
+     * NUM_NINE
+     */
     NUM_NINE: number;
+    /**
+     * NUM_MULTIPLY
+     */
     NUM_MULTIPLY: number;
+    /**
+     * NUM_PLUS
+     */
     NUM_PLUS: number;
+    /**
+     * NUM_MINUS
+     */
     NUM_MINUS: number;
+    /**
+     * NUM_PERIOD
+     */
     NUM_PERIOD: number;
+    /**
+     * NUM_DIVISION
+     */
     NUM_DIVISION: number;
+    /**
+     * F1
+     */
     F1: number;
+    /**
+     * F2
+     */
     F2: number;
+    /**
+     * F3
+     */
     F3: number;
+    /**
+     * F4
+     */
     F4: number;
+    /**
+     * F5
+     */
     F5: number;
+    /**
+     * F6
+     */
     F6: number;
+    /**
+     * F7
+     */
     F7: number;
+    /**
+     * F8
+     */
     F8: number;
+    /**
+     * F9
+     */
     F9: number;
+    /**
+     * F10
+     */
     F10: number;
+    /**
+     * F11
+     */
     F11: number;
+    /**
+     * F12
+     */
     F12: number;
+    /**
+     * NUMLOCK
+     */
     NUMLOCK: number;
+    /**
+     * SEMICOLON
+     */
     SEMICOLON: number;
+    /**
+     * DASH
+     */
     DASH: number;
+    /**
+     * EQUALS
+     */
     EQUALS: number;
+    /**
+     * COMMA
+     */
     COMMA: number;
+    /**
+     * PERIOD
+     */
     PERIOD: number;
+    /**
+     * SLASH
+     */
     SLASH: number;
+    /**
+     * APOSTROPHE
+     */
     APOSTROPHE: number;
+    /**
+     * SINGLE_QUOTE
+     */
     SINGLE_QUOTE: number;
+    /**
+     * OPEN_SQUARE_BRACKET
+     */
     OPEN_SQUARE_BRACKET: number;
+    /**
+     * BACKSLASH
+     */
     BACKSLASH: number;
+    /**
+     * CLOSE_SQUARE_BRACKET
+     */
     CLOSE_SQUARE_BRACKET: number;
+    /**
+     * WIN_KEY
+     */
     WIN_KEY: number;
+    /**
+     * MAC_FF_META
+     */
     MAC_FF_META: number;
+    /**
+     * WIN_IME
+     */
     WIN_IME: number;
+    /**
+     * whether text and modified key is entered at the same time.
+     */
     isTextModifyingKeyEvent: (e: KeyboardEvent) => boolean;
+    /**
+     * whether character is entered.
+     */
     isCharacterKey: (keyCode: number) => boolean;
 };
 export default KeyCode;

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

@@ -4,6 +4,12 @@ interface ConductReturnType {
     halfCheckedKeys: Key[];
 }
 export declare function isCheckDisabled<TreeDataType>(node: TreeDataType): boolean;
+/**
+ * Conduct with keys.
+ * @param keyList current key list
+ * @param keyEntities key - dataEntity map
+ * @param mode `fill` to fill missing key, `clean` to remove useless key
+ */
 export declare function conductCheck<TreeDataType extends BasicDataNode = DataNode>(keyList: Key[], checked: true | {
     checked: false;
     halfCheckedKeys: Key[];

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

@@ -1,4 +1,5 @@
 import { DataNode, Key } from '../typings';
+/** 计算选中范围，只考虑expanded情况以优化性能 */
 export declare function calcRangeKeys<T = DataNode>({ treeData, expandedKeys, startKey, endKey }: {
     treeData: T[];
     expandedKeys: Key[];

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

@@ -3,4 +3,9 @@ export interface PickConfig {
     data?: boolean;
     attr?: boolean;
 }
+/**
+ * Picker props from exist props with filter
+ * @param props Passed props
+ * @param ariaOnly boolean | { aria?: boolean; data?: boolean; attr?: boolean; } filter config
+ */
 export default function pickAttrs(props: object, ariaOnly?: boolean | PickConfig): {};

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/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/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;