@tanstack/table-core 9.0.0-alpha.0 → 9.0.0-alpha.11

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 (570) hide show
  1. package/dist/esm/core/cells/constructCell.d.ts +7 -0
  2. package/dist/esm/core/cells/constructCell.js +21 -0
  3. package/dist/esm/core/cells/constructCell.js.map +1 -0
  4. package/dist/esm/core/cells/coreCellsFeature.d.ts +10 -0
  5. package/dist/esm/core/cells/coreCellsFeature.js +26 -0
  6. package/dist/esm/core/cells/coreCellsFeature.js.map +1 -0
  7. package/dist/esm/core/cells/coreCellsFeature.types.d.ts +52 -0
  8. package/dist/esm/core/cells/coreCellsFeature.utils.d.ts +13 -0
  9. package/dist/esm/core/cells/coreCellsFeature.utils.js +23 -0
  10. package/dist/esm/core/cells/coreCellsFeature.utils.js.map +1 -0
  11. package/dist/esm/core/columns/constructColumn.d.ts +6 -0
  12. package/dist/esm/core/columns/constructColumn.js +60 -0
  13. package/dist/esm/core/columns/constructColumn.js.map +1 -0
  14. package/dist/esm/core/columns/coreColumnsFeature.d.ts +10 -0
  15. package/dist/esm/core/columns/coreColumnsFeature.js +61 -0
  16. package/dist/esm/core/columns/coreColumnsFeature.js.map +1 -0
  17. package/dist/esm/core/columns/coreColumnsFeature.types.d.ts +84 -0
  18. package/dist/esm/core/columns/coreColumnsFeature.utils.d.ts +13 -0
  19. package/dist/esm/core/columns/coreColumnsFeature.utils.js +91 -0
  20. package/dist/esm/core/columns/coreColumnsFeature.utils.js.map +1 -0
  21. package/dist/esm/core/coreFeatures.d.ts +15 -0
  22. package/dist/esm/core/coreFeatures.js +18 -0
  23. package/dist/esm/core/coreFeatures.js.map +1 -0
  24. package/dist/esm/core/headers/buildHeaderGroups.d.ts +6 -0
  25. package/dist/esm/core/headers/buildHeaderGroups.js +99 -0
  26. package/dist/esm/core/headers/buildHeaderGroups.js.map +1 -0
  27. package/dist/esm/core/headers/constructHeader.d.ts +12 -0
  28. package/dist/esm/core/headers/constructHeader.js +28 -0
  29. package/dist/esm/core/headers/constructHeader.js.map +1 -0
  30. package/dist/esm/core/headers/coreHeadersFeature.d.ts +10 -0
  31. package/dist/esm/core/headers/coreHeadersFeature.js +68 -0
  32. package/dist/esm/core/headers/coreHeadersFeature.js.map +1 -0
  33. package/dist/esm/core/headers/coreHeadersFeature.types.d.ts +99 -0
  34. package/dist/esm/core/headers/coreHeadersFeature.utils.d.ts +15 -0
  35. package/dist/esm/core/headers/coreHeadersFeature.utils.js +85 -0
  36. package/dist/esm/core/headers/coreHeadersFeature.utils.js.map +1 -0
  37. package/dist/esm/core/row-models/coreRowModelsFeature.d.ts +10 -0
  38. package/dist/esm/core/row-models/coreRowModelsFeature.js +52 -0
  39. package/dist/esm/core/row-models/coreRowModelsFeature.js.map +1 -0
  40. package/dist/esm/core/row-models/coreRowModelsFeature.types.d.ts +39 -0
  41. package/dist/esm/core/row-models/coreRowModelsFeature.utils.d.ts +16 -0
  42. package/dist/esm/core/row-models/coreRowModelsFeature.utils.js +85 -0
  43. package/dist/esm/core/row-models/coreRowModelsFeature.utils.js.map +1 -0
  44. package/dist/esm/core/row-models/createCoreRowModel.d.ts +5 -0
  45. package/dist/esm/core/row-models/createCoreRowModel.js +54 -0
  46. package/dist/esm/core/row-models/createCoreRowModel.js.map +1 -0
  47. package/dist/esm/core/rows/constructRow.d.ts +5 -0
  48. package/dist/esm/core/rows/constructRow.js +29 -0
  49. package/dist/esm/core/rows/constructRow.js.map +1 -0
  50. package/dist/esm/core/rows/coreRowsFeature.d.ts +10 -0
  51. package/dist/esm/core/rows/coreRowsFeature.js +52 -0
  52. package/dist/esm/core/rows/coreRowsFeature.js.map +1 -0
  53. package/dist/esm/core/rows/coreRowsFeature.types.d.ts +91 -0
  54. package/dist/esm/core/rows/coreRowsFeature.utils.d.ts +15 -0
  55. package/dist/esm/core/rows/coreRowsFeature.utils.js +94 -0
  56. package/dist/esm/core/rows/coreRowsFeature.utils.js.map +1 -0
  57. package/dist/esm/core/table/constructTable.d.ts +9 -0
  58. package/dist/esm/core/table/constructTable.js +65 -0
  59. package/dist/esm/core/table/constructTable.js.map +1 -0
  60. package/dist/esm/core/table/coreTablesFeature.d.ts +10 -0
  61. package/dist/esm/core/table/coreTablesFeature.js +22 -0
  62. package/dist/esm/core/table/coreTablesFeature.js.map +1 -0
  63. package/dist/esm/core/table/coreTablesFeature.types.d.ts +105 -0
  64. package/dist/esm/core/table/coreTablesFeature.utils.d.ts +7 -0
  65. package/dist/esm/core/table/coreTablesFeature.utils.js +23 -0
  66. package/dist/esm/core/table/coreTablesFeature.utils.js.map +1 -0
  67. package/dist/esm/features/column-faceting/columnFacetingFeature.d.ts +10 -0
  68. package/dist/esm/features/column-faceting/columnFacetingFeature.js +80 -0
  69. package/dist/esm/features/column-faceting/columnFacetingFeature.js.map +1 -0
  70. package/dist/esm/features/column-faceting/columnFacetingFeature.types.d.ts +68 -0
  71. package/dist/esm/features/column-faceting/columnFacetingFeature.utils.d.ts +11 -0
  72. package/dist/esm/features/column-faceting/columnFacetingFeature.utils.js +33 -0
  73. package/dist/esm/features/column-faceting/columnFacetingFeature.utils.js.map +1 -0
  74. package/dist/esm/features/column-faceting/createFacetedMinMaxValues.d.ts +4 -0
  75. package/dist/esm/features/column-faceting/createFacetedMinMaxValues.js +41 -0
  76. package/dist/esm/features/column-faceting/createFacetedMinMaxValues.js.map +1 -0
  77. package/dist/esm/features/column-faceting/createFacetedRowModel.d.ts +5 -0
  78. package/dist/esm/features/column-faceting/createFacetedRowModel.js +47 -0
  79. package/dist/esm/features/column-faceting/createFacetedRowModel.js.map +1 -0
  80. package/dist/esm/features/column-faceting/createFacetedUniqueValues.d.ts +4 -0
  81. package/dist/esm/features/column-faceting/createFacetedUniqueValues.js +46 -0
  82. package/dist/esm/features/column-faceting/createFacetedUniqueValues.js.map +1 -0
  83. package/dist/esm/features/column-filtering/columnFilteringFeature.d.ts +11 -0
  84. package/dist/esm/features/column-filtering/columnFilteringFeature.js +69 -0
  85. package/dist/esm/features/column-filtering/columnFilteringFeature.js.map +1 -0
  86. package/dist/esm/features/column-filtering/columnFilteringFeature.types.d.ts +145 -0
  87. package/dist/esm/features/column-filtering/columnFilteringFeature.utils.d.ts +16 -0
  88. package/dist/esm/features/column-filtering/columnFilteringFeature.utils.js +118 -0
  89. package/dist/esm/features/column-filtering/columnFilteringFeature.utils.js.map +1 -0
  90. package/dist/esm/features/column-filtering/createFilteredRowModel.d.ts +6 -0
  91. package/dist/esm/features/column-filtering/createFilteredRowModel.js +110 -0
  92. package/dist/esm/features/column-filtering/createFilteredRowModel.js.map +1 -0
  93. package/dist/esm/features/column-filtering/filterRowsUtils.d.ts +6 -0
  94. package/dist/esm/{utils → features/column-filtering}/filterRowsUtils.js +15 -19
  95. package/dist/esm/features/column-filtering/filterRowsUtils.js.map +1 -0
  96. package/dist/esm/features/column-grouping/columnGroupingFeature.d.ts +10 -0
  97. package/dist/esm/features/column-grouping/columnGroupingFeature.js +91 -0
  98. package/dist/esm/features/column-grouping/columnGroupingFeature.js.map +1 -0
  99. package/dist/esm/features/column-grouping/columnGroupingFeature.types.d.ts +153 -0
  100. package/dist/esm/features/column-grouping/columnGroupingFeature.utils.d.ts +22 -0
  101. package/dist/esm/features/column-grouping/columnGroupingFeature.utils.js +99 -0
  102. package/dist/esm/features/column-grouping/columnGroupingFeature.utils.js.map +1 -0
  103. package/dist/esm/features/column-grouping/createGroupedRowModel.d.ts +6 -0
  104. package/dist/esm/features/column-grouping/createGroupedRowModel.js +144 -0
  105. package/dist/esm/features/column-grouping/createGroupedRowModel.js.map +1 -0
  106. package/dist/esm/features/column-ordering/columnOrderingFeature.d.ts +10 -0
  107. package/dist/esm/features/column-ordering/columnOrderingFeature.js +60 -0
  108. package/dist/esm/features/column-ordering/columnOrderingFeature.js.map +1 -0
  109. package/dist/{cjs/features/ColumnOrdering.d.cts → esm/features/column-ordering/columnOrderingFeature.types.d.ts} +8 -22
  110. package/dist/esm/features/column-ordering/columnOrderingFeature.utils.d.ts +14 -0
  111. package/dist/esm/features/column-ordering/columnOrderingFeature.utils.js +72 -0
  112. package/dist/esm/features/column-ordering/columnOrderingFeature.utils.js.map +1 -0
  113. package/dist/esm/features/column-pinning/columnPinningFeature.d.ts +10 -0
  114. package/dist/esm/features/column-pinning/columnPinningFeature.js +260 -0
  115. package/dist/esm/features/column-pinning/columnPinningFeature.js.map +1 -0
  116. package/dist/esm/features/column-pinning/columnPinningFeature.types.d.ts +157 -0
  117. package/dist/esm/features/column-pinning/columnPinningFeature.utils.d.ts +39 -0
  118. package/dist/esm/features/column-pinning/columnPinningFeature.utils.js +325 -0
  119. package/dist/esm/features/column-pinning/columnPinningFeature.utils.js.map +1 -0
  120. package/dist/esm/features/column-resizing/columnResizingFeature.d.ts +11 -0
  121. package/dist/esm/features/column-resizing/columnResizingFeature.js +52 -0
  122. package/dist/esm/features/column-resizing/columnResizingFeature.js.map +1 -0
  123. package/dist/esm/features/column-resizing/columnResizingFeature.types.d.ts +68 -0
  124. package/dist/esm/features/column-resizing/columnResizingFeature.utils.d.ts +14 -0
  125. package/dist/esm/features/column-resizing/columnResizingFeature.utils.js +193 -0
  126. package/dist/esm/features/column-resizing/columnResizingFeature.utils.js.map +1 -0
  127. package/dist/esm/features/column-sizing/columnSizingFeature.d.ts +11 -0
  128. package/dist/esm/features/column-sizing/columnSizingFeature.js +95 -0
  129. package/dist/esm/features/column-sizing/columnSizingFeature.js.map +1 -0
  130. package/dist/esm/features/column-sizing/columnSizingFeature.types.d.ts +81 -0
  131. package/dist/esm/features/column-sizing/columnSizingFeature.utils.d.ts +25 -0
  132. package/dist/esm/features/column-sizing/columnSizingFeature.utils.js +128 -0
  133. package/dist/esm/features/column-sizing/columnSizingFeature.utils.js.map +1 -0
  134. package/dist/esm/features/column-visibility/columnVisibilityFeature.d.ts +10 -0
  135. package/dist/esm/features/column-visibility/columnVisibilityFeature.js +100 -0
  136. package/dist/esm/features/column-visibility/columnVisibilityFeature.js.map +1 -0
  137. package/dist/esm/features/column-visibility/columnVisibilityFeature.types.d.ts +84 -0
  138. package/dist/esm/features/column-visibility/columnVisibilityFeature.utils.d.ts +22 -0
  139. package/dist/esm/features/column-visibility/columnVisibilityFeature.utils.js +105 -0
  140. package/dist/esm/features/column-visibility/columnVisibilityFeature.utils.js.map +1 -0
  141. package/dist/esm/features/global-filtering/globalFilteringFeature.d.ts +11 -0
  142. package/dist/esm/features/global-filtering/globalFilteringFeature.js +51 -0
  143. package/dist/esm/features/global-filtering/globalFilteringFeature.js.map +1 -0
  144. package/dist/esm/features/global-filtering/globalFilteringFeature.types.d.ts +59 -0
  145. package/dist/esm/features/global-filtering/globalFilteringFeature.utils.d.ts +10 -0
  146. package/dist/esm/features/global-filtering/globalFilteringFeature.utils.js +30 -0
  147. package/dist/esm/features/global-filtering/globalFilteringFeature.utils.js.map +1 -0
  148. package/dist/esm/features/row-expanding/createExpandedRowModel.d.ts +6 -0
  149. package/dist/esm/features/row-expanding/createExpandedRowModel.js +49 -0
  150. package/dist/esm/features/row-expanding/createExpandedRowModel.js.map +1 -0
  151. package/dist/esm/features/row-expanding/rowExpandingFeature.d.ts +10 -0
  152. package/dist/esm/features/row-expanding/rowExpandingFeature.js +74 -0
  153. package/dist/esm/features/row-expanding/rowExpandingFeature.js.map +1 -0
  154. package/dist/esm/features/row-expanding/rowExpandingFeature.types.d.ts +116 -0
  155. package/dist/esm/features/row-expanding/rowExpandingFeature.utils.d.ts +20 -0
  156. package/dist/esm/features/row-expanding/rowExpandingFeature.utils.js +125 -0
  157. package/dist/esm/features/row-expanding/rowExpandingFeature.utils.js.map +1 -0
  158. package/dist/esm/features/row-pagination/createPaginatedRowModel.d.ts +5 -0
  159. package/dist/esm/features/row-pagination/createPaginatedRowModel.js +58 -0
  160. package/dist/esm/features/row-pagination/createPaginatedRowModel.js.map +1 -0
  161. package/dist/esm/features/row-pagination/rowPaginationFeature.d.ts +10 -0
  162. package/dist/esm/features/row-pagination/rowPaginationFeature.js +78 -0
  163. package/dist/esm/features/row-pagination/rowPaginationFeature.js.map +1 -0
  164. package/dist/esm/features/row-pagination/rowPaginationFeature.types.d.ts +119 -0
  165. package/dist/esm/features/row-pagination/rowPaginationFeature.utils.d.ts +21 -0
  166. package/dist/esm/features/row-pagination/rowPaginationFeature.utils.js +126 -0
  167. package/dist/esm/features/row-pagination/rowPaginationFeature.utils.js.map +1 -0
  168. package/dist/esm/features/row-pinning/rowPinningFeature.d.ts +10 -0
  169. package/dist/esm/features/row-pinning/rowPinningFeature.js +80 -0
  170. package/dist/esm/features/row-pinning/rowPinningFeature.js.map +1 -0
  171. package/dist/esm/features/row-pinning/rowPinningFeature.types.d.ts +72 -0
  172. package/dist/esm/features/row-pinning/rowPinningFeature.utils.d.ts +16 -0
  173. package/dist/esm/features/row-pinning/rowPinningFeature.utils.js +115 -0
  174. package/dist/esm/features/row-pinning/rowPinningFeature.utils.js.map +1 -0
  175. package/dist/esm/features/row-selection/rowSelectionFeature.d.ts +10 -0
  176. package/dist/esm/features/row-selection/rowSelectionFeature.js +112 -0
  177. package/dist/esm/features/row-selection/rowSelectionFeature.js.map +1 -0
  178. package/dist/esm/features/row-selection/rowSelectionFeature.types.d.ts +123 -0
  179. package/dist/esm/features/row-selection/rowSelectionFeature.utils.d.ts +34 -0
  180. package/dist/esm/features/row-selection/rowSelectionFeature.utils.js +290 -0
  181. package/dist/esm/features/row-selection/rowSelectionFeature.utils.js.map +1 -0
  182. package/dist/esm/features/row-sorting/createSortedRowModel.d.ts +6 -0
  183. package/dist/esm/features/row-sorting/createSortedRowModel.js +94 -0
  184. package/dist/esm/features/row-sorting/createSortedRowModel.js.map +1 -0
  185. package/dist/esm/features/row-sorting/rowSortingFeature.d.ts +10 -0
  186. package/dist/esm/features/row-sorting/rowSortingFeature.js +82 -0
  187. package/dist/esm/features/row-sorting/rowSortingFeature.js.map +1 -0
  188. package/dist/esm/features/row-sorting/rowSortingFeature.types.d.ts +178 -0
  189. package/dist/esm/features/row-sorting/rowSortingFeature.utils.d.ts +20 -0
  190. package/dist/esm/features/row-sorting/rowSortingFeature.utils.js +181 -0
  191. package/dist/esm/features/row-sorting/rowSortingFeature.utils.js.map +1 -0
  192. package/dist/esm/features/stockFeatures.d.ts +31 -0
  193. package/dist/esm/features/stockFeatures.js +34 -0
  194. package/dist/esm/features/stockFeatures.js.map +1 -0
  195. package/dist/esm/fns/aggregationFns.d.ts +49 -0
  196. package/dist/esm/fns/aggregationFns.js +110 -0
  197. package/dist/esm/fns/aggregationFns.js.map +1 -0
  198. package/dist/esm/fns/filterFns.d.ts +76 -0
  199. package/dist/esm/fns/filterFns.js +134 -0
  200. package/dist/esm/fns/filterFns.js.map +1 -0
  201. package/dist/esm/fns/sortFns.d.ts +17 -0
  202. package/dist/esm/{sortingFns.js → fns/sortFns.js} +21 -15
  203. package/dist/esm/fns/sortFns.js.map +1 -0
  204. package/dist/esm/helpers/columnHelper.d.ts +61 -0
  205. package/dist/esm/{columnHelper.js → helpers/columnHelper.js} +1 -0
  206. package/dist/esm/helpers/columnHelper.js.map +1 -0
  207. package/dist/esm/helpers/tableFeatures.d.ts +13 -0
  208. package/dist/esm/helpers/tableFeatures.js +7 -0
  209. package/dist/esm/helpers/tableFeatures.js.map +1 -0
  210. package/dist/esm/helpers/tableHelper.d.ts +25 -0
  211. package/dist/esm/helpers/tableHelper.js +13 -0
  212. package/dist/esm/helpers/tableHelper.js.map +1 -0
  213. package/dist/esm/helpers/tableOptions.d.ts +23 -0
  214. package/dist/esm/helpers/tableOptions.js +7 -0
  215. package/dist/esm/helpers/tableOptions.js.map +1 -0
  216. package/dist/esm/index.d.ts +109 -33
  217. package/dist/esm/index.js +397 -65
  218. package/dist/esm/index.js.map +1 -1
  219. package/dist/esm/types/Cell.d.ts +13 -0
  220. package/dist/esm/types/Column.d.ts +26 -0
  221. package/dist/esm/types/ColumnDef.d.ts +64 -0
  222. package/dist/esm/types/Header.d.ts +14 -0
  223. package/dist/esm/types/HeaderGroup.d.ts +12 -0
  224. package/dist/esm/types/Row.d.ts +19 -0
  225. package/dist/esm/types/RowModel.d.ts +23 -0
  226. package/dist/esm/types/RowModelFns.d.ts +15 -0
  227. package/dist/esm/types/Table.d.ts +53 -0
  228. package/dist/esm/types/TableFeatures.d.ts +77 -0
  229. package/dist/esm/types/TableOptions.d.ts +39 -0
  230. package/dist/esm/types/TableState.d.ts +23 -0
  231. package/dist/esm/types/type-utils.d.ts +22 -0
  232. package/dist/esm/utils.d.ts +66 -33
  233. package/dist/esm/utils.js +183 -52
  234. package/dist/esm/utils.js.map +1 -1
  235. package/package.json +21 -12
  236. package/src/core/cells/constructCell.ts +49 -0
  237. package/src/core/cells/coreCellsFeature.ts +44 -0
  238. package/src/core/cells/coreCellsFeature.types.ts +68 -0
  239. package/src/core/cells/coreCellsFeature.utils.ts +35 -0
  240. package/src/core/columns/constructColumn.ts +111 -0
  241. package/src/core/columns/coreColumnsFeature.ts +90 -0
  242. package/src/core/columns/coreColumnsFeature.types.ts +103 -0
  243. package/src/core/columns/coreColumnsFeature.utils.ts +160 -0
  244. package/src/core/coreFeatures.ts +24 -0
  245. package/src/core/headers/buildHeaderGroups.ts +177 -0
  246. package/src/core/headers/constructHeader.ts +61 -0
  247. package/src/core/headers/coreHeadersFeature.ts +98 -0
  248. package/src/core/headers/coreHeadersFeature.types.ts +123 -0
  249. package/src/core/headers/coreHeadersFeature.utils.ts +131 -0
  250. package/src/core/row-models/coreRowModelsFeature.ts +78 -0
  251. package/src/core/row-models/coreRowModelsFeature.types.ts +67 -0
  252. package/src/core/row-models/coreRowModelsFeature.utils.ts +140 -0
  253. package/src/core/row-models/createCoreRowModel.ts +88 -0
  254. package/src/core/rows/constructRow.ts +59 -0
  255. package/src/core/rows/coreRowsFeature.ts +84 -0
  256. package/src/core/rows/coreRowsFeature.types.ts +111 -0
  257. package/src/core/rows/coreRowsFeature.utils.ts +152 -0
  258. package/src/core/table/constructTable.ts +95 -0
  259. package/src/core/table/coreTablesFeature.ts +36 -0
  260. package/src/core/table/coreTablesFeature.types.ts +123 -0
  261. package/src/core/table/coreTablesFeature.utils.ts +40 -0
  262. package/src/features/column-faceting/columnFacetingFeature.ts +112 -0
  263. package/src/features/column-faceting/columnFacetingFeature.types.ts +97 -0
  264. package/src/features/column-faceting/columnFacetingFeature.utils.ts +77 -0
  265. package/src/features/column-faceting/createFacetedMinMaxValues.ts +63 -0
  266. package/src/features/column-faceting/createFacetedRowModel.ts +76 -0
  267. package/src/features/column-faceting/createFacetedUniqueValues.ts +60 -0
  268. package/src/features/column-filtering/columnFilteringFeature.ts +121 -0
  269. package/src/features/column-filtering/columnFilteringFeature.types.ts +219 -0
  270. package/src/features/column-filtering/columnFilteringFeature.utils.ts +213 -0
  271. package/src/features/column-filtering/createFilteredRowModel.ts +171 -0
  272. package/src/features/column-filtering/filterRowsUtils.ts +152 -0
  273. package/src/features/column-grouping/columnGroupingFeature.ts +151 -0
  274. package/src/features/column-grouping/columnGroupingFeature.types.ts +218 -0
  275. package/src/features/column-grouping/columnGroupingFeature.utils.ts +192 -0
  276. package/src/features/column-grouping/createGroupedRowModel.ts +215 -0
  277. package/src/features/column-ordering/columnOrderingFeature.ts +96 -0
  278. package/src/features/column-ordering/columnOrderingFeature.types.ts +49 -0
  279. package/src/features/column-ordering/columnOrderingFeature.utils.ts +133 -0
  280. package/src/features/column-pinning/columnPinningFeature.ts +324 -0
  281. package/src/features/column-pinning/columnPinningFeature.types.ts +176 -0
  282. package/src/features/column-pinning/columnPinningFeature.utils.ts +537 -0
  283. package/src/features/column-resizing/columnResizingFeature.ts +92 -0
  284. package/src/features/column-resizing/columnResizingFeature.types.ts +81 -0
  285. package/src/features/column-resizing/columnResizingFeature.utils.ts +265 -0
  286. package/src/features/column-sizing/columnSizingFeature.ts +146 -0
  287. package/src/features/column-sizing/columnSizingFeature.types.ts +92 -0
  288. package/src/features/column-sizing/columnSizingFeature.utils.ts +211 -0
  289. package/src/features/column-visibility/columnVisibilityFeature.ts +155 -0
  290. package/src/features/column-visibility/columnVisibilityFeature.types.ts +101 -0
  291. package/src/features/column-visibility/columnVisibilityFeature.utils.ts +183 -0
  292. package/src/features/global-filtering/globalFilteringFeature.ts +92 -0
  293. package/src/features/global-filtering/globalFilteringFeature.types.ts +84 -0
  294. package/src/features/global-filtering/globalFilteringFeature.utils.ts +60 -0
  295. package/src/features/row-expanding/createExpandedRowModel.ts +72 -0
  296. package/src/features/row-expanding/rowExpandingFeature.ts +122 -0
  297. package/src/features/row-expanding/rowExpandingFeature.types.ts +141 -0
  298. package/src/features/row-expanding/rowExpandingFeature.utils.ts +207 -0
  299. package/src/features/row-pagination/createPaginatedRowModel.ts +78 -0
  300. package/src/features/row-pagination/rowPaginationFeature.ts +121 -0
  301. package/src/features/row-pagination/rowPaginationFeature.types.ts +141 -0
  302. package/src/features/row-pagination/rowPaginationFeature.utils.ts +204 -0
  303. package/src/features/row-pinning/rowPinningFeature.ts +121 -0
  304. package/src/features/row-pinning/rowPinningFeature.types.ts +89 -0
  305. package/src/features/row-pinning/rowPinningFeature.utils.ts +197 -0
  306. package/src/features/row-selection/rowSelectionFeature.ts +164 -0
  307. package/src/features/row-selection/rowSelectionFeature.types.ts +143 -0
  308. package/src/features/row-selection/rowSelectionFeature.utils.ts +464 -0
  309. package/src/features/row-sorting/createSortedRowModel.ts +147 -0
  310. package/src/features/row-sorting/rowSortingFeature.ts +136 -0
  311. package/src/features/row-sorting/rowSortingFeature.types.ts +229 -0
  312. package/src/features/row-sorting/rowSortingFeature.utils.ts +320 -0
  313. package/src/features/stockFeatures.ts +48 -0
  314. package/src/fns/aggregationFns.ts +220 -0
  315. package/src/fns/filterFns.ts +379 -0
  316. package/src/{sortingFns.ts → fns/sortFns.ts} +66 -21
  317. package/src/helpers/columnHelper.ts +117 -0
  318. package/src/helpers/tableFeatures.ts +24 -0
  319. package/src/helpers/tableHelper.ts +61 -0
  320. package/src/helpers/tableOptions.ts +82 -0
  321. package/src/index.ts +156 -42
  322. package/src/types/Cell.ts +41 -0
  323. package/src/types/Column.ts +86 -0
  324. package/src/types/ColumnDef.ts +217 -0
  325. package/src/types/Header.ts +45 -0
  326. package/src/types/HeaderGroup.ts +24 -0
  327. package/src/types/Row.ts +55 -0
  328. package/src/types/RowModel.ts +137 -0
  329. package/src/types/RowModelFns.ts +51 -0
  330. package/src/types/Table.ts +125 -0
  331. package/src/types/TableFeatures.ts +150 -0
  332. package/src/types/TableOptions.ts +125 -0
  333. package/src/types/TableState.ts +88 -0
  334. package/src/types/type-utils.ts +84 -0
  335. package/src/utils.ts +344 -163
  336. package/dist/cjs/aggregationFns.cjs +0 -98
  337. package/dist/cjs/aggregationFns.cjs.map +0 -1
  338. package/dist/cjs/aggregationFns.d.cts +0 -14
  339. package/dist/cjs/columnHelper.cjs +0 -19
  340. package/dist/cjs/columnHelper.cjs.map +0 -1
  341. package/dist/cjs/columnHelper.d.cts +0 -9
  342. package/dist/cjs/core/cell.cjs +0 -38
  343. package/dist/cjs/core/cell.cjs.map +0 -1
  344. package/dist/cjs/core/cell.d.cts +0 -50
  345. package/dist/cjs/core/column.cjs +0 -81
  346. package/dist/cjs/core/column.cjs.map +0 -1
  347. package/dist/cjs/core/column.d.cts +0 -56
  348. package/dist/cjs/core/headers.cjs +0 -310
  349. package/dist/cjs/core/headers.cjs.map +0 -1
  350. package/dist/cjs/core/headers.d.cts +0 -195
  351. package/dist/cjs/core/row.cjs +0 -93
  352. package/dist/cjs/core/row.cjs.map +0 -1
  353. package/dist/cjs/core/row.d.cts +0 -92
  354. package/dist/cjs/core/table.cjs +0 -228
  355. package/dist/cjs/core/table.cjs.map +0 -1
  356. package/dist/cjs/core/table.d.cts +0 -221
  357. package/dist/cjs/features/ColumnFaceting.cjs +0 -29
  358. package/dist/cjs/features/ColumnFaceting.cjs.map +0 -1
  359. package/dist/cjs/features/ColumnFaceting.d.cts +0 -35
  360. package/dist/cjs/features/ColumnFiltering.cjs +0 -137
  361. package/dist/cjs/features/ColumnFiltering.cjs.map +0 -1
  362. package/dist/cjs/features/ColumnFiltering.d.cts +0 -195
  363. package/dist/cjs/features/ColumnGrouping.cjs +0 -134
  364. package/dist/cjs/features/ColumnGrouping.cjs.map +0 -1
  365. package/dist/cjs/features/ColumnGrouping.d.cts +0 -202
  366. package/dist/cjs/features/ColumnOrdering.cjs +0 -76
  367. package/dist/cjs/features/ColumnOrdering.cjs.map +0 -1
  368. package/dist/cjs/features/ColumnPinning.cjs +0 -145
  369. package/dist/cjs/features/ColumnPinning.cjs.map +0 -1
  370. package/dist/cjs/features/ColumnPinning.d.cts +0 -127
  371. package/dist/cjs/features/ColumnSizing.cjs +0 -308
  372. package/dist/cjs/features/ColumnSizing.cjs.map +0 -1
  373. package/dist/cjs/features/ColumnSizing.d.cts +0 -194
  374. package/dist/cjs/features/ColumnVisibility.cjs +0 -144
  375. package/dist/cjs/features/ColumnVisibility.cjs.map +0 -1
  376. package/dist/cjs/features/ColumnVisibility.d.cts +0 -130
  377. package/dist/cjs/features/GlobalFaceting.cjs +0 -29
  378. package/dist/cjs/features/GlobalFaceting.cjs.map +0 -1
  379. package/dist/cjs/features/GlobalFaceting.d.cts +0 -27
  380. package/dist/cjs/features/GlobalFiltering.cjs +0 -50
  381. package/dist/cjs/features/GlobalFiltering.cjs.map +0 -1
  382. package/dist/cjs/features/GlobalFiltering.d.cts +0 -80
  383. package/dist/cjs/features/RowExpanding.cjs +0 -154
  384. package/dist/cjs/features/RowExpanding.cjs.map +0 -1
  385. package/dist/cjs/features/RowExpanding.d.cts +0 -155
  386. package/dist/cjs/features/RowPagination.cjs +0 -162
  387. package/dist/cjs/features/RowPagination.cjs.map +0 -1
  388. package/dist/cjs/features/RowPagination.d.cts +0 -166
  389. package/dist/cjs/features/RowPinning.cjs +0 -133
  390. package/dist/cjs/features/RowPinning.cjs.map +0 -1
  391. package/dist/cjs/features/RowPinning.d.cts +0 -99
  392. package/dist/cjs/features/RowSelection.cjs +0 -298
  393. package/dist/cjs/features/RowSelection.cjs.map +0 -1
  394. package/dist/cjs/features/RowSelection.d.cts +0 -177
  395. package/dist/cjs/features/RowSorting.cjs +0 -201
  396. package/dist/cjs/features/RowSorting.cjs.map +0 -1
  397. package/dist/cjs/features/RowSorting.d.cts +0 -238
  398. package/dist/cjs/filterFns.cjs +0 -88
  399. package/dist/cjs/filterFns.cjs.map +0 -1
  400. package/dist/cjs/filterFns.d.cts +0 -14
  401. package/dist/cjs/index.cjs +0 -87
  402. package/dist/cjs/index.cjs.map +0 -1
  403. package/dist/cjs/index.d.cts +0 -34
  404. package/dist/cjs/sortingFns.cjs +0 -91
  405. package/dist/cjs/sortingFns.cjs.map +0 -1
  406. package/dist/cjs/sortingFns.d.cts +0 -12
  407. package/dist/cjs/types.d.cts +0 -120
  408. package/dist/cjs/utils/filterRowsUtils.cjs +0 -99
  409. package/dist/cjs/utils/filterRowsUtils.cjs.map +0 -1
  410. package/dist/cjs/utils/filterRowsUtils.d.cts +0 -3
  411. package/dist/cjs/utils/getCoreRowModel.cjs +0 -54
  412. package/dist/cjs/utils/getCoreRowModel.cjs.map +0 -1
  413. package/dist/cjs/utils/getCoreRowModel.d.cts +0 -3
  414. package/dist/cjs/utils/getExpandedRowModel.cjs +0 -41
  415. package/dist/cjs/utils/getExpandedRowModel.cjs.map +0 -1
  416. package/dist/cjs/utils/getExpandedRowModel.d.cts +0 -8
  417. package/dist/cjs/utils/getFacetedMinMaxValues.cjs +0 -36
  418. package/dist/cjs/utils/getFacetedMinMaxValues.cjs.map +0 -1
  419. package/dist/cjs/utils/getFacetedMinMaxValues.d.cts +0 -3
  420. package/dist/cjs/utils/getFacetedRowModel.cjs +0 -35
  421. package/dist/cjs/utils/getFacetedRowModel.cjs.map +0 -1
  422. package/dist/cjs/utils/getFacetedRowModel.d.cts +0 -3
  423. package/dist/cjs/utils/getFacetedUniqueValues.cjs +0 -38
  424. package/dist/cjs/utils/getFacetedUniqueValues.cjs.map +0 -1
  425. package/dist/cjs/utils/getFacetedUniqueValues.d.cts +0 -3
  426. package/dist/cjs/utils/getFilteredRowModel.cjs +0 -116
  427. package/dist/cjs/utils/getFilteredRowModel.cjs.map +0 -1
  428. package/dist/cjs/utils/getFilteredRowModel.d.cts +0 -3
  429. package/dist/cjs/utils/getGroupedRowModel.cjs +0 -118
  430. package/dist/cjs/utils/getGroupedRowModel.cjs.map +0 -1
  431. package/dist/cjs/utils/getGroupedRowModel.d.cts +0 -3
  432. package/dist/cjs/utils/getPaginationRowModel.cjs +0 -49
  433. package/dist/cjs/utils/getPaginationRowModel.cjs.map +0 -1
  434. package/dist/cjs/utils/getPaginationRowModel.d.cts +0 -5
  435. package/dist/cjs/utils/getSortedRowModel.cjs +0 -91
  436. package/dist/cjs/utils/getSortedRowModel.cjs.map +0 -1
  437. package/dist/cjs/utils/getSortedRowModel.d.cts +0 -3
  438. package/dist/cjs/utils.cjs +0 -100
  439. package/dist/cjs/utils.cjs.map +0 -1
  440. package/dist/cjs/utils.d.cts +0 -39
  441. package/dist/esm/aggregationFns.d.ts +0 -14
  442. package/dist/esm/aggregationFns.js +0 -98
  443. package/dist/esm/aggregationFns.js.map +0 -1
  444. package/dist/esm/columnHelper.d.ts +0 -9
  445. package/dist/esm/columnHelper.js.map +0 -1
  446. package/dist/esm/core/cell.d.ts +0 -50
  447. package/dist/esm/core/cell.js +0 -38
  448. package/dist/esm/core/cell.js.map +0 -1
  449. package/dist/esm/core/column.d.ts +0 -56
  450. package/dist/esm/core/column.js +0 -81
  451. package/dist/esm/core/column.js.map +0 -1
  452. package/dist/esm/core/headers.d.ts +0 -195
  453. package/dist/esm/core/headers.js +0 -310
  454. package/dist/esm/core/headers.js.map +0 -1
  455. package/dist/esm/core/row.d.ts +0 -92
  456. package/dist/esm/core/row.js +0 -93
  457. package/dist/esm/core/row.js.map +0 -1
  458. package/dist/esm/core/table.d.ts +0 -221
  459. package/dist/esm/core/table.js +0 -228
  460. package/dist/esm/core/table.js.map +0 -1
  461. package/dist/esm/features/ColumnFaceting.d.ts +0 -35
  462. package/dist/esm/features/ColumnFaceting.js +0 -29
  463. package/dist/esm/features/ColumnFaceting.js.map +0 -1
  464. package/dist/esm/features/ColumnFiltering.d.ts +0 -195
  465. package/dist/esm/features/ColumnFiltering.js +0 -137
  466. package/dist/esm/features/ColumnFiltering.js.map +0 -1
  467. package/dist/esm/features/ColumnGrouping.d.ts +0 -202
  468. package/dist/esm/features/ColumnGrouping.js +0 -134
  469. package/dist/esm/features/ColumnGrouping.js.map +0 -1
  470. package/dist/esm/features/ColumnOrdering.d.ts +0 -54
  471. package/dist/esm/features/ColumnOrdering.js +0 -76
  472. package/dist/esm/features/ColumnOrdering.js.map +0 -1
  473. package/dist/esm/features/ColumnPinning.d.ts +0 -127
  474. package/dist/esm/features/ColumnPinning.js +0 -145
  475. package/dist/esm/features/ColumnPinning.js.map +0 -1
  476. package/dist/esm/features/ColumnSizing.d.ts +0 -194
  477. package/dist/esm/features/ColumnSizing.js +0 -308
  478. package/dist/esm/features/ColumnSizing.js.map +0 -1
  479. package/dist/esm/features/ColumnVisibility.d.ts +0 -130
  480. package/dist/esm/features/ColumnVisibility.js +0 -144
  481. package/dist/esm/features/ColumnVisibility.js.map +0 -1
  482. package/dist/esm/features/GlobalFaceting.d.ts +0 -27
  483. package/dist/esm/features/GlobalFaceting.js +0 -29
  484. package/dist/esm/features/GlobalFaceting.js.map +0 -1
  485. package/dist/esm/features/GlobalFiltering.d.ts +0 -80
  486. package/dist/esm/features/GlobalFiltering.js +0 -50
  487. package/dist/esm/features/GlobalFiltering.js.map +0 -1
  488. package/dist/esm/features/RowExpanding.d.ts +0 -155
  489. package/dist/esm/features/RowExpanding.js +0 -154
  490. package/dist/esm/features/RowExpanding.js.map +0 -1
  491. package/dist/esm/features/RowPagination.d.ts +0 -166
  492. package/dist/esm/features/RowPagination.js +0 -162
  493. package/dist/esm/features/RowPagination.js.map +0 -1
  494. package/dist/esm/features/RowPinning.d.ts +0 -99
  495. package/dist/esm/features/RowPinning.js +0 -133
  496. package/dist/esm/features/RowPinning.js.map +0 -1
  497. package/dist/esm/features/RowSelection.d.ts +0 -177
  498. package/dist/esm/features/RowSelection.js +0 -298
  499. package/dist/esm/features/RowSelection.js.map +0 -1
  500. package/dist/esm/features/RowSorting.d.ts +0 -238
  501. package/dist/esm/features/RowSorting.js +0 -201
  502. package/dist/esm/features/RowSorting.js.map +0 -1
  503. package/dist/esm/filterFns.d.ts +0 -14
  504. package/dist/esm/filterFns.js +0 -88
  505. package/dist/esm/filterFns.js.map +0 -1
  506. package/dist/esm/sortingFns.d.ts +0 -12
  507. package/dist/esm/sortingFns.js.map +0 -1
  508. package/dist/esm/types.d.ts +0 -120
  509. package/dist/esm/utils/filterRowsUtils.d.ts +0 -3
  510. package/dist/esm/utils/filterRowsUtils.js.map +0 -1
  511. package/dist/esm/utils/getCoreRowModel.d.ts +0 -3
  512. package/dist/esm/utils/getCoreRowModel.js +0 -54
  513. package/dist/esm/utils/getCoreRowModel.js.map +0 -1
  514. package/dist/esm/utils/getExpandedRowModel.d.ts +0 -8
  515. package/dist/esm/utils/getExpandedRowModel.js +0 -41
  516. package/dist/esm/utils/getExpandedRowModel.js.map +0 -1
  517. package/dist/esm/utils/getFacetedMinMaxValues.d.ts +0 -3
  518. package/dist/esm/utils/getFacetedMinMaxValues.js +0 -36
  519. package/dist/esm/utils/getFacetedMinMaxValues.js.map +0 -1
  520. package/dist/esm/utils/getFacetedRowModel.d.ts +0 -3
  521. package/dist/esm/utils/getFacetedRowModel.js +0 -35
  522. package/dist/esm/utils/getFacetedRowModel.js.map +0 -1
  523. package/dist/esm/utils/getFacetedUniqueValues.d.ts +0 -3
  524. package/dist/esm/utils/getFacetedUniqueValues.js +0 -38
  525. package/dist/esm/utils/getFacetedUniqueValues.js.map +0 -1
  526. package/dist/esm/utils/getFilteredRowModel.d.ts +0 -3
  527. package/dist/esm/utils/getFilteredRowModel.js +0 -116
  528. package/dist/esm/utils/getFilteredRowModel.js.map +0 -1
  529. package/dist/esm/utils/getGroupedRowModel.d.ts +0 -3
  530. package/dist/esm/utils/getGroupedRowModel.js +0 -118
  531. package/dist/esm/utils/getGroupedRowModel.js.map +0 -1
  532. package/dist/esm/utils/getPaginationRowModel.d.ts +0 -5
  533. package/dist/esm/utils/getPaginationRowModel.js +0 -49
  534. package/dist/esm/utils/getPaginationRowModel.js.map +0 -1
  535. package/dist/esm/utils/getSortedRowModel.d.ts +0 -3
  536. package/dist/esm/utils/getSortedRowModel.js +0 -91
  537. package/dist/esm/utils/getSortedRowModel.js.map +0 -1
  538. package/src/aggregationFns.ts +0 -123
  539. package/src/columnHelper.ts +0 -91
  540. package/src/core/cell.ts +0 -91
  541. package/src/core/column.ts +0 -165
  542. package/src/core/headers.ts +0 -639
  543. package/src/core/row.ts +0 -201
  544. package/src/core/table.ts +0 -527
  545. package/src/features/ColumnFaceting.ts +0 -84
  546. package/src/features/ColumnFiltering.ts +0 -429
  547. package/src/features/ColumnGrouping.ts +0 -422
  548. package/src/features/ColumnOrdering.ts +0 -161
  549. package/src/features/ColumnPinning.ts +0 -336
  550. package/src/features/ColumnSizing.ts +0 -579
  551. package/src/features/ColumnVisibility.ts +0 -317
  552. package/src/features/GlobalFaceting.ts +0 -66
  553. package/src/features/GlobalFiltering.ts +0 -162
  554. package/src/features/RowExpanding.ts +0 -355
  555. package/src/features/RowPagination.ts +0 -396
  556. package/src/features/RowPinning.ts +0 -273
  557. package/src/features/RowSelection.ts +0 -668
  558. package/src/features/RowSorting.ts +0 -542
  559. package/src/filterFns.ts +0 -150
  560. package/src/types.ts +0 -361
  561. package/src/utils/filterRowsUtils.ts +0 -130
  562. package/src/utils/getCoreRowModel.ts +0 -82
  563. package/src/utils/getExpandedRowModel.ts +0 -51
  564. package/src/utils/getFacetedMinMaxValues.ts +0 -42
  565. package/src/utils/getFacetedRowModel.ts +0 -44
  566. package/src/utils/getFacetedUniqueValues.ts +0 -42
  567. package/src/utils/getFilteredRowModel.ts +0 -151
  568. package/src/utils/getGroupedRowModel.ts +0 -181
  569. package/src/utils/getPaginationRowModel.ts +0 -60
  570. package/src/utils/getSortedRowModel.ts +0 -121
@@ -1,396 +0,0 @@
1
- import {
2
- OnChangeFn,
3
- Table,
4
- RowModel,
5
- Updater,
6
- RowData,
7
- TableFeature,
8
- } from '../types'
9
- import {
10
- functionalUpdate,
11
- getMemoOptions,
12
- makeStateUpdater,
13
- memo,
14
- } from '../utils'
15
-
16
- export interface PaginationState {
17
- pageIndex: number
18
- pageSize: number
19
- }
20
-
21
- export interface PaginationTableState {
22
- pagination: PaginationState
23
- }
24
-
25
- export interface PaginationInitialTableState {
26
- pagination?: Partial<PaginationState>
27
- }
28
-
29
- export interface PaginationOptions {
30
- /**
31
- * If set to `true`, pagination will be reset to the first page when page-altering state changes eg. `data` is updated, filters change, grouping changes, etc.
32
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#autoresetpageindex)
33
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
34
- */
35
- autoResetPageIndex?: boolean
36
- /**
37
- * Returns the row model after pagination has taken place, but no further.
38
- *
39
- * Pagination columns are automatically reordered by default to the start of the columns list. If you would rather remove them or leave them as-is, set the appropriate mode here.
40
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getpaginationrowmodel)
41
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
42
- */
43
- getPaginationRowModel?: (table: Table<any>) => () => RowModel<any>
44
- /**
45
- * Enables manual pagination. If this option is set to `true`, the table will not automatically paginate rows using `getPaginationRowModel()` and instead will expect you to manually paginate the rows before passing them to the table. This is useful if you are doing server-side pagination and aggregation.
46
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#manualpagination)
47
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
48
- */
49
- manualPagination?: boolean
50
- /**
51
- * If this function is provided, it will be called when the pagination state changes and you will be expected to manage the state yourself. You can pass the managed state back to the table via the `tableOptions.state.pagination` option.
52
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#onpaginationchange)
53
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
54
- */
55
- onPaginationChange?: OnChangeFn<PaginationState>
56
- /**
57
- * When manually controlling pagination, you can supply a total `pageCount` value to the table if you know it (Or supply a `rowCount` and `pageCount` will be calculated). If you do not know how many pages there are, you can set this to `-1`.
58
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#pagecount)
59
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
60
- */
61
- pageCount?: number
62
- /**
63
- * When manually controlling pagination, you can supply a total `rowCount` value to the table if you know it. The `pageCount` can be calculated from this value and the `pageSize`.
64
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#rowcount)
65
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
66
- */
67
- rowCount?: number
68
- }
69
-
70
- export interface PaginationDefaultOptions {
71
- onPaginationChange: OnChangeFn<PaginationState>
72
- }
73
-
74
- export interface PaginationInstance<TData extends RowData> {
75
- _autoResetPageIndex: () => void
76
- _getPaginationRowModel?: () => RowModel<TData>
77
- /**
78
- * Returns whether the table can go to the next page.
79
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getcannextpage)
80
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
81
- */
82
- getCanNextPage: () => boolean
83
- /**
84
- * Returns whether the table can go to the previous page.
85
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getcanpreviouspage)
86
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
87
- */
88
- getCanPreviousPage: () => boolean
89
- /**
90
- * Returns the page count. If manually paginating or controlling the pagination state, this will come directly from the `options.pageCount` table option, otherwise it will be calculated from the table data using the total row count and current page size.
91
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getpagecount)
92
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
93
- */
94
- getPageCount: () => number
95
- /**
96
- * Returns the row count. If manually paginating or controlling the pagination state, this will come directly from the `options.rowCount` table option, otherwise it will be calculated from the table data.
97
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getrowcount)
98
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
99
- */
100
- getRowCount: () => number
101
- /**
102
- * Returns an array of page options (zero-index-based) for the current page size.
103
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getpageoptions)
104
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
105
- */
106
- getPageOptions: () => number[]
107
- /**
108
- * Returns the row model for the table after pagination has been applied.
109
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getpaginationrowmodel)
110
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
111
- */
112
- getPaginationRowModel: () => RowModel<TData>
113
- /**
114
- * Returns the row model for the table before any pagination has been applied.
115
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getprepaginationrowmodel)
116
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
117
- */
118
- getPrePaginationRowModel: () => RowModel<TData>
119
- /**
120
- * Increments the page index by one, if possible.
121
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#nextpage)
122
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
123
- */
124
- nextPage: () => void
125
- /**
126
- * Decrements the page index by one, if possible.
127
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#previouspage)
128
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
129
- */
130
- previousPage: () => void
131
- /**
132
- * Sets the page index to `0`.
133
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#firstpage)
134
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
135
- */
136
- firstPage: () => void
137
- /**
138
- * Sets the page index to the last page.
139
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#lastpage)
140
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
141
- */
142
- lastPage: () => void
143
- /**
144
- * Resets the page index to its initial state. If `defaultState` is `true`, the page index will be reset to `0` regardless of initial state.
145
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#resetpageindex)
146
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
147
- */
148
- resetPageIndex: (defaultState?: boolean) => void
149
- /**
150
- * Resets the page size to its initial state. If `defaultState` is `true`, the page size will be reset to `10` regardless of initial state.
151
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#resetpagesize)
152
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
153
- */
154
- resetPageSize: (defaultState?: boolean) => void
155
- /**
156
- * Resets the **pagination** state to `initialState.pagination`, or `true` can be passed to force a default blank state reset to `[]`.
157
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#resetpagination)
158
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
159
- */
160
- resetPagination: (defaultState?: boolean) => void
161
- /**
162
- * @deprecated The page count no longer exists in the pagination state. Just pass as a table option instead.
163
- */
164
- setPageCount: (updater: Updater<number>) => void
165
- /**
166
- * Updates the page index using the provided function or value in the `state.pagination.pageIndex` state.
167
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#setpageindex)
168
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
169
- */
170
- setPageIndex: (updater: Updater<number>) => void
171
- /**
172
- * Updates the page size using the provided function or value in the `state.pagination.pageSize` state.
173
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#setpagesize)
174
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
175
- */
176
- setPageSize: (updater: Updater<number>) => void
177
- /**
178
- * Sets or updates the `state.pagination` state.
179
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#setpagination)
180
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
181
- */
182
- setPagination: (updater: Updater<PaginationState>) => void
183
- }
184
-
185
- //
186
-
187
- const defaultPageIndex = 0
188
- const defaultPageSize = 10
189
-
190
- const getDefaultPaginationState = (): PaginationState => ({
191
- pageIndex: defaultPageIndex,
192
- pageSize: defaultPageSize,
193
- })
194
-
195
- export const RowPagination: TableFeature = {
196
- getInitialState: (state): PaginationTableState => {
197
- return {
198
- ...state,
199
- pagination: {
200
- ...getDefaultPaginationState(),
201
- ...state?.pagination,
202
- },
203
- }
204
- },
205
-
206
- getDefaultOptions: <TData extends RowData>(
207
- table: Table<TData>
208
- ): PaginationDefaultOptions => {
209
- return {
210
- onPaginationChange: makeStateUpdater('pagination', table),
211
- }
212
- },
213
-
214
- createTable: <TData extends RowData>(table: Table<TData>): void => {
215
- let registered = false
216
- let queued = false
217
-
218
- table._autoResetPageIndex = () => {
219
- if (!registered) {
220
- table._queue(() => {
221
- registered = true
222
- })
223
- return
224
- }
225
-
226
- if (
227
- table.options.autoResetAll ??
228
- table.options.autoResetPageIndex ??
229
- !table.options.manualPagination
230
- ) {
231
- if (queued) return
232
- queued = true
233
- table._queue(() => {
234
- table.resetPageIndex()
235
- queued = false
236
- })
237
- }
238
- }
239
- table.setPagination = updater => {
240
- const safeUpdater: Updater<PaginationState> = old => {
241
- let newState = functionalUpdate(updater, old)
242
-
243
- return newState
244
- }
245
-
246
- return table.options.onPaginationChange?.(safeUpdater)
247
- }
248
- table.resetPagination = defaultState => {
249
- table.setPagination(
250
- defaultState
251
- ? getDefaultPaginationState()
252
- : table.initialState.pagination ?? getDefaultPaginationState()
253
- )
254
- }
255
- table.setPageIndex = updater => {
256
- table.setPagination(old => {
257
- let pageIndex = functionalUpdate(updater, old.pageIndex)
258
-
259
- const maxPageIndex =
260
- typeof table.options.pageCount === 'undefined' ||
261
- table.options.pageCount === -1
262
- ? Number.MAX_SAFE_INTEGER
263
- : table.options.pageCount - 1
264
-
265
- pageIndex = Math.max(0, Math.min(pageIndex, maxPageIndex))
266
-
267
- return {
268
- ...old,
269
- pageIndex,
270
- }
271
- })
272
- }
273
- table.resetPageIndex = defaultState => {
274
- table.setPageIndex(
275
- defaultState
276
- ? defaultPageIndex
277
- : table.initialState?.pagination?.pageIndex ?? defaultPageIndex
278
- )
279
- }
280
- table.resetPageSize = defaultState => {
281
- table.setPageSize(
282
- defaultState
283
- ? defaultPageSize
284
- : table.initialState?.pagination?.pageSize ?? defaultPageSize
285
- )
286
- }
287
- table.setPageSize = updater => {
288
- table.setPagination(old => {
289
- const pageSize = Math.max(1, functionalUpdate(updater, old.pageSize))
290
- const topRowIndex = old.pageSize * old.pageIndex!
291
- const pageIndex = Math.floor(topRowIndex / pageSize)
292
-
293
- return {
294
- ...old,
295
- pageIndex,
296
- pageSize,
297
- }
298
- })
299
- }
300
- //deprecated
301
- table.setPageCount = updater =>
302
- table.setPagination(old => {
303
- let newPageCount = functionalUpdate(
304
- updater,
305
- table.options.pageCount ?? -1
306
- )
307
-
308
- if (typeof newPageCount === 'number') {
309
- newPageCount = Math.max(-1, newPageCount)
310
- }
311
-
312
- return {
313
- ...old,
314
- pageCount: newPageCount,
315
- }
316
- })
317
-
318
- table.getPageOptions = memo(
319
- () => [table.getPageCount()],
320
- pageCount => {
321
- let pageOptions: number[] = []
322
- if (pageCount && pageCount > 0) {
323
- pageOptions = [...new Array(pageCount)].fill(null).map((_, i) => i)
324
- }
325
- return pageOptions
326
- },
327
- getMemoOptions(table.options, 'debugTable', 'getPageOptions')
328
- )
329
-
330
- table.getCanPreviousPage = () => table.getState().pagination.pageIndex > 0
331
-
332
- table.getCanNextPage = () => {
333
- const { pageIndex } = table.getState().pagination
334
-
335
- const pageCount = table.getPageCount()
336
-
337
- if (pageCount === -1) {
338
- return true
339
- }
340
-
341
- if (pageCount === 0) {
342
- return false
343
- }
344
-
345
- return pageIndex < pageCount - 1
346
- }
347
-
348
- table.previousPage = () => {
349
- return table.setPageIndex(old => old - 1)
350
- }
351
-
352
- table.nextPage = () => {
353
- return table.setPageIndex(old => {
354
- return old + 1
355
- })
356
- }
357
-
358
- table.firstPage = () => {
359
- return table.setPageIndex(0)
360
- }
361
-
362
- table.lastPage = () => {
363
- return table.setPageIndex(table.getPageCount() - 1)
364
- }
365
-
366
- table.getPrePaginationRowModel = () => table.getExpandedRowModel()
367
- table.getPaginationRowModel = () => {
368
- if (
369
- !table._getPaginationRowModel &&
370
- table.options.getPaginationRowModel
371
- ) {
372
- table._getPaginationRowModel =
373
- table.options.getPaginationRowModel(table)
374
- }
375
-
376
- if (table.options.manualPagination || !table._getPaginationRowModel) {
377
- return table.getPrePaginationRowModel()
378
- }
379
-
380
- return table._getPaginationRowModel()
381
- }
382
-
383
- table.getPageCount = () => {
384
- return (
385
- table.options.pageCount ??
386
- Math.ceil(table.getRowCount() / table.getState().pagination.pageSize)
387
- )
388
- }
389
-
390
- table.getRowCount = () => {
391
- return (
392
- table.options.rowCount ?? table.getPrePaginationRowModel().rows.length
393
- )
394
- }
395
- },
396
- }
@@ -1,273 +0,0 @@
1
- import {
2
- OnChangeFn,
3
- Updater,
4
- Table,
5
- Row,
6
- RowData,
7
- TableFeature,
8
- } from '../types'
9
- import { getMemoOptions, makeStateUpdater, memo } from '../utils'
10
-
11
- export type RowPinningPosition = false | 'top' | 'bottom'
12
-
13
- export interface RowPinningState {
14
- bottom?: string[]
15
- top?: string[]
16
- }
17
-
18
- export interface RowPinningTableState {
19
- rowPinning: RowPinningState
20
- }
21
-
22
- export interface RowPinningOptions<TData extends RowData> {
23
- /**
24
- * Enables/disables row pinning for the table. Defaults to `true`.
25
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#enablerowpinning)
26
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-pinning)
27
- */
28
- enableRowPinning?: boolean | ((row: Row<TData>) => boolean)
29
- /**
30
- * When `false`, pinned rows will not be visible if they are filtered or paginated out of the table. When `true`, pinned rows will always be visible regardless of filtering or pagination. Defaults to `true`.
31
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#keeppinnedrows)
32
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-pinning)
33
- */
34
- keepPinnedRows?: boolean
35
- /**
36
- * If provided, this function will be called with an `updaterFn` when `state.rowPinning` changes. This overrides the default internal state management, so you will also need to supply `state.rowPinning` from your own managed state.
37
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#onrowpinningchange)
38
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/onrowpinningchange)
39
- */
40
- onRowPinningChange?: OnChangeFn<RowPinningState>
41
- }
42
-
43
- export interface RowPinningDefaultOptions {
44
- onRowPinningChange: OnChangeFn<RowPinningState>
45
- }
46
-
47
- export interface RowPinningRow {
48
- /**
49
- * Returns whether or not the row can be pinned.
50
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#getcanpin-1)
51
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-pinning)
52
- */
53
- getCanPin: () => boolean
54
- /**
55
- * Returns the pinned position of the row. (`'top'`, `'bottom'` or `false`)
56
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#getispinned-1)
57
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-pinning)
58
- */
59
- getIsPinned: () => RowPinningPosition
60
- /**
61
- * Returns the numeric pinned index of the row within a pinned row group.
62
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#getpinnedindex-1)
63
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-pinning)
64
- */
65
- getPinnedIndex: () => number
66
- /**
67
- * Pins a row to the `'top'` or `'bottom'`, or unpins the row to the center if `false` is passed.
68
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#pin-1)
69
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-pinning)
70
- */
71
- pin: (
72
- position: RowPinningPosition,
73
- includeLeafRows?: boolean,
74
- includeParentRows?: boolean
75
- ) => void
76
- }
77
-
78
- export interface RowPinningInstance<TData extends RowData> {
79
- _getPinnedRows: (position: 'top' | 'bottom') => Row<TData>[]
80
- /**
81
- * Returns all bottom pinned rows.
82
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#getbottomrows)
83
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-pinning)
84
- */
85
- getBottomRows: () => Row<TData>[]
86
- /**
87
- * Returns all rows that are not pinned to the top or bottom.
88
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#getcenterrows)
89
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-pinning)
90
- */
91
- getCenterRows: () => Row<TData>[]
92
- /**
93
- * Returns whether or not any rows are pinned. Optionally specify to only check for pinned rows in either the `top` or `bottom` position.
94
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#getissomerowspinned)
95
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-pinning)
96
- */
97
- getIsSomeRowsPinned: (position?: RowPinningPosition) => boolean
98
- /**
99
- * Returns all top pinned rows.
100
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#gettoprows)
101
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-pinning)
102
- */
103
- getTopRows: () => Row<TData>[]
104
- /**
105
- * Resets the **rowPinning** state to `initialState.rowPinning`, or `true` can be passed to force a default blank state reset to `{ top: [], bottom: [], }`.
106
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#resetrowpinning)
107
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-pinning)
108
- */
109
- resetRowPinning: (defaultState?: boolean) => void
110
- /**
111
- * Sets or updates the `state.rowPinning` state.
112
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#setrowpinning)
113
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-pinning)
114
- */
115
- setRowPinning: (updater: Updater<RowPinningState>) => void
116
- }
117
-
118
- //
119
-
120
- const getDefaultRowPinningState = (): RowPinningState => ({
121
- top: [],
122
- bottom: [],
123
- })
124
-
125
- export const RowPinning: TableFeature = {
126
- getInitialState: (state): RowPinningTableState => {
127
- return {
128
- rowPinning: getDefaultRowPinningState(),
129
- ...state,
130
- }
131
- },
132
-
133
- getDefaultOptions: <TData extends RowData>(
134
- table: Table<TData>
135
- ): RowPinningDefaultOptions => {
136
- return {
137
- onRowPinningChange: makeStateUpdater('rowPinning', table),
138
- }
139
- },
140
-
141
- createRow: <TData extends RowData>(
142
- row: Row<TData>,
143
- table: Table<TData>
144
- ): void => {
145
- row.pin = (position, includeLeafRows, includeParentRows) => {
146
- const leafRowIds = includeLeafRows
147
- ? row.getLeafRows().map(({ id }) => id)
148
- : []
149
- const parentRowIds = includeParentRows
150
- ? row.getParentRows().map(({ id }) => id)
151
- : []
152
- const rowIds = new Set([...parentRowIds, row.id, ...leafRowIds])
153
-
154
- table.setRowPinning(old => {
155
- if (position === 'bottom') {
156
- return {
157
- top: (old?.top ?? []).filter(d => !rowIds?.has(d)),
158
- bottom: [
159
- ...(old?.bottom ?? []).filter(d => !rowIds?.has(d)),
160
- ...Array.from(rowIds),
161
- ],
162
- }
163
- }
164
-
165
- if (position === 'top') {
166
- return {
167
- top: [
168
- ...(old?.top ?? []).filter(d => !rowIds?.has(d)),
169
- ...Array.from(rowIds),
170
- ],
171
- bottom: (old?.bottom ?? []).filter(d => !rowIds?.has(d)),
172
- }
173
- }
174
-
175
- return {
176
- top: (old?.top ?? []).filter(d => !rowIds?.has(d)),
177
- bottom: (old?.bottom ?? []).filter(d => !rowIds?.has(d)),
178
- }
179
- })
180
- }
181
- row.getCanPin = () => {
182
- const { enableRowPinning, enablePinning } = table.options
183
- if (typeof enableRowPinning === 'function') {
184
- return enableRowPinning(row)
185
- }
186
- return enableRowPinning ?? enablePinning ?? true
187
- }
188
- row.getIsPinned = () => {
189
- const rowIds = [row.id]
190
-
191
- const { top, bottom } = table.getState().rowPinning
192
-
193
- const isTop = rowIds.some(d => top?.includes(d))
194
- const isBottom = rowIds.some(d => bottom?.includes(d))
195
-
196
- return isTop ? 'top' : isBottom ? 'bottom' : false
197
- }
198
- row.getPinnedIndex = () => {
199
- const position = row.getIsPinned()
200
- if (!position) return -1
201
-
202
- const visiblePinnedRowIds = table
203
- ._getPinnedRows(position)
204
- ?.map(({ id }) => id)
205
-
206
- return visiblePinnedRowIds?.indexOf(row.id) ?? -1
207
- }
208
- },
209
-
210
- createTable: <TData extends RowData>(table: Table<TData>): void => {
211
- table.setRowPinning = updater => table.options.onRowPinningChange?.(updater)
212
-
213
- table.resetRowPinning = defaultState =>
214
- table.setRowPinning(
215
- defaultState
216
- ? getDefaultRowPinningState()
217
- : table.initialState?.rowPinning ?? getDefaultRowPinningState()
218
- )
219
-
220
- table.getIsSomeRowsPinned = position => {
221
- const pinningState = table.getState().rowPinning
222
-
223
- if (!position) {
224
- return Boolean(pinningState.top?.length || pinningState.bottom?.length)
225
- }
226
- return Boolean(pinningState[position]?.length)
227
- }
228
-
229
- table._getPinnedRows = memo(
230
- position => [
231
- table.getRowModel().rows,
232
- table.getState().rowPinning[position!],
233
- position,
234
- ],
235
- (visibleRows, pinnedRowIds, position) => {
236
- const rows =
237
- table.options.keepPinnedRows ?? true
238
- ? //get all rows that are pinned even if they would not be otherwise visible
239
- //account for expanded parent rows, but not pagination or filtering
240
- (pinnedRowIds ?? []).map(rowId => {
241
- const row = table.getRow(rowId, true)
242
- return row.getIsAllParentsExpanded() ? row : null
243
- })
244
- : //else get only visible rows that are pinned
245
- (pinnedRowIds ?? []).map(
246
- rowId => visibleRows.find(row => row.id === rowId)!
247
- )
248
-
249
- return rows
250
- .filter(Boolean)
251
- .map(d => ({ ...d, position })) as Row<TData>[]
252
- },
253
- getMemoOptions(table.options, 'debugRows', '_getPinnedRows')
254
- )
255
-
256
- table.getTopRows = () => table._getPinnedRows('top')
257
-
258
- table.getBottomRows = () => table._getPinnedRows('bottom')
259
-
260
- table.getCenterRows = memo(
261
- () => [
262
- table.getRowModel().rows,
263
- table.getState().rowPinning.top,
264
- table.getState().rowPinning.bottom,
265
- ],
266
- (allRows, top, bottom) => {
267
- const topAndBottom = new Set([...(top ?? []), ...(bottom ?? [])])
268
- return allRows.filter(d => !topAndBottom.has(d.id))
269
- },
270
- getMemoOptions(table.options, 'debugRows', 'getCenterRows')
271
- )
272
- },
273
- }