table-v2.d.ts 20 KB

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