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

package/dist/Tree/Tree.d.ts

@@ -84,25 +84,40 @@ export interface TreeProps<T> extends Omit<RcTreeProps<T>, 'prefixCls' | 'showLi
         showLeafIcon: boolean;
     };
     className?: string;
+    /** 是否支持多选 */
     multiple?: boolean;
+    /** 是否自动展开父节点 */
     autoExpandParent?: boolean;
+    /** Checkable状态下节点选择完全受控（父子节点选中状态不再关联） */
     checkStrictly?: boolean;
+    /** 是否支持选中 */
     checkable?: boolean;
+    /** 是否禁用树 */
     disabled?: boolean;
+    /** 默认展开所有树节点 */
     defaultExpandAll?: boolean;
+    /** 默认展开对应树节点 */
     defaultExpandParent?: boolean;
+    /** 默认展开指定的树节点 */
     defaultExpandedKeys?: Key[];
+    /** （受控）展开指定的树节点 */
     expandedKeys?: Key[];
+    /** （受控）选中复选框的树节点 */
     checkedKeys?: Key[] | {
         checked: Key[];
         halfChecked: Key[];
     };
+    /** 默认选中复选框的树节点 */
     defaultCheckedKeys?: Key[];
+    /** （受控）设置选中的树节点 */
     selectedKeys?: Key[];
+    /** 默认选中的树节点 */
     defaultSelectedKeys?: Key[];
     selectable?: boolean;
+    /** 点击树节点触发 */
     filterAntTreeNode?: (node: AntTreeNode) => boolean;
     loadedKeys?: Key[];
+    /** 设置节点可拖拽（IE>8） */
     draggable?: DraggableFn | boolean | DraggableConfig;
     style?: React.CSSProperties;
     showIcon?: boolean;

package/dist/Tree/TreeNode.d.ts

@@ -18,16 +18,23 @@ export interface TreeNodeProps<TreeDataType extends BasicDataNode = DataNode> {
     dragOverGapBottom?: boolean;
     pos?: string;
     domRef?: Ref<HTMLDivElement>;
+    /** New added in Tree for easy data access */
     data?: TreeDataType;
     isStart?: boolean[];
     isEnd?: boolean[];
     active?: boolean;
     onMouseMove?: React.MouseEventHandler<HTMLDivElement>;
+    /** 设置为叶子节点 (设置了 loadData 时有效)。为 false 时会强制将其作为父节点 */
     isLeaf?: boolean;
+    /** 当树为 checkable 时，设置独立节点是否展示 Checkbox */
     checkable?: boolean;
+    /** 设置节点是否可被选中 */
     selectable?: boolean;
+    /** 禁掉响应 */
     disabled?: boolean;
+    /** 禁掉 checkbox */
     disableCheckbox?: boolean;
+    /** 自定义图标。可接收组件，props 为当前节点 props */
     icon?: IconType;
     switcherIcon?: IconType;
     children?: React.ReactElement;

package/dist/Tree/contextTypes.d.ts

@@ -1,4 +1,8 @@
 import React, { Context } from 'react';
+/**
+ * Webpack has bug for import loop, which is not the same behavior as ES module.
+ * When util.js imports the TreeNode for tree generate will cause treeContextTypes be empty.
+ */
 import { DraggableConfig } from './RCTree';
 import { BasicDataNode, DataEntity, DataNode, Direction, EventDataNode, IconType, Key, NodeInstance } from './typings';
 export type NodeMouseEventParams = {

package/dist/Tree/typings.d.ts

@@ -2,6 +2,7 @@ import React, { Component } from 'react';
 import { IconName } from '../Icon';
 import { TreeNodeProps } from './TreeNode';
 export { ScrollTo } from '../VirtualList';
+/** For fieldNames, we provides a abstract interface */
 export interface BasicDataNode {
     checkable?: boolean;
     disabled?: boolean;
@@ -10,6 +11,7 @@ export interface BasicDataNode {
     isLeaf?: boolean;
     selectable?: boolean;
     switcherIcon?: IconType;
+    /** Set style of TreeNode. This is not recommend if you don't have any force requirement */
     className?: string;
     style?: React.CSSProperties;
 }
@@ -72,6 +74,7 @@ export type GetCheckDisabled<RecordType> = (record: RecordType) => boolean;
 export type Direction = 'ltr' | 'rtl' | undefined;
 export interface FieldNames {
     title?: string;
+    /** @private Internal usage for `rc-tree-select`, safe to remove if no need */
     _title?: string[];
     key?: string;
     children?: string;

package/dist/Tree/util.d.ts

@@ -26,13 +26,30 @@ export declare function calcDropPosition<TreeDataType extends BasicDataNode = Da
     dragOverNodeKey: Key;
     dropAllowed: boolean;
 };
+/**
+ * Return selectedKeys according with multiple prop
+ * @param selectedKeys
+ * @param props
+ * @returns [string]
+ */
 export declare function calcSelectedKeys(selectedKeys: Key[], props: TreeProps): Key[];
 export declare function convertDataToTree(treeData: DataNode[], processor?: {
     processProps: (prop: DataNode) => any;
 }): NodeElement[];
+/**
+ * Parse `checkedKeys` to { checkedKeys, halfCheckedKeys } style
+ */
 export declare function parseCheckedKeys(keys: Key[] | {
     checked: Key[];
     halfChecked: Key[];
 }): any;
+/**
+ * If user use `autoExpandParent` we should get the list of parent node
+ * @param keyList
+ * @param keyEntities
+ */
 export declare function conductExpandParent(keyList: Key[], keyEntities: Record<Key, DataEntity>): Key[];
+/**
+ * omit prop
+ */
 export declare function omit<T extends object, K extends keyof T>(obj: T, fields: K[]): Omit<T, K>;

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> = {