index.d.ts 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356
  1. export { Alignment as TableV2Alignment, FixedDir as TableV2FixedDir, SortOrder as TableV2SortOrder, } from './src/constants';
  2. export { default as TableV2 } from './src/table-v2';
  3. export * from './src/auto-resizer';
  4. export { placeholderSign as TableV2Placeholder } from './src/private';
  5. export declare const ElTableV2: import("element-plus/es/utils").SFCWithInstall<import("vue").DefineComponent<{
  6. readonly cache: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, never, never, 2, false>;
  7. readonly estimatedRowHeight: {
  8. readonly default: undefined;
  9. readonly type: import("vue").PropType<number>;
  10. readonly required: false;
  11. readonly validator: ((val: unknown) => boolean) | undefined;
  12. readonly __epPropKey: true;
  13. };
  14. readonly rowKey: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").KeyType & {}) | (() => import("./src/types").KeyType) | ((new (...args: any[]) => import("./src/types").KeyType & {}) | (() => import("./src/types").KeyType))[], unknown, unknown, "id", boolean>;
  15. readonly headerClass: {
  16. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => (string | import("./src/table").HeaderClassNameGetter<any>) & {}) | (() => string | import("./src/table").HeaderClassNameGetter<any>) | ((new (...args: any[]) => (string | import("./src/table").HeaderClassNameGetter<any>) & {}) | (() => string | import("./src/table").HeaderClassNameGetter<any>))[], unknown, unknown>>;
  17. readonly required: false;
  18. readonly validator: ((val: unknown) => boolean) | undefined;
  19. __epPropKey: true;
  20. };
  21. readonly headerProps: {
  22. readonly type: import("vue").PropType<any>;
  23. readonly required: false;
  24. readonly validator: ((val: unknown) => boolean) | undefined;
  25. __epPropKey: true;
  26. };
  27. readonly headerCellProps: {
  28. readonly type: import("vue").PropType<any>;
  29. readonly required: false;
  30. readonly validator: ((val: unknown) => boolean) | undefined;
  31. __epPropKey: true;
  32. };
  33. readonly headerHeight: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => (number | number[]) & {}) | (() => number | number[]) | ((new (...args: any[]) => (number | number[]) & {}) | (() => number | number[]))[], unknown, unknown, 50, boolean>;
  34. readonly footerHeight: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
  35. readonly rowClass: {
  36. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => (string | import("./src/table").RowClassNameGetter<any>) & {}) | (() => string | import("./src/table").RowClassNameGetter<any>) | ((new (...args: any[]) => (string | import("./src/table").RowClassNameGetter<any>) & {}) | (() => string | import("./src/table").RowClassNameGetter<any>))[], unknown, unknown>>;
  37. readonly required: false;
  38. readonly validator: ((val: unknown) => boolean) | undefined;
  39. __epPropKey: true;
  40. };
  41. readonly rowProps: {
  42. readonly type: import("vue").PropType<any>;
  43. readonly required: false;
  44. readonly validator: ((val: unknown) => boolean) | undefined;
  45. __epPropKey: true;
  46. };
  47. readonly rowHeight: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 50, boolean>;
  48. readonly cellProps: {
  49. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => Record<string, any> | import("./src/table").ExtraCellPropGetter<any>) | (() => Record<string, any> | import("./src/table").ExtraCellPropGetter<any>) | ((new (...args: any[]) => Record<string, any> | import("./src/table").ExtraCellPropGetter<any>) | (() => Record<string, any> | import("./src/table").ExtraCellPropGetter<any>))[], unknown, unknown>>;
  50. readonly required: false;
  51. readonly validator: ((val: unknown) => boolean) | undefined;
  52. __epPropKey: true;
  53. };
  54. readonly columns: {
  55. readonly type: import("vue").PropType<import("./src/common").AnyColumn[]>;
  56. readonly required: true;
  57. readonly validator: ((val: unknown) => boolean) | undefined;
  58. __epPropKey: true;
  59. };
  60. readonly data: {
  61. readonly type: import("vue").PropType<any[]>;
  62. readonly required: true;
  63. readonly validator: ((val: unknown) => boolean) | undefined;
  64. __epPropKey: true;
  65. };
  66. readonly dataGetter: {
  67. readonly type: import("vue").PropType<import("./src/types").DataGetter<any>>;
  68. readonly required: false;
  69. readonly validator: ((val: unknown) => boolean) | undefined;
  70. __epPropKey: true;
  71. };
  72. readonly fixedData: {
  73. readonly type: import("vue").PropType<any[]>;
  74. readonly required: false;
  75. readonly validator: ((val: unknown) => boolean) | undefined;
  76. __epPropKey: true;
  77. };
  78. readonly expandColumnKey: StringConstructor;
  79. readonly expandedRowKeys: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").KeyType[]) | (() => import("./src/types").KeyType[]) | ((new (...args: any[]) => import("./src/types").KeyType[]) | (() => import("./src/types").KeyType[]))[], unknown, unknown, () => never[], boolean>;
  80. readonly defaultExpandedRowKeys: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").KeyType[]) | (() => import("./src/types").KeyType[]) | ((new (...args: any[]) => import("./src/types").KeyType[]) | (() => import("./src/types").KeyType[]))[], unknown, unknown, () => never[], boolean>;
  81. readonly class: StringConstructor;
  82. readonly fixed: BooleanConstructor;
  83. readonly style: {
  84. readonly type: import("vue").PropType<import("vue").CSSProperties>;
  85. readonly required: false;
  86. readonly validator: ((val: unknown) => boolean) | undefined;
  87. __epPropKey: true;
  88. };
  89. readonly width: {
  90. readonly type: import("vue").PropType<number>;
  91. readonly required: true;
  92. readonly validator: ((val: unknown) => boolean) | undefined;
  93. __epPropKey: true;
  94. };
  95. readonly height: {
  96. readonly type: import("vue").PropType<number>;
  97. readonly required: true;
  98. readonly validator: ((val: unknown) => boolean) | undefined;
  99. __epPropKey: true;
  100. };
  101. readonly maxHeight: NumberConstructor;
  102. readonly useIsScrolling: BooleanConstructor;
  103. readonly indentSize: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 12, boolean>;
  104. readonly iconSize: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 12, boolean>;
  105. readonly hScrollbarSize: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 6, boolean>;
  106. readonly vScrollbarSize: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 6, boolean>;
  107. readonly scrollbarAlwaysOn: BooleanConstructor;
  108. readonly sortBy: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").SortBy) | (() => import("./src/types").SortBy) | ((new (...args: any[]) => import("./src/types").SortBy) | (() => import("./src/types").SortBy))[], unknown, unknown, () => {
  109. key: import("./src/types").KeyType;
  110. order: import("./src/constants").SortOrder;
  111. }, boolean>;
  112. readonly sortState: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").SortState) | (() => import("./src/types").SortState) | ((new (...args: any[]) => import("./src/types").SortState) | (() => import("./src/types").SortState))[], unknown, unknown, undefined, boolean>;
  113. readonly onColumnSort: {
  114. readonly type: import("vue").PropType<import("./src/table").ColumnSortHandler<any>>;
  115. readonly required: false;
  116. readonly validator: ((val: unknown) => boolean) | undefined;
  117. __epPropKey: true;
  118. };
  119. readonly onExpandedRowsChange: {
  120. readonly type: import("vue").PropType<import("./src/table").ExpandedRowsChangeHandler>;
  121. readonly required: false;
  122. readonly validator: ((val: unknown) => boolean) | undefined;
  123. __epPropKey: true;
  124. };
  125. readonly onEndReached: {
  126. readonly type: import("vue").PropType<(distance: number) => void>;
  127. readonly required: false;
  128. readonly validator: ((val: unknown) => boolean) | undefined;
  129. __epPropKey: true;
  130. };
  131. readonly onRowExpand: {
  132. readonly type: import("vue").PropType<import("./src/row").RowExpandHandler>;
  133. readonly required: false;
  134. readonly validator: ((val: unknown) => boolean) | undefined;
  135. __epPropKey: true;
  136. };
  137. readonly onScroll: {
  138. readonly type: import("vue").PropType<(...args: any[]) => void>;
  139. readonly required: false;
  140. readonly validator: ((val: unknown) => boolean) | undefined;
  141. __epPropKey: true;
  142. };
  143. readonly onRowsRendered: {
  144. readonly type: import("vue").PropType<(params: import("./src/grid").onRowRenderedParams) => void>;
  145. readonly required: false;
  146. readonly validator: ((val: unknown) => boolean) | undefined;
  147. __epPropKey: true;
  148. };
  149. readonly rowEventHandlers: {
  150. readonly type: import("vue").PropType<import("./src/row").RowEventHandlers>;
  151. readonly required: false;
  152. readonly validator: ((val: unknown) => boolean) | undefined;
  153. __epPropKey: true;
  154. };
  155. }, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
  156. readonly cache: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, never, never, 2, false>;
  157. readonly estimatedRowHeight: {
  158. readonly default: undefined;
  159. readonly type: import("vue").PropType<number>;
  160. readonly required: false;
  161. readonly validator: ((val: unknown) => boolean) | undefined;
  162. readonly __epPropKey: true;
  163. };
  164. readonly rowKey: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").KeyType & {}) | (() => import("./src/types").KeyType) | ((new (...args: any[]) => import("./src/types").KeyType & {}) | (() => import("./src/types").KeyType))[], unknown, unknown, "id", boolean>;
  165. readonly headerClass: {
  166. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => (string | import("./src/table").HeaderClassNameGetter<any>) & {}) | (() => string | import("./src/table").HeaderClassNameGetter<any>) | ((new (...args: any[]) => (string | import("./src/table").HeaderClassNameGetter<any>) & {}) | (() => string | import("./src/table").HeaderClassNameGetter<any>))[], unknown, unknown>>;
  167. readonly required: false;
  168. readonly validator: ((val: unknown) => boolean) | undefined;
  169. __epPropKey: true;
  170. };
  171. readonly headerProps: {
  172. readonly type: import("vue").PropType<any>;
  173. readonly required: false;
  174. readonly validator: ((val: unknown) => boolean) | undefined;
  175. __epPropKey: true;
  176. };
  177. readonly headerCellProps: {
  178. readonly type: import("vue").PropType<any>;
  179. readonly required: false;
  180. readonly validator: ((val: unknown) => boolean) | undefined;
  181. __epPropKey: true;
  182. };
  183. readonly headerHeight: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => (number | number[]) & {}) | (() => number | number[]) | ((new (...args: any[]) => (number | number[]) & {}) | (() => number | number[]))[], unknown, unknown, 50, boolean>;
  184. readonly footerHeight: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
  185. readonly rowClass: {
  186. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => (string | import("./src/table").RowClassNameGetter<any>) & {}) | (() => string | import("./src/table").RowClassNameGetter<any>) | ((new (...args: any[]) => (string | import("./src/table").RowClassNameGetter<any>) & {}) | (() => string | import("./src/table").RowClassNameGetter<any>))[], unknown, unknown>>;
  187. readonly required: false;
  188. readonly validator: ((val: unknown) => boolean) | undefined;
  189. __epPropKey: true;
  190. };
  191. readonly rowProps: {
  192. readonly type: import("vue").PropType<any>;
  193. readonly required: false;
  194. readonly validator: ((val: unknown) => boolean) | undefined;
  195. __epPropKey: true;
  196. };
  197. readonly rowHeight: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 50, boolean>;
  198. readonly cellProps: {
  199. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => Record<string, any> | import("./src/table").ExtraCellPropGetter<any>) | (() => Record<string, any> | import("./src/table").ExtraCellPropGetter<any>) | ((new (...args: any[]) => Record<string, any> | import("./src/table").ExtraCellPropGetter<any>) | (() => Record<string, any> | import("./src/table").ExtraCellPropGetter<any>))[], unknown, unknown>>;
  200. readonly required: false;
  201. readonly validator: ((val: unknown) => boolean) | undefined;
  202. __epPropKey: true;
  203. };
  204. readonly columns: {
  205. readonly type: import("vue").PropType<import("./src/common").AnyColumn[]>;
  206. readonly required: true;
  207. readonly validator: ((val: unknown) => boolean) | undefined;
  208. __epPropKey: true;
  209. };
  210. readonly data: {
  211. readonly type: import("vue").PropType<any[]>;
  212. readonly required: true;
  213. readonly validator: ((val: unknown) => boolean) | undefined;
  214. __epPropKey: true;
  215. };
  216. readonly dataGetter: {
  217. readonly type: import("vue").PropType<import("./src/types").DataGetter<any>>;
  218. readonly required: false;
  219. readonly validator: ((val: unknown) => boolean) | undefined;
  220. __epPropKey: true;
  221. };
  222. readonly fixedData: {
  223. readonly type: import("vue").PropType<any[]>;
  224. readonly required: false;
  225. readonly validator: ((val: unknown) => boolean) | undefined;
  226. __epPropKey: true;
  227. };
  228. readonly expandColumnKey: StringConstructor;
  229. readonly expandedRowKeys: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").KeyType[]) | (() => import("./src/types").KeyType[]) | ((new (...args: any[]) => import("./src/types").KeyType[]) | (() => import("./src/types").KeyType[]))[], unknown, unknown, () => never[], boolean>;
  230. readonly defaultExpandedRowKeys: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").KeyType[]) | (() => import("./src/types").KeyType[]) | ((new (...args: any[]) => import("./src/types").KeyType[]) | (() => import("./src/types").KeyType[]))[], unknown, unknown, () => never[], boolean>;
  231. readonly class: StringConstructor;
  232. readonly fixed: BooleanConstructor;
  233. readonly style: {
  234. readonly type: import("vue").PropType<import("vue").CSSProperties>;
  235. readonly required: false;
  236. readonly validator: ((val: unknown) => boolean) | undefined;
  237. __epPropKey: true;
  238. };
  239. readonly width: {
  240. readonly type: import("vue").PropType<number>;
  241. readonly required: true;
  242. readonly validator: ((val: unknown) => boolean) | undefined;
  243. __epPropKey: true;
  244. };
  245. readonly height: {
  246. readonly type: import("vue").PropType<number>;
  247. readonly required: true;
  248. readonly validator: ((val: unknown) => boolean) | undefined;
  249. __epPropKey: true;
  250. };
  251. readonly maxHeight: NumberConstructor;
  252. readonly useIsScrolling: BooleanConstructor;
  253. readonly indentSize: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 12, boolean>;
  254. readonly iconSize: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 12, boolean>;
  255. readonly hScrollbarSize: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 6, boolean>;
  256. readonly vScrollbarSize: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 6, boolean>;
  257. readonly scrollbarAlwaysOn: BooleanConstructor;
  258. readonly sortBy: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").SortBy) | (() => import("./src/types").SortBy) | ((new (...args: any[]) => import("./src/types").SortBy) | (() => import("./src/types").SortBy))[], unknown, unknown, () => {
  259. key: import("./src/types").KeyType;
  260. order: import("./src/constants").SortOrder;
  261. }, boolean>;
  262. readonly sortState: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").SortState) | (() => import("./src/types").SortState) | ((new (...args: any[]) => import("./src/types").SortState) | (() => import("./src/types").SortState))[], unknown, unknown, undefined, boolean>;
  263. readonly onColumnSort: {
  264. readonly type: import("vue").PropType<import("./src/table").ColumnSortHandler<any>>;
  265. readonly required: false;
  266. readonly validator: ((val: unknown) => boolean) | undefined;
  267. __epPropKey: true;
  268. };
  269. readonly onExpandedRowsChange: {
  270. readonly type: import("vue").PropType<import("./src/table").ExpandedRowsChangeHandler>;
  271. readonly required: false;
  272. readonly validator: ((val: unknown) => boolean) | undefined;
  273. __epPropKey: true;
  274. };
  275. readonly onEndReached: {
  276. readonly type: import("vue").PropType<(distance: number) => void>;
  277. readonly required: false;
  278. readonly validator: ((val: unknown) => boolean) | undefined;
  279. __epPropKey: true;
  280. };
  281. readonly onRowExpand: {
  282. readonly type: import("vue").PropType<import("./src/row").RowExpandHandler>;
  283. readonly required: false;
  284. readonly validator: ((val: unknown) => boolean) | undefined;
  285. __epPropKey: true;
  286. };
  287. readonly onScroll: {
  288. readonly type: import("vue").PropType<(...args: any[]) => void>;
  289. readonly required: false;
  290. readonly validator: ((val: unknown) => boolean) | undefined;
  291. __epPropKey: true;
  292. };
  293. readonly onRowsRendered: {
  294. readonly type: import("vue").PropType<(params: import("./src/grid").onRowRenderedParams) => void>;
  295. readonly required: false;
  296. readonly validator: ((val: unknown) => boolean) | undefined;
  297. __epPropKey: true;
  298. };
  299. readonly rowEventHandlers: {
  300. readonly type: import("vue").PropType<import("./src/row").RowEventHandlers>;
  301. readonly required: false;
  302. readonly validator: ((val: unknown) => boolean) | undefined;
  303. __epPropKey: true;
  304. };
  305. }>>, {
  306. readonly fixed: boolean;
  307. readonly scrollbarAlwaysOn: boolean;
  308. readonly rowKey: import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => import("./src/types").KeyType & {}) | (() => import("./src/types").KeyType) | ((new (...args: any[]) => import("./src/types").KeyType & {}) | (() => import("./src/types").KeyType))[], unknown, unknown>;
  309. readonly headerHeight: import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => (number | number[]) & {}) | (() => number | number[]) | ((new (...args: any[]) => (number | number[]) & {}) | (() => number | number[]))[], unknown, unknown>;
  310. readonly sortBy: import("./src/types").SortBy;
  311. readonly estimatedRowHeight: number;
  312. readonly useIsScrolling: boolean;
  313. readonly rowHeight: number;
  314. readonly hScrollbarSize: number;
  315. readonly vScrollbarSize: number;
  316. readonly cache: number;
  317. readonly footerHeight: number;
  318. readonly indentSize: number;
  319. readonly iconSize: number;
  320. readonly sortState: import("./src/types").SortState;
  321. readonly expandedRowKeys: import("./src/types").KeyType[];
  322. readonly defaultExpandedRowKeys: import("./src/types").KeyType[];
  323. }>> & Record<string, any>;
  324. export declare const ElAutoResizer: import("element-plus/es/utils").SFCWithInstall<import("vue").DefineComponent<{
  325. readonly disableWidth: BooleanConstructor;
  326. readonly disableHeight: BooleanConstructor;
  327. readonly onResize: {
  328. readonly type: import("vue").PropType<(event: {
  329. height: number;
  330. width: number;
  331. }) => void>;
  332. readonly required: false;
  333. readonly validator: ((val: unknown) => boolean) | undefined;
  334. __epPropKey: true;
  335. };
  336. }, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
  337. readonly disableWidth: BooleanConstructor;
  338. readonly disableHeight: BooleanConstructor;
  339. readonly onResize: {
  340. readonly type: import("vue").PropType<(event: {
  341. height: number;
  342. width: number;
  343. }) => void>;
  344. readonly required: false;
  345. readonly validator: ((val: unknown) => boolean) | undefined;
  346. __epPropKey: true;
  347. };
  348. }>>, {
  349. readonly disableWidth: boolean;
  350. readonly disableHeight: boolean;
  351. }>> & Record<string, any>;
  352. export type { Column, Columns, SortBy, SortState, TableV2CustomizedHeaderSlotParam, } from './src/types';
  353. export type { TableV2Instance } from './src/table-v2';
  354. export * from './src/table';
  355. export * from './src/row';
  356. export type { HeaderCellSlotProps } from './src/renderers/header-cell';