Table.d.ts 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275
  1. import type { TableProps as RcTableProps } from '../vc-table/Table';
  2. import type { SpinProps } from '../spin';
  3. import type { TooltipProps } from '../tooltip';
  4. import type { TableRowSelection, GetRowKey, ColumnType, ColumnsType, TableCurrentDataSource, SorterResult, GetPopupContainer, TablePaginationConfig, SortOrder, TableLocale, FilterValue } from './interface';
  5. import type { SizeType } from '../config-provider';
  6. import type { CSSProperties, PropType } from 'vue';
  7. import type { DefaultRecordType } from '../vc-table/interface';
  8. import type { ContextSlots } from './context';
  9. export type { ColumnsType, TablePaginationConfig };
  10. export interface TableProps<RecordType = DefaultRecordType> extends Omit<RcTableProps<RecordType>, 'transformColumns' | 'internalHooks' | 'internalRefs' | 'data' | 'columns' | 'scroll' | 'emptyText' | 'canExpandable' | 'onUpdateInternalRefs'> {
  11. dropdownPrefixCls?: string;
  12. dataSource?: RcTableProps<RecordType>['data'];
  13. columns?: ColumnsType<RecordType>;
  14. pagination?: false | TablePaginationConfig;
  15. loading?: boolean | SpinProps;
  16. size?: SizeType;
  17. bordered?: boolean;
  18. locale?: TableLocale;
  19. onChange?: (pagination: TablePaginationConfig, filters: Record<string, FilterValue | null>, sorter: SorterResult<RecordType> | SorterResult<RecordType>[], extra: TableCurrentDataSource<RecordType>) => void;
  20. rowSelection?: TableRowSelection<RecordType>;
  21. getPopupContainer?: GetPopupContainer;
  22. scroll?: RcTableProps<RecordType>['scroll'] & {
  23. scrollToFirstRowOnChange?: boolean;
  24. };
  25. sortDirections?: SortOrder[];
  26. showSorterTooltip?: boolean | TooltipProps;
  27. }
  28. export declare const tableProps: () => {
  29. prefixCls: {
  30. type: PropType<string>;
  31. default: any;
  32. };
  33. columns: {
  34. type: PropType<ColumnsType<any>>;
  35. default: any;
  36. };
  37. rowKey: {
  38. type: PropType<string | GetRowKey<any>>;
  39. default: any;
  40. };
  41. tableLayout: {
  42. type: PropType<import("../vc-table/interface").TableLayout>;
  43. default: any;
  44. };
  45. rowClassName: {
  46. type: PropType<string | import("../vc-table/interface").RowClassName<any>>;
  47. default: any;
  48. };
  49. title: {
  50. type: PropType<import("../vc-table/interface").PanelRender<any>>;
  51. default: any;
  52. };
  53. footer: {
  54. type: PropType<import("../vc-table/interface").PanelRender<any>>;
  55. default: any;
  56. };
  57. id: {
  58. type: PropType<string>;
  59. default: any;
  60. };
  61. showHeader: {
  62. type: PropType<boolean>;
  63. default: any;
  64. };
  65. components: {
  66. type: PropType<import("../vc-table/interface").TableComponents<any>>;
  67. default: any;
  68. };
  69. customRow: {
  70. type: PropType<import("../vc-table/interface").GetComponentProps<any>>;
  71. default: any;
  72. };
  73. customHeaderRow: {
  74. type: PropType<import("../vc-table/interface").GetComponentProps<import("../vc-table/interface").ColumnType<any>[]>>;
  75. default: any;
  76. };
  77. direction: {
  78. type: PropType<"ltr" | "rtl">;
  79. default: any;
  80. };
  81. expandFixed: {
  82. type: PropType<boolean | "left" | "right">;
  83. default: any;
  84. };
  85. expandColumnWidth: {
  86. type: PropType<number>;
  87. default: any;
  88. };
  89. expandedRowKeys: {
  90. type: PropType<import("../vc-table/interface").Key[]>;
  91. default: import("../vc-table/interface").Key[];
  92. };
  93. defaultExpandedRowKeys: {
  94. type: PropType<import("../vc-table/interface").Key[]>;
  95. default: import("../vc-table/interface").Key[];
  96. };
  97. expandedRowRender: {
  98. type: PropType<import("../vc-table/interface").ExpandedRowRender<any>>;
  99. default: any;
  100. };
  101. expandRowByClick: {
  102. type: PropType<boolean>;
  103. default: any;
  104. };
  105. expandIcon: {
  106. type: PropType<import("../vc-table/interface").RenderExpandIcon<any>>;
  107. default: any;
  108. };
  109. onExpand: {
  110. type: PropType<(expanded: boolean, record: any) => void>;
  111. default: any;
  112. };
  113. onExpandedRowsChange: {
  114. type: PropType<(expandedKeys: import("../vc-table/interface").Key[]) => void>;
  115. default: any;
  116. };
  117. 'onUpdate:expandedRowKeys': {
  118. type: PropType<(expandedKeys: import("../vc-table/interface").Key[]) => void>;
  119. default: any;
  120. };
  121. defaultExpandAllRows: {
  122. type: PropType<boolean>;
  123. default: any;
  124. };
  125. indentSize: {
  126. type: PropType<number>;
  127. default: any;
  128. };
  129. /** @deprecated Please use `EXPAND_COLUMN` in `columns` directly */
  130. expandIconColumnIndex: {
  131. type: PropType<number>;
  132. default: any;
  133. };
  134. showExpandColumn: {
  135. type: BooleanConstructor;
  136. default: any;
  137. };
  138. expandedRowClassName: {
  139. type: PropType<import("../vc-table/interface").RowClassName<any>>;
  140. default: any;
  141. };
  142. childrenColumnName: {
  143. type: PropType<string>;
  144. default: any;
  145. };
  146. rowExpandable: {
  147. type: PropType<(record: any) => boolean>;
  148. default: any;
  149. };
  150. sticky: {
  151. type: PropType<boolean | import("../vc-table/interface").TableSticky>;
  152. default: any;
  153. };
  154. dropdownPrefixCls: StringConstructor;
  155. dataSource: {
  156. type: PropType<any[]>;
  157. default: any;
  158. };
  159. pagination: {
  160. type: PropType<false | TablePaginationConfig>;
  161. default: any;
  162. };
  163. loading: {
  164. type: PropType<boolean | Partial<import("vue").ExtractPropTypes<{
  165. prefixCls: StringConstructor;
  166. spinning: {
  167. type: BooleanConstructor;
  168. default: any;
  169. };
  170. size: PropType<import("../spin/Spin").SpinSize>;
  171. wrapperClassName: StringConstructor;
  172. tip: import("vue-types").VueTypeValidableDef<any>;
  173. delay: NumberConstructor;
  174. indicator: import("vue-types").VueTypeValidableDef<any>;
  175. }>>>;
  176. default: any;
  177. };
  178. size: {
  179. type: PropType<SizeType>;
  180. default: any;
  181. };
  182. bordered: BooleanConstructor;
  183. locale: {
  184. type: PropType<TableLocale>;
  185. default: any;
  186. };
  187. onChange: {
  188. type: PropType<(pagination: TablePaginationConfig, filters: Record<string, FilterValue | null>, sorter: SorterResult | SorterResult[], extra: TableCurrentDataSource) => void>;
  189. default: any;
  190. };
  191. onResizeColumn: {
  192. type: PropType<(w: number, col: ColumnType) => void>;
  193. default: any;
  194. };
  195. rowSelection: {
  196. type: PropType<TableRowSelection<any>>;
  197. default: any;
  198. };
  199. getPopupContainer: {
  200. type: PropType<GetPopupContainer>;
  201. default: any;
  202. };
  203. scroll: {
  204. type: PropType<{
  205. x?: string | number | true;
  206. y?: string | number;
  207. } & {
  208. scrollToFirstRowOnChange?: boolean;
  209. }>;
  210. default: any;
  211. };
  212. sortDirections: {
  213. type: PropType<SortOrder[]>;
  214. default: any;
  215. };
  216. showSorterTooltip: {
  217. type: PropType<boolean | Partial<import("vue").ExtractPropTypes<{
  218. title: import("vue-types").VueTypeValidableDef<any>;
  219. trigger: PropType<import("../tooltip/abstractTooltipProps").TriggerType | import("../tooltip/abstractTooltipProps").TriggerType[]>;
  220. visible: {
  221. type: BooleanConstructor;
  222. default: any;
  223. };
  224. defaultVisible: {
  225. type: BooleanConstructor;
  226. default: any;
  227. };
  228. placement: PropType<import("../tooltip").TooltipPlacement>;
  229. color: StringConstructor;
  230. transitionName: StringConstructor;
  231. overlayStyle: {
  232. type: PropType<CSSProperties>;
  233. default: CSSProperties;
  234. };
  235. overlayClassName: StringConstructor;
  236. openClassName: StringConstructor;
  237. prefixCls: StringConstructor;
  238. mouseEnterDelay: NumberConstructor;
  239. mouseLeaveDelay: NumberConstructor;
  240. getPopupContainer: PropType<(triggerNode: HTMLElement) => HTMLElement>;
  241. arrowPointAtCenter: {
  242. type: BooleanConstructor;
  243. default: any;
  244. };
  245. autoAdjustOverflow: {
  246. type: PropType<boolean | import("../tooltip").AdjustOverflow>;
  247. default: boolean | import("../tooltip").AdjustOverflow;
  248. };
  249. destroyTooltipOnHide: {
  250. type: BooleanConstructor;
  251. default: any;
  252. };
  253. align: {
  254. type: PropType<import("../vc-trigger/interface").AlignType>;
  255. default: import("../vc-trigger/interface").AlignType;
  256. };
  257. builtinPlacements: {
  258. type: PropType<import("../vc-trigger/interface").BuildInPlacements>;
  259. default: import("../vc-trigger/interface").BuildInPlacements;
  260. };
  261. children: ArrayConstructor;
  262. onVisibleChange: PropType<(vis: boolean) => void>;
  263. 'onUpdate:visible': PropType<(vis: boolean) => void>;
  264. }>>>;
  265. default: boolean;
  266. };
  267. contextSlots: {
  268. type: PropType<ContextSlots>;
  269. };
  270. transformCellText: {
  271. type: PropType<import("../vc-table/interface").TransformCellText<any>>;
  272. };
  273. };
  274. declare const Table: import("vue").DefineComponent<TableProps<any>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<TableProps<any>>, {}>;
  275. export default Table;