use-table.d.ts 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. import type { TableV2Props } from './table';
  2. import type { TableGridInstance } from './table-grid';
  3. declare function useTable(props: TableV2Props): {
  4. columns: import("vue").ComputedRef<{
  5. key: import("./types").KeyType;
  6. align?: import("./types").Alignment;
  7. class?: string | import("./types").ClassNameGetter<any> | undefined;
  8. dataKey?: import("./types").KeyType;
  9. fixed?: true | import("./types").FixedDirection;
  10. flexGrow?: import("vue").CSSProperties["flexGrow"];
  11. flexShrink?: import("vue").CSSProperties["flexShrink"];
  12. title?: string;
  13. hidden?: boolean;
  14. headerClass?: string | import("./types").HeaderClassGetter<any> | undefined;
  15. maxWidth?: number;
  16. minWidth?: number;
  17. style?: import("vue").CSSProperties;
  18. sortable?: boolean;
  19. width: number;
  20. cellRenderer?: import("./types").CellRenderer<any> | undefined;
  21. headerCellRenderer?: import("./types").HeaderCellRenderer<any> | undefined;
  22. }[]>;
  23. containerRef: import("vue").Ref<any>;
  24. mainTableRef: import("vue").Ref<TableGridInstance | undefined>;
  25. leftTableRef: import("vue").Ref<TableGridInstance | undefined>;
  26. rightTableRef: import("vue").Ref<TableGridInstance | undefined>;
  27. isDynamic: import("vue").ComputedRef<boolean>;
  28. isResetting: import("vue").ShallowRef<boolean>;
  29. isScrolling: import("vue").ShallowRef<boolean>;
  30. hasFixedColumns: import("vue").ComputedRef<number>;
  31. columnsStyles: import("vue").ComputedRef<Record<import("./types").KeyType | undefined, import("vue").CSSProperties>>;
  32. columnsTotalWidth: import("vue").ComputedRef<number>;
  33. data: import("vue").ComputedRef<any[]>;
  34. expandedRowKeys: import("vue").Ref<import("./types").KeyType[]>;
  35. depthMap: import("vue").Ref<Record<import("./types").KeyType, number>>;
  36. fixedColumnsOnLeft: import("vue").ComputedRef<{
  37. key: import("./types").KeyType;
  38. align?: import("./types").Alignment;
  39. class?: string | import("./types").ClassNameGetter<any> | undefined;
  40. dataKey?: import("./types").KeyType;
  41. fixed?: true | import("./types").FixedDirection;
  42. flexGrow?: import("vue").CSSProperties["flexGrow"];
  43. flexShrink?: import("vue").CSSProperties["flexShrink"];
  44. title?: string;
  45. hidden?: boolean;
  46. headerClass?: string | import("./types").HeaderClassGetter<any> | undefined;
  47. maxWidth?: number;
  48. minWidth?: number;
  49. style?: import("vue").CSSProperties;
  50. sortable?: boolean;
  51. width: number;
  52. cellRenderer?: import("./types").CellRenderer<any> | undefined;
  53. headerCellRenderer?: import("./types").HeaderCellRenderer<any> | undefined;
  54. }[]>;
  55. fixedColumnsOnRight: import("vue").ComputedRef<{
  56. key: import("./types").KeyType;
  57. align?: import("./types").Alignment;
  58. class?: string | import("./types").ClassNameGetter<any> | undefined;
  59. dataKey?: import("./types").KeyType;
  60. fixed?: true | import("./types").FixedDirection;
  61. flexGrow?: import("vue").CSSProperties["flexGrow"];
  62. flexShrink?: import("vue").CSSProperties["flexShrink"];
  63. title?: string;
  64. hidden?: boolean;
  65. headerClass?: string | import("./types").HeaderClassGetter<any> | undefined;
  66. maxWidth?: number;
  67. minWidth?: number;
  68. style?: import("vue").CSSProperties;
  69. sortable?: boolean;
  70. width: number;
  71. cellRenderer?: import("./types").CellRenderer<any> | undefined;
  72. headerCellRenderer?: import("./types").HeaderCellRenderer<any> | undefined;
  73. }[]>;
  74. mainColumns: import("vue").ComputedRef<import("./types").AnyColumns>;
  75. bodyWidth: import("vue").ComputedRef<number>;
  76. emptyStyle: import("vue").ComputedRef<import("vue").CSSProperties>;
  77. rootStyle: import("vue").ComputedRef<import("vue").CSSProperties>;
  78. headerWidth: import("vue").ComputedRef<number>;
  79. footerHeight: import("vue").ComputedRef<import("vue").CSSProperties>;
  80. mainTableHeight: import("vue").ComputedRef<number>;
  81. fixedTableHeight: import("vue").ComputedRef<number>;
  82. leftTableWidth: import("vue").ComputedRef<number>;
  83. rightTableWidth: import("vue").ComputedRef<number>;
  84. showEmpty: import("vue").ComputedRef<boolean>;
  85. getRowHeight: (rowIndex: number) => number;
  86. onColumnSorted: (e: MouseEvent) => void;
  87. onRowHovered: ({ hovered, rowKey }: import("element-plus").RowHoverParams) => void;
  88. onRowExpanded: ({ expanded, rowData, rowIndex, rowKey, }: import("element-plus").RowExpandParams) => void;
  89. onRowsRendered: (params: import("./grid").onRowRenderedParams) => void;
  90. onRowHeightChange: ({ rowKey, height, rowIndex }: import("element-plus").RowHeightChangedParams, fixedDir: import("./types").FixedDirection) => void;
  91. scrollTo: (params: import("./composables").ScrollPos) => void;
  92. scrollToLeft: (scrollLeft: number) => void;
  93. scrollToTop: (scrollTop: number) => void;
  94. scrollToRow: (row: number, strategy?: import("./composables").ScrollStrategy) => void;
  95. onScroll: (params: import("./composables").ScrollPos) => void;
  96. onVerticalScroll: ({ scrollTop }: import("./composables").ScrollPos) => void;
  97. };
  98. export { useTable };
  99. export type UseTableReturn = ReturnType<typeof useTable>;