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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (144) hide show
  1. package/README.md +29 -0
  2. package/dist/Badge/Badge.js +1 -1
  3. package/dist/Badge/typings.d.ts +10 -0
  4. package/dist/Breadcrumb/typings.d.ts +4 -0
  5. package/dist/Button/typings.d.ts +28 -0
  6. package/dist/Calendar/CalendarContext.d.ts +10 -0
  7. package/dist/Calendar/ShortCuts.d.ts +2 -0
  8. package/dist/Calendar/typings.d.ts +18 -0
  9. package/dist/Card/typings.d.ts +4 -0
  10. package/dist/Cascader/CascaderDropdown.d.ts +1 -0
  11. package/dist/Cascader/CascaderMenu.d.ts +7 -0
  12. package/dist/Cascader/typings.d.ts +80 -0
  13. package/dist/Cascader/useCascader.d.ts +72 -0
  14. package/dist/Checkbox/typings.d.ts +11 -0
  15. package/dist/CheckboxGroup/CheckboxGroup.d.ts +4 -0
  16. package/dist/CheckboxGroup/CheckboxGroupContext.d.ts +1 -0
  17. package/dist/Col/typings.d.ts +10 -0
  18. package/dist/Collapse/CollapseContext.d.ts +3 -0
  19. package/dist/Collapse/CollapseItem.js +1 -1
  20. package/dist/Collapse/typings.d.ts +7 -0
  21. package/dist/ColorPicker/AlphaSlider.d.ts +7 -0
  22. package/dist/ColorPicker/HueSlider.d.ts +7 -0
  23. package/dist/ColorPicker/Predefine.d.ts +7 -0
  24. package/dist/ColorPicker/SvPanel.d.ts +7 -0
  25. package/dist/ColorPicker/typings.d.ts +9 -0
  26. package/dist/ConfigProvider/ConfigProvider.d.ts +5 -0
  27. package/dist/DatePicker/typings.d.ts +69 -0
  28. package/dist/DateTimePicker/DateTimePicker.d.ts +1 -1
  29. package/dist/DateTimePicker/DateTimePicker.js +3 -3
  30. package/dist/DateTimePicker/typings.d.ts +1 -0
  31. package/dist/Descriptions/DescriptionsContext.d.ts +2 -0
  32. package/dist/Descriptions/typings.d.ts +13 -0
  33. package/dist/Dialog/DialogContext.d.ts +8 -0
  34. package/dist/Dialog/typings.d.ts +38 -2
  35. package/dist/Divider/Divider.d.ts +4 -0
  36. package/dist/Drawer/Drawer.js +18 -9
  37. package/dist/Drawer/DrawerContext.d.ts +10 -0
  38. package/dist/Drawer/typings.d.ts +16 -0
  39. package/dist/Dropdown/Dropdown.js +1 -1
  40. package/dist/Dropdown/DropdownContext.d.ts +2 -0
  41. package/dist/Dropdown/typings.d.ts +16 -1
  42. package/dist/Form/FormItem.d.ts +12 -0
  43. package/dist/Form/typings.d.ts +55 -0
  44. package/dist/Form/useForm.d.ts +22 -0
  45. package/dist/Form/utils/NameMap.d.ts +3 -0
  46. package/dist/Form/utils/validateUtil.d.ts +4 -0
  47. package/dist/Form/utils/valueUtil.d.ts +17 -0
  48. package/dist/Icon/typings.d.ts +7 -0
  49. package/dist/Input/Input.js +2 -1
  50. package/dist/Input/typings.d.ts +61 -0
  51. package/dist/InputNumber/typings.d.ts +21 -0
  52. package/dist/Link/typings.d.ts +6 -1
  53. package/dist/Loading/typings.d.ts +5 -0
  54. package/dist/Message/Main.d.ts +7 -0
  55. package/dist/Message/index.d.ts +8 -0
  56. package/dist/Message/typings.d.ts +11 -0
  57. package/dist/MessageBox/index.d.ts +14 -0
  58. package/dist/MessageBox/typings.d.ts +50 -0
  59. package/dist/Notification/Main.d.ts +7 -0
  60. package/dist/Notification/index.d.ts +15 -0
  61. package/dist/Notification/typings.d.ts +13 -0
  62. package/dist/Pagination/typings.d.ts +28 -0
  63. package/dist/Popconfirm/Popconfirm.js +1 -1
  64. package/dist/Popconfirm/typings.d.ts +12 -1
  65. package/dist/Popover/Popover.js +1 -1
  66. package/dist/Popover/typings.d.ts +13 -1
  67. package/dist/Popper/typings.d.ts +7 -1
  68. package/dist/Progress/typings.d.ts +12 -0
  69. package/dist/Radio/typings.d.ts +7 -0
  70. package/dist/RadioGroup/typings.d.ts +1 -0
  71. package/dist/Row/RowContext.d.ts +1 -0
  72. package/dist/Row/typings.d.ts +4 -0
  73. package/dist/Scrollbar/typings.d.ts +20 -0
  74. package/dist/Select/typings.d.ts +33 -0
  75. package/dist/Skeleton/PlaceholderGraph.d.ts +4 -0
  76. package/dist/Skeleton/PlaceholderGrid.d.ts +4 -0
  77. package/dist/Skeleton/PlaceholderParagraph.d.ts +4 -0
  78. package/dist/Switch/typings.d.ts +15 -0
  79. package/dist/Table/Colgroup.d.ts +1 -0
  80. package/dist/Table/TableContext.d.ts +8 -0
  81. package/dist/Table/hooks/useSelection.d.ts +18 -1
  82. package/dist/Table/hooks/useTable.d.ts +7 -0
  83. package/dist/Table/treeUtil.d.ts +39 -0
  84. package/dist/Table/typings.d.ts +137 -1
  85. package/dist/Table/util.d.ts +10 -0
  86. package/dist/Table/util.js +1 -1
  87. package/dist/Tabs/Tabs.js +1 -1
  88. package/dist/Tabs/typings.d.ts +38 -0
  89. package/dist/Tag/Tag.d.ts +1 -1
  90. package/dist/Tag/Tag.js +18 -26
  91. package/dist/Tag/typings.d.ts +10 -0
  92. package/dist/TimeLine/typings.d.ts +9 -0
  93. package/dist/TimePicker/TimePicker.js +1 -0
  94. package/dist/TimePicker/TimeSpinnerPanel.js +2 -1
  95. package/dist/TimePicker/typings.d.ts +13 -0
  96. package/dist/TimePicker/useTimePicker.d.ts +7 -0
  97. package/dist/Tooltip/Tooltip.js +8 -19
  98. package/dist/Tooltip/TooltipContext.d.ts +1 -0
  99. package/dist/Tooltip/typings.d.ts +14 -1
  100. package/dist/Transfer/ListItem.d.ts +1 -0
  101. package/dist/Transfer/typings/index.d.ts +27 -0
  102. package/dist/Transfer/typings/list.d.ts +25 -0
  103. package/dist/Transfer/typings/listBody.d.ts +1 -0
  104. package/dist/Transition/Transition.d.ts +10 -0
  105. package/dist/Transition/TransitionGroup.d.ts +59 -0
  106. package/dist/Transition/childMapping.d.ts +23 -0
  107. package/dist/Tree/NodeList.d.ts +3 -0
  108. package/dist/Tree/RCTree.d.ts +15 -0
  109. package/dist/Tree/Tree.d.ts +15 -0
  110. package/dist/Tree/TreeNode.d.ts +7 -0
  111. package/dist/Tree/contextTypes.d.ts +4 -0
  112. package/dist/Tree/typings.d.ts +3 -0
  113. package/dist/Tree/util.d.ts +17 -0
  114. package/dist/Tree/utils/KeyCode.d.ts +326 -0
  115. package/dist/Tree/utils/conductUtil.d.ts +6 -0
  116. package/dist/Tree/utils/dictUtil.d.ts +1 -0
  117. package/dist/Tree/utils/pickAttrs.d.ts +5 -0
  118. package/dist/Tree/utils/treeUtil.d.ts +25 -1
  119. package/dist/TreeSelect/Utils.d.ts +1 -0
  120. package/dist/TreeSelect/typings.d.ts +19 -0
  121. package/dist/Upload/typings.d.ts +34 -0
  122. package/dist/Upload/use-handlers.d.ts +1 -0
  123. package/dist/Util/Math.d.ts +34 -0
  124. package/dist/Util/base.d.ts +21 -0
  125. package/dist/Util/shallowEqual.d.ts +11 -0
  126. package/dist/Util/treeUtils.d.ts +8 -0
  127. package/dist/VirtualList/Filler.d.ts +5 -0
  128. package/dist/VirtualList/VirtualList.d.ts +3 -0
  129. package/dist/VirtualList/hooks/useLayoutEffect.d.ts +3 -0
  130. package/dist/VirtualList/utils/algorithmUtil.d.ts +17 -0
  131. package/dist/VirtualList/utils/findDOMNode.d.ts +3 -0
  132. package/dist/hooks/animationPropsUtils.d.ts +12 -0
  133. package/dist/hooks/htmlPropsUtils.d.ts +8 -0
  134. package/dist/hooks/popperPropsUtils.d.ts +12 -0
  135. package/dist/hooks/treePropsUtils.d.ts +12 -0
  136. package/dist/hooks/useChildrenInstance.d.ts +11 -0
  137. package/dist/hooks/useClassNames.d.ts +78 -0
  138. package/dist/hooks/useControlled.d.ts +8 -0
  139. package/dist/hooks/useForceUpdate.d.ts +1 -0
  140. package/dist/index.d.ts +1 -0
  141. package/dist/theme-chalk/link/index.scss +0 -85
  142. package/dist/types/common.d.ts +24 -0
  143. package/dist/types/type.d.ts +5 -0
  144. package/package.json +1 -1
@@ -2,6 +2,7 @@ import { FC } from 'react';
2
2
  import { TableColumnCtx } from './typings';
3
3
  interface Props<T> {
4
4
  columns: TableColumnCtx<T>[];
5
+ /** 设置表格单元、行和列的布局方式 */
5
6
  tableLayout?: 'fixed' | 'auto';
6
7
  }
7
8
  declare const Colgroup: FC<Props<any>>;
@@ -3,9 +3,13 @@ import { Action, State } from './hooks/useSelection';
3
3
  import { TableColumnCtx, TableProps, TableRefs, TreeNode } from './typings';
4
4
  export interface TableContextProps<T> {
5
5
  tableId: string;
6
+ /** 多级列 */
6
7
  columns: TableColumnCtx<T>[][];
8
+ /** 最后一级列 */
7
9
  flattenColumns: TableColumnCtx<T>[];
10
+ /** 左固定列 */
8
11
  fixedLeftColumns: TableColumnCtx<T>[];
12
+ /** 右固定列 */
9
13
  fixedRightColumns: TableColumnCtx<T>[];
10
14
  tableRefs: TableRefs;
11
15
  props: Omit<TableProps<T>, 'children'>;
@@ -21,8 +25,11 @@ export interface TableBodyContextProps<T> {
21
25
  oldActiveRow: MutableRefObject<T | null | undefined>;
22
26
  state: State<T>;
23
27
  dispatch: (action: Action) => void;
28
+ /** 原始表格数据 */
24
29
  initialData: MutableRefObject<T[]>;
30
+ /** 排序后表格数据 */
25
31
  sortedData: MutableRefObject<T[]>;
32
+ /** 禁止选中行 */
26
33
  disabledRows: MutableRefObject<T[]>;
27
34
  isTreeTable: () => boolean;
28
35
  isTreeExpandCell: (id: string) => boolean;
@@ -30,6 +37,7 @@ export interface TableBodyContextProps<T> {
30
37
  hasChildren: string;
31
38
  children: string;
32
39
  };
40
+ /** 树节点信息 */
33
41
  treeNodes: MutableRefObject<TreeNode[]>;
34
42
  }
35
43
  export declare const TableContext: import("react").Context<TableContextProps<any>>;
@@ -1,5 +1,12 @@
1
1
  /// <reference types="react" />
2
2
  import { TableProps } from '../typings';
3
+ /**
4
+ * @author Parker
5
+ * @CreateTime 2022/9/17 19:39:22
6
+ * @LastEditor Parker
7
+ * @ModifyTime 2022/11/7 19:38:04
8
+ * @Description
9
+ */
3
10
  export declare const useSelection: <T>(props: TableProps<T>, data: T[]) => {
4
11
  state: {
5
12
  isIndeterminate: any;
@@ -28,5 +35,15 @@ export interface Action {
28
35
  type: 'onCheck' | 'activeRow';
29
36
  payload: any;
30
37
  }
38
+ /**
39
+ * 用于单选表格,设定某一行为选中行
40
+ * @param payload
41
+ * @returns
42
+ */
31
43
  export declare const activeRow: <T>(payload: T) => Action;
32
- export declare const onCheck: <T>(payload: Pick<State<T>, "isIndeterminate" | "selection">) => Action;
44
+ /**
45
+ * 多选模式下选中行
46
+ * @param payload
47
+ * @returns
48
+ */
49
+ export declare const onCheck: <T>(payload: Pick<State<T>, "selection" | "isIndeterminate">) => Action;
@@ -1,5 +1,12 @@
1
1
  import React from 'react';
2
2
  import { TableColumnCtx, TableColumnProps, TableProps, TableRefs, TreeNode } from '../typings';
3
+ /**
4
+ * @author Parker
5
+ * @CreateTime 2022/9/11 12:24:23
6
+ * @LastEditor Parker
7
+ * @LastEditor Parker
8
+ * @ModifyTime 2022/11/19 23:23:42
9
+ */
3
10
  export declare const useTable: <T extends object>(props: TableProps<T>, refs: TableRefs, tableId: string) => {
4
11
  data: T[];
5
12
  setData: React.Dispatch<React.SetStateAction<T[]>>;
@@ -1,22 +1,61 @@
1
1
  import { TreeNode } from './typings';
2
+ /**
3
+ * 树形表格数据平铺成二维数据
4
+ * @param data 表格数据
5
+ * @param treeProps 渲染嵌套数据的配置选项
6
+ * @param rowKey 行数据的 Key,用来优化 Table 的渲染
7
+ * @param defaultExpandAll 是否默认展开所有行
8
+ * @param defaultExpandRowKeys 默认展开行
9
+ * @param result 重组后数据
10
+ * @param level 层级
11
+ * @param parentId 父ID
12
+ * @param parentDisplay 父级是否显示
13
+ * @returns
14
+ */
2
15
  export declare const flatTreeData: <T>(data: T[], treeProps: {
3
16
  hasChildren: string;
4
17
  children: string;
5
18
  }, rowKey: string | ((data: {
6
19
  row: T;
7
20
  }) => string), defaultExpandAll?: boolean, defaultExpandRowKeys?: any[], result?: (T & TreeNode)[], level?: number, parentId?: any, parentDisplay?: boolean) => (T & TreeNode)[];
21
+ /**
22
+ * 获取某一行数据所有的子节点
23
+ * @param data
24
+ * @param treeProps
25
+ * @param rowKey
26
+ * @param defaultExpandAll
27
+ * @param result
28
+ * @returns
29
+ */
8
30
  export declare const getAllChildren: <T>(data: T[], treeProps: {
9
31
  hasChildren: string;
10
32
  children: string;
11
33
  }, rowKey: string | ((data: {
12
34
  row: T;
13
35
  }) => string), defaultExpandAll?: boolean, result?: T[]) => T[];
36
+ /**
37
+ * 将原始树形数据和树节点数据合并成可以渲染的表格数据
38
+ * @param treeData 原始树形数据
39
+ * @param treeNodes 树节点数据
40
+ * @param treeProps
41
+ * @param rowKey
42
+ * @param result 结果数据
43
+ * @returns
44
+ */
14
45
  export declare const mergeTreeData: <T>(treeData: T[], treeNodes: TreeNode[], treeProps: {
15
46
  hasChildren: string;
16
47
  children: string;
17
48
  }, rowKey: string | ((data: {
18
49
  row: T;
19
50
  }) => string), result?: (T & TreeNode)[]) => (T & TreeNode)[];
51
+ /**
52
+ * 给某一行数据添加子节点
53
+ * @param treeData
54
+ * @param targetId 目标行id
55
+ * @param children 子节点
56
+ * @param treeProps
57
+ * @param rowKey
58
+ */
20
59
  export declare const addTreeChildren: <T>(treeData: T[], targetId: string, children: T[], treeProps: {
21
60
  hasChildren: string;
22
61
  children: string;
@@ -17,157 +17,258 @@ export type RenderCell<T> = {
17
17
  column?: TableColumnCtx<T>;
18
18
  };
19
19
  export type TableColumnProps<T> = {
20
+ /** 对应列的类型。 如果设置了selection则显示多选框; 如果设置了 index 则显示该行的索引(从 1 开始计算); 如果设置了 expand 则显示为一个可展开的按钮 */
20
21
  type?: 'selection' | 'index' | 'expand' | 'drag';
22
+ /** 如果设置了 type=index,可以通过传递 index 属性来自定义索引 */
21
23
  index?: number | ((index: number, row?: T) => number);
24
+ /** column 的 key,如果需要使用 filterChange 事件,则需要此属性标识是哪个 column 的筛选条件 */
22
25
  label?: string | React.ReactElement;
26
+ /** */
23
27
  className?: string;
28
+ /** 当前列标题的自定义类名 */
24
29
  labelClassName?: string;
30
+ /** 字段名称 对应列内容的字段名, 也可以使用 prop 属性 */
25
31
  name?: string;
32
+ /** 字段名称 对应列内容的字段名, 也可以使用 name 属性 */
26
33
  prop?: string;
34
+ /** 对应列的宽度 */
27
35
  width?: number;
36
+ /** 对应列的最小宽度, 对应列的最小宽度, 与 width 的区别是 width 是固定的,minWidth 会把剩余宽度按比例分配给设置了 minWidth 的列 */
28
37
  minWidth?: number;
38
+ /** 列标题 Label 区域渲染使用的 Function */
29
39
  renderHeader?: (data: CI<T>) => React.ReactElement;
40
+ /** 对应列是否可以排序, 如果设置为 'custom',则代表用户希望远程排序,需要监听 Table 的 sortChange 事件 */
30
41
  sortable?: boolean | 'custom';
42
+ /** 指定数据按照哪个属性进行排序,仅当sortable设置为true的时候有效。 应该如同 Array.sort 那样返回一个 Number */
31
43
  sortMethod?: (a: T, b: T) => number;
32
- sortBy?: string | string[];
44
+ /** 指定数据按照哪个属性进行排序,仅当 sortable 设置为 true 且没有设置 sortMethod 的时候有效。 如果 sortBy 为数组,则先按照第 1 个属性排序,如果第 1 个相等,再按照第 2 个排序,以此类推 */
45
+ sortBy?: string | /* ((row: T, index: number) => string) | */ string[];
46
+ /** 数据在排序时所使用排序策略的轮转顺序,仅当 sortable 为 true 时有效。 需传入一个数组,随着用户点击表头,该列依次按照数组中元素的顺序进行排序 */
33
47
  sortOrders?: ('ascending' | 'descending' | null)[];
48
+ /** 对应列是否可以通过拖动改变宽度(需要在 elTable 上设置 border 属性为真) */
34
49
  resizable?: boolean;
50
+ /** column 的 key, column 的 key, 如果需要使用 filterChange 事件,则需要此属性标识是哪个 column 的筛选条件 */
35
51
  columnKey?: string;
52
+ /** */
36
53
  rawColumnKey?: string;
54
+ /** */
37
55
  align?: 'left' | 'center' | 'right';
56
+ /** 表头对齐方式, 若不设置该项,则使用表格的对齐方式 */
38
57
  headerAlign?: 'left' | 'center' | 'right';
58
+ /** 当内容过长被隐藏时显示 tooltip */
39
59
  showOverflowTooltip?: boolean;
60
+ /** 列是否固定在左侧或者右侧。 true 表示固定在左侧 */
40
61
  fixed?: boolean | 'left' | 'right';
62
+ /** 用来格式化内容 */
41
63
  formatter?: (row: T, column: TableColumnCtx<T>, cellValue: any, index: number) => React.ReactElement | string;
64
+ /** 仅对 type=selection 的列有效,类型为 Function,Function 的返回值用来决定这一行的 CheckBox 是否可以勾选 */
42
65
  selectable?: (row: T, index: number) => boolean;
66
+ /** 分页保留勾选项,仅对 type=selection 的列有效, 请注意, 需指定 rowKey 来让这个功能生效 */
43
67
  reserveSelection?: boolean;
68
+ /** 数据过滤使用的方法, 如果是多选的筛选项,对每一条数据会执行多次,任意一次返回 true 就会显示 */
44
69
  filterMethod?: FilterMethods<T>;
70
+ /** 选中的数据过滤项,如果需要自定义表头过滤的渲染方式,可能会需要此属性 */
45
71
  filteredValue?: string[];
72
+ /** 数据过滤的选项, 数组格式,数组中的元素需要有 text 和 value 属性。 数组中的每个元素都需要有 text 和 value 属性 */
46
73
  filters?: Filters;
74
+ /** 过滤弹出框的定位 */
47
75
  filterPlacement?: Placement;
76
+ /** 数据过滤的选项是否多选 */
48
77
  filterMultiple?: boolean;
78
+ /** 子组件 */
49
79
  children?: React.ReactElement<TableColumnProps<T>> | React.ReactElement<TableColumnProps<T>>[] | ((data: RenderCell<T>) => React.ReactElement | string | number);
50
80
  };
51
81
  export type TableColumnCtx<T> = Omit<TableColumnProps<T>, 'children'> & {
82
+ /** */
52
83
  id?: string;
84
+ /** */
53
85
  realWidth?: number;
86
+ /** */
54
87
  offsetWidth?: number;
88
+ /** */
55
89
  renderCell?: (data: RenderCell<T>) => React.ReactElement;
90
+ /** */
56
91
  colSpan?: number;
92
+ /** */
57
93
  rowSpan?: number;
94
+ /** */
58
95
  children?: TableColumnCtx<T>[];
96
+ /** */
59
97
  level?: number;
98
+ /** */
60
99
  filterable?: boolean | FilterMethods<T> | Filters;
100
+ /** */
61
101
  order?: string;
102
+ /** */
62
103
  isColumnGroup?: boolean;
104
+ /** */
63
105
  isSubColumn?: boolean;
106
+ /** */
64
107
  columns?: TableColumnCtx<T>[];
108
+ /** */
65
109
  getColumnIndex?: () => number;
110
+ /** */
66
111
  no?: number;
112
+ /** */
67
113
  filterOpened?: boolean;
68
114
  };
69
115
  export interface TreeNode {
70
116
  id?: string;
71
117
  parentId?: string;
118
+ /** 是否已展开 */
72
119
  expanded?: boolean;
120
+ /** 是否加载中 */
73
121
  loading?: boolean;
122
+ /** 是否没有懒加载子节点 */
74
123
  noLazyChildren?: boolean;
124
+ /** 缩进宽度 */
75
125
  indent?: number;
126
+ /** 树的层级 */
76
127
  level?: number;
128
+ /** 是否显示 */
77
129
  display?: boolean;
78
130
  }
79
131
  export interface TableEvents<T> {
132
+ /** 当用户手动勾选数据行的 Checkbox 时触发的事件 */
80
133
  onSelect?: (selection: T[], row: T) => void;
134
+ /** 当用户手动勾选全选 Checkbox 时触发的事件 */
81
135
  onSelectAll?: (selection: T[]) => void;
136
+ /** 当选择项发生变化时会触发该事件 */
82
137
  onSelectionChange?: (selection: T[]) => void;
138
+ /** 当单元格 hover 进入时会触发该事件 */
83
139
  onCellMouseEnter?: (row: T, column: TableColumnCtx<T>, cell: HTMLTableCellElement, event: React.MouseEvent<Element>) => void;
140
+ /** 当单元格 hover 退出时会触发该事件 */
84
141
  onCellMouseLeave?: (row: T, column: TableColumnCtx<T>, cell: HTMLTableCellElement, event: React.MouseEvent<Element>) => void;
142
+ /** 当某个单元格被点击时会触发该事件 */
85
143
  onCellClick?: (row: T, column: TableColumnCtx<T>, cell: HTMLTableCellElement, event: React.MouseEvent<Element>) => void;
144
+ /** 当某个单元格被双击击时会触发该事件 */
86
145
  onCellDblclick?: (row: T, column: TableColumnCtx<T>, cell: HTMLTableCellElement, event: React.MouseEvent<Element>) => void;
146
+ /** 当某个单元格被鼠标右键点击时会触发该事件 */
87
147
  onCellContextmenu?: (row: T, column: TableColumnCtx<T>, cell: HTMLTableCellElement, event: React.MouseEvent<Element>) => void;
148
+ /** 当某一行被点击时会触发该事件 */
88
149
  onRowClick?: (row: T, column: TableColumnCtx<T>, event: React.MouseEvent<Element>) => void;
150
+ /** 当某一行被鼠标右键点击时会触发该事件 */
89
151
  onRowContextmenu?: (row: T, column: TableColumnCtx<T>, event: React.MouseEvent<Element>) => void;
152
+ /** 当某一行被双击时会触发该事件 */
90
153
  onRowDblclick?: (row: T, column: TableColumnCtx<T>, event: React.MouseEvent<Element>) => void;
154
+ /** 当某一列的表头被点击时会触发该事件 */
91
155
  onHeaderClick?: (column: TableColumnCtx<T>, event: React.MouseEvent<Element>) => void;
156
+ /** 当某一列的表头被鼠标右键点击时触发该事件 */
92
157
  onHeaderContextmenu?: (column: TableColumnCtx<T>, event: React.MouseEvent<Element>) => void;
158
+ /** 当表格的排序条件发生变化的时候会触发该事件 */
93
159
  onSortChange?: (data: {
94
160
  column: TableColumnCtx<T>;
95
161
  prop: string;
96
162
  order: 'ascending' | 'descending';
97
163
  }) => T[];
164
+ /** column 的 key, 如果需要使用 filterChange 事件,则需要此属性标识是哪个 column 的筛选条件 */
98
165
  onFilterChange?: (filters: any) => void;
166
+ /** 当表格的当前行发生变化的时候会触发该事件,如果要高亮当前行,请打开表格的 highlightCurrentRow 属性 */
99
167
  onCurrentChange?: (currentRow: T, oldCurrentRow: T) => void;
168
+ /** 当拖动表头改变了列的宽度的时候会触发该事件 */
100
169
  onHeaderDragend?: (newWidth: number, oldWidth: number, column: TableColumnCtx<T>, event: React.MouseEvent<Element>) => void;
170
+ /** 当用户对某一行展开或者关闭的时候会触发该事件(展开行时,回调的第二个参数为 expandedRows;树形表格时第二参数为 expanded) */
101
171
  onExpandChange?: (row: T, expandedRows: boolean | string[]) => void;
172
+ /** 拖拽排序后的回调 */
102
173
  onDragChange?: (data: T[]) => void;
103
174
  }
104
175
  export interface TableProps<T> extends BaseProps, NativeProps<'--el-table-border-color' | '--el-table-border' | '--el-table-text-color' | '--el-table-header-text-color' | '--el-table-row-hover-bg-color' | '--el-table-row-strip-bg-color' | '--el-table-current-row-bg-color' | '--el-table-header-bg-color' | '--el-table-fixed-box-shadow' | '--el-table-bg-color' | '--el-table-tr-bg-color' | '--el-table-expanded-cell-bg-color' | '--el-table-fixed-left-column' | '--el-table-fixed-right-column' | '--el-table-min-height'>, TableEvents<T> {
176
+ /** 显示的数据 */
105
177
  data: T[];
178
+ /** Table 的高度, 默认为自动高度。 如果 height 为 number 类型,单位 px;如果 height 为 string 类型,则这个高度会设置为 Table 的 style.height 的值,Table 的高度会受控于外部样式 */
106
179
  height?: string | number;
180
+ /** Table 的最大高度。 合法的值为数字或者单位为 px 的高度 */
107
181
  maxHeight?: string | number;
182
+ /** 行高 */
108
183
  rowHeight?: number;
184
+ /** 是否为斑马纹 */
109
185
  stripe?: boolean;
186
+ /** 是否带有纵向边框 */
110
187
  border?: boolean;
188
+ /** Table 的尺寸 */
111
189
  size?: 'large' | 'default' | 'small';
190
+ /** 列的宽度是否自撑开 */
112
191
  fit?: boolean;
192
+ /** 是否显示表头 */
113
193
  showHeader?: boolean;
194
+ /** 是否要高亮当前行 */
114
195
  highlightCurrentRow?: boolean;
196
+ /** 当前行的 key,只写属性 */
115
197
  currentRowKey?: string | number;
198
+ /** 行的 className 的回调方法,也可以使用字符串为所有行设置一个固定的 className */
116
199
  rowClassName?: ((data: {
117
200
  row: T;
118
201
  rowIndex: number;
119
202
  }) => string) | string;
203
+ /** 行的 style 的回调方法,也可以使用一个固定的 Object 为所有行设置一样的 Style */
120
204
  rowStyle?: ((data: {
121
205
  row: T;
122
206
  rowIndex: number;
123
207
  }) => React.CSSProperties) | React.CSSProperties;
208
+ /** 单元格的 className 的回调方法,也可以使用字符串为所有单元格设置一个固定的 className */
124
209
  cellClassName?: ((data: {
125
210
  row: T;
126
211
  column: TableColumnCtx<T>;
127
212
  rowIndex: number;
128
213
  columnIndex: number;
129
214
  }) => string) | string;
215
+ /** 单元格的 style 的回调方法,也可以使用一个固定的 Object 为所有单元格设置一样的 Style */
130
216
  cellStyle?: ((data: {
131
217
  row: T;
132
218
  column: TableColumnCtx<T>;
133
219
  rowIndex: number;
134
220
  columnIndex: number;
135
221
  }) => React.CSSProperties) | React.CSSProperties;
222
+ /** 表头行的 className 的回调方法,也可以使用字符串为所有表头行设置一个固定的 className */
136
223
  headerRowClassName?: ((data: {
137
224
  row: T;
138
225
  rowIndex: number;
139
226
  }) => string) | string;
227
+ /** 表头行的 style 的回调方法,也可以使用一个固定的 Object 为所有表头行设置一样的 Style */
140
228
  headerRowStyle?: ((data: {
141
229
  row: T;
142
230
  rowIndex: number;
143
231
  }) => React.CSSProperties) | React.CSSProperties;
232
+ /** 表头单元格的 className 的回调方法,也可以使用字符串为所有表头单元格设置一个固定的 className */
144
233
  headerCellClassName?: ((data: {
145
234
  row: T;
146
235
  column: TableColumnCtx<T>;
147
236
  rowIndex: number;
148
237
  columnIndex: number;
149
238
  }) => string) | string;
239
+ /** 表头单元格的 style 的回调方法,也可以使用一个固定的 Object 为所有表头单元格设置一样的 Style */
150
240
  headerCellStyle?: ((data: {
151
241
  row: T;
152
242
  column: TableColumnCtx<T>;
153
243
  rowIndex: number;
154
244
  columnIndex: number;
155
245
  }) => React.CSSProperties) | React.CSSProperties;
246
+ /** 行数据的 Key,用来优化 Table 的渲染; 在使用reserveSelection功能与显示树形数据时,该属性是必填的。 类型为 String 时,支持多层访问:user.info.id,但不支持 user.info[0].id,此种情况请使用 Function */
156
247
  rowKey?: string | ((data: {
157
248
  row: T;
158
249
  }) => string);
250
+ /** 空数据时显示的文本内容 */
159
251
  emptyText?: string;
252
+ /** 插入至表格最后一行之后的内容, 如果需要对表格的内容进行无限滚动操作,可能需要用到这个 slot。 若表格有合计行,该 slot 会位于合计行之上。 */
160
253
  append?: React.ReactElement;
254
+ /** 是否默认展开所有行,当 Table 包含展开行存在或者为树形表格时有效 */
161
255
  defaultExpandAll?: boolean;
256
+ /** 可以通过该属性设置 Table 目前的展开行,需要设置 rowKey 属性才能使用,该属性为展开行的 keys 数组 */
162
257
  expandRowKeys?: string[];
258
+ /** 默认的排序列的 prop 和顺序。 它的 prop 属性指定默认的排序的列,order 指定默认排序的顺序 */
163
259
  defaultSort?: TableSort;
260
+ /** tooltip effect 属性 */
164
261
  tooltipEffect?: 'dark' | 'light';
262
+ /** 是否在表尾显示合计行 */
165
263
  showSummary?: boolean;
264
+ /** 合计行第一列的文本 */
166
265
  sumText?: string;
266
+ /** 自定义的合计计算方法 */
167
267
  summaryMethod?: (data: {
168
268
  columns: TableColumnCtx<T>[];
169
269
  data: T[];
170
270
  }) => string[];
271
+ /** 合并行或列的计算方法 */
171
272
  spanMethod?: (data: {
172
273
  row: T;
173
274
  column: TableColumnCtx<T>;
@@ -177,20 +278,32 @@ export interface TableProps<T> extends BaseProps, NativeProps<'--el-table-border
177
278
  rowspan: number;
178
279
  colspan: number;
179
280
  } | undefined;
281
+ /** 在多选表格中,当仅有部分行被选中时,点击表头的多选框时的行为。 若为 true,则选中所有行;若为 false,则取消选择所有行 */
180
282
  selectOnIndeterminate?: boolean;
283
+ /** 展示树形数据时,树节点的缩进 */
181
284
  indent?: number;
285
+ /** 是否懒加载子节点数据 */
182
286
  lazy?: boolean;
287
+ /** 加载子节点数据的函数,lazy 为 true 时生效,函数第二个参数包含了节点的层级信息 */
183
288
  load?: (row: T, treeNode: TreeNode, resolve: (data: T[]) => void) => void;
289
+ /** 渲染嵌套数据的配置选项 */
184
290
  treeProps?: {
185
291
  hasChildren?: string;
186
292
  children?: string;
187
293
  };
294
+ /** 设置表格单元、行和列的布局方式 */
188
295
  tableLayout?: 'fixed' | 'auto';
296
+ /** 总是显示滚动条 */
189
297
  scrollbarAlwaysOn?: boolean;
298
+ /** 确保主轴的最小尺寸 */
190
299
  flexible?: boolean;
300
+ /** 是否为加载状态 */
191
301
  loading?: boolean;
302
+ /** 仅对 type=expand 的列有效,类型为 Function,Function 的返回值用来决定这一行是否能被展开 */
192
303
  expandable?: (row: T) => Promise<boolean>;
304
+ /** 是否在不能展开行时隐藏展开图标 */
193
305
  hideIconOnNotExpand?: boolean;
306
+ /** 子组件 */
194
307
  children: React.ReactElement<TableColumnProps<T>> | React.ReactElement<TableColumnProps<T>>[];
195
308
  }
196
309
  export interface TableSort {
@@ -200,31 +313,54 @@ export interface TableSort {
200
313
  silent?: any;
201
314
  }
202
315
  export interface TableRefs {
316
+ /** 表格div*/
203
317
  tableWrapper: RefObject<HTMLDivElement>;
318
+ /** 表格内容div */
204
319
  innerWrpper: RefObject<HTMLDivElement>;
320
+ /** 表格头部div */
205
321
  headerWrapper: RefObject<HTMLDivElement>;
322
+ /** 表格底部div */
206
323
  footerWrapper: RefObject<HTMLDivElement>;
324
+ /** 表格滚动条ref */
207
325
  scrollBarRef: RefObject<ScrollbarRef>;
326
+ /** 拖动改变宽度辅助线 */
208
327
  resizeHelper: RefObject<HTMLDivElement>;
328
+ /** 表格头部table */
209
329
  tableHeader: RefObject<HTMLTableElement>;
330
+ /** 表格内容table */
210
331
  tableBody: RefObject<HTMLTableElement>;
332
+ /** 无内容div */
211
333
  emptyBlock: RefObject<HTMLDivElement>;
212
334
  }
213
335
  export interface TableRef<T> {
214
336
  refs: TableRefs;
337
+ /** 用于多选表格,清空用户的选择 */
215
338
  clearSelection: () => void;
339
+ /** 返回当前选中的行 */
216
340
  getSelectionRows: () => T[];
341
+ /** 用于多选表格,切换某一行的选中状态, 如果使用了第二个参数,则可直接设置这一行选中与否 */
217
342
  toggleRowSelection: (row: T, selected: boolean) => void;
343
+ /** 用于多选表格,切换全选和全不选 — */
218
344
  toggleAllSelection: () => void;
345
+ /** 用于可扩展的表格或树表格,如果某行被扩展,则切换。 使用第二个参数,您可以直接设置该行应该被扩展或折叠。 row, expanded */
219
346
  toggleRowExpansion?: () => void;
347
+ /** 用于单选表格,设定某一行为选中行, 如果调用时不加参数,则会取消目前高亮行的选中状态 */
220
348
  setCurrentRow: (row?: T | null) => void;
349
+ /** 用于清空排序条件,数据会恢复成未排序的状态 — */
221
350
  clearSort?: () => void;
351
+ /** 传入由columnKey 组成的数组以清除指定列的过滤条件。 如果没有参数,清除所有过滤器 columnKeys */
222
352
  clearFilter?: () => void;
353
+ /** 对 Table 进行重新布局。 当表格可见性变化时,您可能需要调用此方法以获得正确的布局 — */
223
354
  doLayout: () => void;
355
+ /** 手动排序表格。 参数 prop 属性指定排序列,order 指定排序顺序。 prop: string, order: string */
224
356
  sort?: () => void;
357
+ /** 滚动到一组特定坐标 */
225
358
  scrollTo?: (options: ScrollToOptions | number, yCoord?: number) => void;
359
+ /** 设置滚动条到顶部的距离 */
226
360
  setScrollTop?: (value: number) => void;
361
+ /** 设置滚动条到左边的距离 */
227
362
  setScrollLeft?: (value: number) => void;
363
+ /** 设置表格高度 */
228
364
  setHeight: (height: string | number) => void;
229
365
  }
230
366
  export {};
@@ -15,4 +15,14 @@ export declare const getRowIdentity: <T>(row: T, rowKey: string | ((data: {
15
15
  }) => string)) => string;
16
16
  export declare const getRowIndex: <T>(index: number | ((index: number, row?: T) => number), rowIndex: number, row: T) => number;
17
17
  export declare function parseHeight(height: number | string): string | number;
18
+ /**
19
+ * ��д�߼�
20
+ 1�������ҵ�����������Ҫ�����Ԫ�غ�������λ��Ŀ��Ԫ��
21
+ 2������Ŀ��Ԫ���ҵ�����Ԫ�صĸ�Ԫ��
22
+ 3���ж�Ŀ��Ԫ���Dz��Ǹ�Ԫ���ڵ�Ψһ��Ԫ��.
23
+ 4�������,��Ԫ��ִ��׷�Ӳ���,����appendChild(newElement)
24
+ 5���������,��Ŀ��Ԫ�ص�֮��Ľ����ŵĽڵ�֮ǰִ��inserBefore()����
25
+ * @param newElement
26
+ * @param targetElement
27
+ */
18
28
  export declare const insertAfter: (newElement: HTMLElement, targetElement: HTMLElement) => void;
@@ -36,7 +36,7 @@ var import_prefix = require("../hooks/prefix");
36
36
  var TableIdManager = {
37
37
  tableId: 0,
38
38
  columnId: 0,
39
- nextTableId: () => `r-table_${++TableIdManager.tableId}`,
39
+ nextTableId: () => `${import_prefix.globalKey}-table_${++TableIdManager.tableId}`,
40
40
  nextColumnId: (start) => `column_${start ? ++start : ++TableIdManager.columnId}`
41
41
  };
42
42
  var cacheStringFunction = (fn) => {
package/dist/Tabs/Tabs.js CHANGED
@@ -171,7 +171,7 @@ var Tabs = (0, import_react.forwardRef)((props, ref) => {
171
171
  let offset = 0;
172
172
  let tabSize = 0;
173
173
  const sizeDir = sizeName === "offsetWidth" ? "X" : "Y";
174
- (0, import_forEach.default)((_a = elRef.current) == null ? void 0 : _a.querySelectorAll(".r-tabs__item"), (el) => {
174
+ (0, import_forEach.default)((_a = elRef.current) == null ? void 0 : _a.querySelectorAll("." + e`item`), (el) => {
175
175
  var _a2;
176
176
  if ((0, import_dom_lib.hasClass)(el, "is-active")) {
177
177
  tabSize = el[sizeName === "offsetWidth" ? "clientWidth" : "clientHeight"];
@@ -1,54 +1,92 @@
1
1
  import React from 'react';
2
2
  import { BaseProps, NativeProps } from '../types/common';
3
3
  export interface TabsProps extends BaseProps, NativeProps<'--el-tabs-header-height' | '--el-tabs-header-margin-bottom'> {
4
+ /** 选中选项卡的 name */
4
5
  defaultActiveName?: TabPaneName;
6
+ /** 选中选项卡的 name */
5
7
  activeName?: TabPaneName;
8
+ /** 风格类型 */
6
9
  type?: 'card' | 'border-card' | null;
10
+ /** 标签是否可关闭 */
7
11
  closable?: boolean;
12
+ /** 标签是否可增加 */
8
13
  addable?: boolean;
14
+ /** 标签是否同时可增加和关闭 */
9
15
  editable?: boolean;
16
+ /** 选项卡所在位置 */
10
17
  tabPosition?: 'top' | 'right' | 'bottom' | 'left';
18
+ /** 标签的宽度是否自撑开 */
11
19
  stretch?: boolean;
20
+ /** 是否居中显示 */
12
21
  center?: boolean;
22
+ /** 样式前缀 */
13
23
  classPrefix?: string;
24
+ /** 标签页标题栏div样式 */
14
25
  headerStyle?: React.CSSProperties;
26
+ /** 内容div样式 */
15
27
  contentStyle?: React.CSSProperties;
28
+ /** 子组件 */
16
29
  children?: React.ReactElement<TabPaneProps> | React.ReactElement<TabPaneProps>[];
30
+ /** 切换标签之前的钩子函数, 若返回 false 或者返回被 reject 的 Promise,则阻止切换。 */
17
31
  beforeLeave?: (newTabName: TabPaneName, oldTabName: TabPaneName) => void | boolean | Promise<void | boolean>;
32
+ /** tab 被选中时触发 */
18
33
  onTabClick?: (context: TabsPaneContext) => void;
34
+ /** 点击 tabs 的新增按钮后触发 */
19
35
  onTabAdd?: () => void;
36
+ /** 点击 tab 移除按钮时触发 */
20
37
  onTabRemove?: (name: TabPaneName | undefined) => void;
38
+ /** 鼠标右键点击 tab 时触发 */
21
39
  formatter?: (name: TabPaneName | undefined) => void;
22
40
  }
23
41
  export interface Navs {
42
+ /** 选项卡标题 */
24
43
  title: string | React.ReactElement;
44
+ /** 与选项卡绑定值 value 对应的标识符,表示选项卡别名 */
25
45
  name: string;
46
+ /** tab顺序 */
26
47
  index: number;
48
+ /** 是否是激活标签页 */
27
49
  active: boolean;
50
+ /** 是否禁用 */
28
51
  disabled: boolean;
52
+ /** 标签是否可关闭 */
29
53
  closable: boolean;
30
54
  props: TabPaneProps;
31
55
  }
32
56
  export interface TabPaneProps extends BaseProps, NativeProps {
57
+ /** 选项卡标题 */
33
58
  title: string | React.ReactElement;
59
+ /** 与选项卡绑定值 value 对应的标识符,表示选项卡别名 */
34
60
  name: string;
61
+ /** 标签是否可关闭 */
35
62
  closable?: boolean;
63
+ /** 是否禁用 */
36
64
  disabled?: boolean;
65
+ /** 标签是否延迟渲染 */
37
66
  lazy?: boolean;
67
+ /** 样式前缀 */
38
68
  classPrefix?: string;
69
+ /** 激活标签时触发 */
39
70
  onTabShow?: () => void;
71
+ /** 关闭标签页时触发 */
40
72
  onTabClose?: () => void;
73
+ /** 传递给点击事件的额外参数 */
41
74
  data?: Record<TabPaneName, any>;
42
75
  }
43
76
  export interface Scrollable {
77
+ /** 是否可向后滚动 */
44
78
  next?: boolean;
79
+ /** 是否可向前滚动 */
45
80
  prev?: number;
46
81
  }
47
82
  export interface TabsPaneContext {
48
83
  props: TabPaneProps;
49
84
  paneName: TabPaneName | undefined;
85
+ /** 是否是激活标签页 */
50
86
  active: boolean;
87
+ /** tab顺序 */
51
88
  index: number;
89
+ /** 标签是否可关闭 */
52
90
  isClosable: boolean;
53
91
  }
54
92
  export type TabPaneName = string | number;
package/dist/Tag/Tag.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  import React from 'react';
2
2
  import { TagProps } from './typings';
3
- declare const Tag: React.ForwardRefExoticComponent<TagProps & React.RefAttributes<HTMLSpanElement>>;
3
+ declare const Tag: React.ForwardRefExoticComponent<TagProps & React.RefAttributes<HTMLElement>>;
4
4
  export default Tag;