@tanstack/table-core 9.0.0-alpha.10 → 9.0.0-alpha.12

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 +62 -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 -66
  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 -50
  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 +89 -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 -164
  336. package/dist/cjs/aggregationFns.cjs +0 -94
  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 -92
  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 -232
  355. package/dist/cjs/core/table.cjs.map +0 -1
  356. package/dist/cjs/core/table.d.cts +0 -229
  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 -133
  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 -307
  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 -152
  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 -161
  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 -132
  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 -296
  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 -200
  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 -88
  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 -35
  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 -37
  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 -88
  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 -98
  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 -94
  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 -92
  457. package/dist/esm/core/row.js.map +0 -1
  458. package/dist/esm/core/table.d.ts +0 -229
  459. package/dist/esm/core/table.js +0 -232
  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 -133
  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 -307
  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 -152
  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 -161
  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 -132
  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 -296
  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 -200
  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 -35
  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 -37
  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 -88
  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 -563
  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 -277
  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,542 +0,0 @@
1
- import { RowModel } from '..'
2
- import {
3
- BuiltInSortingFn,
4
- reSplitAlphaNumeric,
5
- sortingFns,
6
- } from '../sortingFns'
7
-
8
- import {
9
- Column,
10
- OnChangeFn,
11
- Table,
12
- Row,
13
- Updater,
14
- RowData,
15
- SortingFns,
16
- TableFeature,
17
- } from '../types'
18
-
19
- import { isFunction, makeStateUpdater } from '../utils'
20
-
21
- export type SortDirection = 'asc' | 'desc'
22
-
23
- export interface ColumnSort {
24
- desc: boolean
25
- id: string
26
- }
27
-
28
- export type SortingState = ColumnSort[]
29
-
30
- export interface SortingTableState {
31
- sorting: SortingState
32
- }
33
-
34
- export interface SortingFn<TData extends RowData> {
35
- (rowA: Row<TData>, rowB: Row<TData>, columnId: string): number
36
- }
37
-
38
- export type CustomSortingFns<TData extends RowData> = Record<
39
- string,
40
- SortingFn<TData>
41
- >
42
-
43
- export type SortingFnOption<TData extends RowData> =
44
- | 'auto'
45
- | keyof SortingFns
46
- | BuiltInSortingFn
47
- | SortingFn<TData>
48
-
49
- export interface SortingColumnDef<TData extends RowData> {
50
- /**
51
- * Enables/Disables multi-sorting for this column.
52
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablemultisort)
53
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
54
- */
55
- enableMultiSort?: boolean
56
- /**
57
- * Enables/Disables sorting for this column.
58
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablesorting)
59
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
60
- */
61
- enableSorting?: boolean
62
- /**
63
- * Inverts the order of the sorting for this column. This is useful for values that have an inverted best/worst scale where lower numbers are better, eg. a ranking (1st, 2nd, 3rd) or golf-like scoring
64
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#invertsorting)
65
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
66
- */
67
- invertSorting?: boolean
68
- /**
69
- * Set to `true` for sorting toggles on this column to start in the descending direction.
70
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortdescfirst)
71
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
72
- */
73
- sortDescFirst?: boolean
74
- /**
75
- * The sorting function to use with this column.
76
- * - A `string` referencing a built-in sorting function
77
- * - A custom sorting function
78
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortingfn)
79
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
80
- */
81
- sortingFn?: SortingFnOption<TData>
82
- /**
83
- * The priority of undefined values when sorting this column.
84
- * - `false`
85
- * - Undefined values will be considered tied and need to be sorted by the next column filter or original index (whichever applies)
86
- * - `-1`
87
- * - Undefined values will be sorted with higher priority (ascending) (if ascending, undefined will appear on the beginning of the list)
88
- * - `1`
89
- * - Undefined values will be sorted with lower priority (descending) (if ascending, undefined will appear on the end of the list)
90
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortundefined)
91
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
92
- */
93
- sortUndefined?: false | -1 | 1 | 'first' | 'last'
94
- }
95
-
96
- export interface SortingColumn<TData extends RowData> {
97
- /**
98
- * Removes this column from the table's sorting state
99
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#clearsorting)
100
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
101
- */
102
- clearSorting: () => void
103
- /**
104
- * Returns a sort direction automatically inferred based on the columns values.
105
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getautosortdir)
106
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
107
- */
108
- getAutoSortDir: () => SortDirection
109
- /**
110
- * Returns a sorting function automatically inferred based on the columns values.
111
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getautosortingfn)
112
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
113
- */
114
- getAutoSortingFn: () => SortingFn<TData>
115
- /**
116
- * Returns whether this column can be multi-sorted.
117
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getcanmultisort)
118
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
119
- */
120
- getCanMultiSort: () => boolean
121
- /**
122
- * Returns whether this column can be sorted.
123
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getcansort)
124
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
125
- */
126
- getCanSort: () => boolean
127
- /**
128
- * Returns the first direction that should be used when sorting this column.
129
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getfirstsortdir)
130
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
131
- */
132
- getFirstSortDir: () => SortDirection
133
- /**
134
- * Returns the current sort direction of this column.
135
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getissorted)
136
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
137
- */
138
- getIsSorted: () => false | SortDirection
139
- /**
140
- * Returns the next sorting order.
141
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getnextsortingorder)
142
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
143
- */
144
- getNextSortingOrder: () => SortDirection | false
145
- /**
146
- * Returns the index position of this column's sorting within the sorting state
147
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getsortindex)
148
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
149
- */
150
- getSortIndex: () => number
151
- /**
152
- * Returns the resolved sorting function to be used for this column
153
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getsortingfn)
154
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
155
- */
156
- getSortingFn: () => SortingFn<TData>
157
- /**
158
- * Returns a function that can be used to toggle this column's sorting state. This is useful for attaching a click handler to the column header.
159
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#gettogglesortinghandler)
160
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
161
- */
162
- getToggleSortingHandler: () => undefined | ((event: unknown) => void)
163
- /**
164
- * Toggles this columns sorting state. If `desc` is provided, it will force the sort direction to that value. If `isMulti` is provided, it will additivity multi-sort the column (or toggle it if it is already sorted).
165
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#togglesorting)
166
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
167
- */
168
- toggleSorting: (desc?: boolean, isMulti?: boolean) => void
169
- }
170
-
171
- interface SortingOptionsBase {
172
- /**
173
- * Enables/disables the ability to remove multi-sorts
174
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablemultiremove)
175
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
176
- */
177
- enableMultiRemove?: boolean
178
- /**
179
- * Enables/Disables multi-sorting for the table.
180
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablemultisort)
181
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
182
- */
183
- enableMultiSort?: boolean
184
- /**
185
- * Enables/Disables sorting for the table.
186
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablesorting)
187
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
188
- */
189
- enableSorting?: boolean
190
- /**
191
- * Enables/Disables the ability to remove sorting for the table.
192
- * - If `true` then changing sort order will circle like: 'none' -> 'desc' -> 'asc' -> 'none' -> ...
193
- * - If `false` then changing sort order will circle like: 'none' -> 'desc' -> 'asc' -> 'desc' -> 'asc' -> ...
194
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablesortingremoval)
195
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
196
- */
197
- enableSortingRemoval?: boolean
198
- /**
199
- * This function is used to retrieve the sorted row model. If using server-side sorting, this function is not required. To use client-side sorting, pass the exported `getSortedRowModel()` from your adapter to your table or implement your own.
200
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getsortedrowmodel)
201
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
202
- */
203
- getSortedRowModel?: (table: Table<any>) => () => RowModel<any>
204
- /**
205
- * Pass a custom function that will be used to determine if a multi-sort event should be triggered. It is passed the event from the sort toggle handler and should return `true` if the event should trigger a multi-sort.
206
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#ismultisortevent)
207
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
208
- */
209
- isMultiSortEvent?: (e: unknown) => boolean
210
- /**
211
- * Enables manual sorting for the table. If this is `true`, you will be expected to sort your data before it is passed to the table. This is useful if you are doing server-side sorting.
212
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#manualsorting)
213
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
214
- */
215
- manualSorting?: boolean
216
- /**
217
- * Set a maximum number of columns that can be multi-sorted.
218
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#maxmultisortcolcount)
219
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
220
- */
221
- maxMultiSortColCount?: number
222
- /**
223
- * If provided, this function will be called with an `updaterFn` when `state.sorting` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table.
224
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#onsortingchange)
225
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
226
- */
227
- onSortingChange?: OnChangeFn<SortingState>
228
- /**
229
- * If `true`, all sorts will default to descending as their first toggle state.
230
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortdescfirst)
231
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
232
- */
233
- sortDescFirst?: boolean
234
- }
235
-
236
- type ResolvedSortingFns = keyof SortingFns extends never
237
- ? {
238
- sortingFns?: Record<string, SortingFn<any>>
239
- }
240
- : {
241
- sortingFns: Record<keyof SortingFns, SortingFn<any>>
242
- }
243
-
244
- export interface SortingOptions<TData extends RowData>
245
- extends SortingOptionsBase,
246
- ResolvedSortingFns {}
247
-
248
- export interface SortingInstance<TData extends RowData> {
249
- _getSortedRowModel?: () => RowModel<TData>
250
- /**
251
- * Returns the row model for the table before any sorting has been applied.
252
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getpresortedrowmodel)
253
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
254
- */
255
- getPreSortedRowModel: () => RowModel<TData>
256
- /**
257
- * Returns the row model for the table after sorting has been applied.
258
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getsortedrowmodel)
259
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
260
- */
261
- getSortedRowModel: () => RowModel<TData>
262
- /**
263
- * Resets the **sorting** state to `initialState.sorting`, or `true` can be passed to force a default blank state reset to `[]`.
264
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#resetsorting)
265
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
266
- */
267
- resetSorting: (defaultState?: boolean) => void
268
- /**
269
- * Sets or updates the `state.sorting` state.
270
- * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#setsorting)
271
- * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
272
- */
273
- setSorting: (updater: Updater<SortingState>) => void
274
- }
275
-
276
- //
277
-
278
- export const RowSorting: TableFeature = {
279
- _getInitialState: (state): SortingTableState => {
280
- return {
281
- sorting: [],
282
- ...state,
283
- }
284
- },
285
-
286
- _getDefaultColumnDef: <TData extends RowData>(): SortingColumnDef<TData> => {
287
- return {
288
- sortingFn: 'auto',
289
- sortUndefined: 1,
290
- }
291
- },
292
-
293
- _getDefaultOptions: <TData extends RowData>(
294
- table: Table<TData>
295
- ): SortingOptions<TData> => {
296
- return {
297
- onSortingChange: makeStateUpdater('sorting', table),
298
- isMultiSortEvent: (e: unknown) => {
299
- return (e as MouseEvent).shiftKey
300
- },
301
- }
302
- },
303
-
304
- _createColumn: <TData extends RowData, TValue>(
305
- column: Column<TData, TValue>,
306
- table: Table<TData>
307
- ): void => {
308
- column.getAutoSortingFn = () => {
309
- const firstRows = table.getFilteredRowModel().flatRows.slice(10)
310
-
311
- let isString = false
312
-
313
- for (const row of firstRows) {
314
- const value = row?.getValue(column.id)
315
-
316
- if (Object.prototype.toString.call(value) === '[object Date]') {
317
- return sortingFns.datetime
318
- }
319
-
320
- if (typeof value === 'string') {
321
- isString = true
322
-
323
- if (value.split(reSplitAlphaNumeric).length > 1) {
324
- return sortingFns.alphanumeric
325
- }
326
- }
327
- }
328
-
329
- if (isString) {
330
- return sortingFns.text
331
- }
332
-
333
- return sortingFns.basic
334
- }
335
- column.getAutoSortDir = () => {
336
- const firstRow = table.getFilteredRowModel().flatRows[0]
337
-
338
- const value = firstRow?.getValue(column.id)
339
-
340
- if (typeof value === 'string') {
341
- return 'asc'
342
- }
343
-
344
- return 'desc'
345
- }
346
- column.getSortingFn = () => {
347
- if (!column) {
348
- throw new Error()
349
- }
350
-
351
- return isFunction(column.columnDef.sortingFn)
352
- ? column.columnDef.sortingFn
353
- : column.columnDef.sortingFn === 'auto'
354
- ? column.getAutoSortingFn()
355
- : table.options.sortingFns?.[column.columnDef.sortingFn as string] ??
356
- sortingFns[column.columnDef.sortingFn as BuiltInSortingFn]
357
- }
358
- column.toggleSorting = (desc, multi) => {
359
- // if (column.columns.length) {
360
- // column.columns.forEach((c, i) => {
361
- // if (c.id) {
362
- // table.toggleColumnSorting(c.id, undefined, multi || !!i)
363
- // }
364
- // })
365
- // return
366
- // }
367
-
368
- // this needs to be outside of table.setSorting to be in sync with rerender
369
- const nextSortingOrder = column.getNextSortingOrder()
370
- const hasManualValue = typeof desc !== 'undefined' && desc !== null
371
-
372
- table.setSorting(old => {
373
- // Find any existing sorting for this column
374
- const existingSorting = old?.find(d => d.id === column.id)
375
- const existingIndex = old?.findIndex(d => d.id === column.id)
376
-
377
- let newSorting: SortingState = []
378
-
379
- // What should we do with this sort action?
380
- let sortAction: 'add' | 'remove' | 'toggle' | 'replace'
381
- let nextDesc = hasManualValue ? desc : nextSortingOrder === 'desc'
382
-
383
- // Multi-mode
384
- if (old?.length && column.getCanMultiSort() && multi) {
385
- if (existingSorting) {
386
- sortAction = 'toggle'
387
- } else {
388
- sortAction = 'add'
389
- }
390
- } else {
391
- // Normal mode
392
- if (old?.length && existingIndex !== old.length - 1) {
393
- sortAction = 'replace'
394
- } else if (existingSorting) {
395
- sortAction = 'toggle'
396
- } else {
397
- sortAction = 'replace'
398
- }
399
- }
400
-
401
- // Handle toggle states that will remove the sorting
402
- if (sortAction === 'toggle') {
403
- // If we are "actually" toggling (not a manual set value), should we remove the sorting?
404
- if (!hasManualValue) {
405
- // Is our intention to remove?
406
- if (!nextSortingOrder) {
407
- sortAction = 'remove'
408
- }
409
- }
410
- }
411
-
412
- if (sortAction === 'add') {
413
- newSorting = [
414
- ...old,
415
- {
416
- id: column.id,
417
- desc: nextDesc,
418
- },
419
- ]
420
- // Take latest n columns
421
- newSorting.splice(
422
- 0,
423
- newSorting.length -
424
- (table.options.maxMultiSortColCount ?? Number.MAX_SAFE_INTEGER)
425
- )
426
- } else if (sortAction === 'toggle') {
427
- // This flips (or sets) the
428
- newSorting = old.map(d => {
429
- if (d.id === column.id) {
430
- return {
431
- ...d,
432
- desc: nextDesc,
433
- }
434
- }
435
- return d
436
- })
437
- } else if (sortAction === 'remove') {
438
- newSorting = old.filter(d => d.id !== column.id)
439
- } else {
440
- newSorting = [
441
- {
442
- id: column.id,
443
- desc: nextDesc,
444
- },
445
- ]
446
- }
447
-
448
- return newSorting
449
- })
450
- }
451
-
452
- column.getFirstSortDir = () => {
453
- const sortDescFirst =
454
- column.columnDef.sortDescFirst ??
455
- table.options.sortDescFirst ??
456
- column.getAutoSortDir() === 'desc'
457
- return sortDescFirst ? 'desc' : 'asc'
458
- }
459
-
460
- column.getNextSortingOrder = (multi?: boolean) => {
461
- const firstSortDirection = column.getFirstSortDir()
462
- const isSorted = column.getIsSorted()
463
-
464
- if (!isSorted) {
465
- return firstSortDirection
466
- }
467
-
468
- if (
469
- isSorted !== firstSortDirection &&
470
- (table.options.enableSortingRemoval ?? true) && // If enableSortRemove, enable in general
471
- (multi ? table.options.enableMultiRemove ?? true : true) // If multi, don't allow if enableMultiRemove))
472
- ) {
473
- return false
474
- }
475
- return isSorted === 'desc' ? 'asc' : 'desc'
476
- }
477
-
478
- column.getCanSort = () => {
479
- return (
480
- (column.columnDef.enableSorting ?? true) &&
481
- (table.options.enableSorting ?? true) &&
482
- !!column.accessorFn
483
- )
484
- }
485
-
486
- column.getCanMultiSort = () => {
487
- return (
488
- column.columnDef.enableMultiSort ??
489
- table.options.enableMultiSort ??
490
- !!column.accessorFn
491
- )
492
- }
493
-
494
- column.getIsSorted = () => {
495
- const columnSort = table.getState().sorting?.find(d => d.id === column.id)
496
-
497
- return !columnSort ? false : columnSort.desc ? 'desc' : 'asc'
498
- }
499
-
500
- column.getSortIndex = () =>
501
- table.getState().sorting?.findIndex(d => d.id === column.id) ?? -1
502
-
503
- column.clearSorting = () => {
504
- //clear sorting for just 1 column
505
- table.setSorting(old =>
506
- old?.length ? old.filter(d => d.id !== column.id) : []
507
- )
508
- }
509
-
510
- column.getToggleSortingHandler = () => {
511
- const canSort = column.getCanSort()
512
-
513
- return (e: unknown) => {
514
- if (!canSort) return
515
- ;(e as any).persist?.()
516
- column.toggleSorting?.(
517
- undefined,
518
- column.getCanMultiSort() ? table.options.isMultiSortEvent?.(e) : false
519
- )
520
- }
521
- }
522
- },
523
-
524
- _createTable: <TData extends RowData>(table: Table<TData>): void => {
525
- table.setSorting = updater => table.options.onSortingChange?.(updater)
526
- table.resetSorting = defaultState => {
527
- table.setSorting(defaultState ? [] : table.initialState?.sorting ?? [])
528
- }
529
- table.getPreSortedRowModel = () => table.getGroupedRowModel()
530
- table.getSortedRowModel = () => {
531
- if (!table._getSortedRowModel && table.options.getSortedRowModel) {
532
- table._getSortedRowModel = table.options.getSortedRowModel(table)
533
- }
534
-
535
- if (table.options.manualSorting || !table._getSortedRowModel) {
536
- return table.getPreSortedRowModel()
537
- }
538
-
539
- return table._getSortedRowModel()
540
- }
541
- },
542
- }
package/src/filterFns.ts DELETED
@@ -1,150 +0,0 @@
1
- import { FilterFn } from './features/ColumnFiltering'
2
-
3
- const includesString: FilterFn<any> = (
4
- row,
5
- columnId: string,
6
- filterValue: string
7
- ) => {
8
- const search = filterValue.toLowerCase()
9
- return Boolean(
10
- row
11
- .getValue<string | null>(columnId)
12
- ?.toString()
13
- ?.toLowerCase()
14
- ?.includes(search)
15
- )
16
- }
17
-
18
- includesString.autoRemove = (val: any) => testFalsey(val)
19
-
20
- const includesStringSensitive: FilterFn<any> = (
21
- row,
22
- columnId: string,
23
- filterValue: string
24
- ) => {
25
- return Boolean(
26
- row.getValue<string | null>(columnId)?.toString()?.includes(filterValue)
27
- )
28
- }
29
-
30
- includesStringSensitive.autoRemove = (val: any) => testFalsey(val)
31
-
32
- const equalsString: FilterFn<any> = (
33
- row,
34
- columnId: string,
35
- filterValue: string
36
- ) => {
37
- return (
38
- row.getValue<string | null>(columnId)?.toString()?.toLowerCase() ===
39
- filterValue?.toLowerCase()
40
- )
41
- }
42
-
43
- equalsString.autoRemove = (val: any) => testFalsey(val)
44
-
45
- const arrIncludes: FilterFn<any> = (
46
- row,
47
- columnId: string,
48
- filterValue: unknown
49
- ) => {
50
- return row.getValue<unknown[]>(columnId)?.includes(filterValue)
51
- }
52
-
53
- arrIncludes.autoRemove = (val: any) => testFalsey(val) || !val?.length
54
-
55
- const arrIncludesAll: FilterFn<any> = (
56
- row,
57
- columnId: string,
58
- filterValue: unknown[]
59
- ) => {
60
- return !filterValue.some(
61
- val => !row.getValue<unknown[]>(columnId)?.includes(val)
62
- )
63
- }
64
-
65
- arrIncludesAll.autoRemove = (val: any) => testFalsey(val) || !val?.length
66
-
67
- const arrIncludesSome: FilterFn<any> = (
68
- row,
69
- columnId: string,
70
- filterValue: unknown[]
71
- ) => {
72
- return filterValue.some(val =>
73
- row.getValue<unknown[]>(columnId)?.includes(val)
74
- )
75
- }
76
-
77
- arrIncludesSome.autoRemove = (val: any) => testFalsey(val) || !val?.length
78
-
79
- const equals: FilterFn<any> = (row, columnId: string, filterValue: unknown) => {
80
- return row.getValue(columnId) === filterValue
81
- }
82
-
83
- equals.autoRemove = (val: any) => testFalsey(val)
84
-
85
- const weakEquals: FilterFn<any> = (
86
- row,
87
- columnId: string,
88
- filterValue: unknown
89
- ) => {
90
- return row.getValue(columnId) == filterValue
91
- }
92
-
93
- weakEquals.autoRemove = (val: any) => testFalsey(val)
94
-
95
- const inNumberRange: FilterFn<any> = (
96
- row,
97
- columnId: string,
98
- filterValue: [number, number]
99
- ) => {
100
- let [min, max] = filterValue
101
-
102
- const rowValue = row.getValue<number>(columnId)
103
- return rowValue >= min && rowValue <= max
104
- }
105
-
106
- inNumberRange.resolveFilterValue = (val: [any, any]) => {
107
- let [unsafeMin, unsafeMax] = val
108
-
109
- let parsedMin =
110
- typeof unsafeMin !== 'number' ? parseFloat(unsafeMin as string) : unsafeMin
111
- let parsedMax =
112
- typeof unsafeMax !== 'number' ? parseFloat(unsafeMax as string) : unsafeMax
113
-
114
- let min =
115
- unsafeMin === null || Number.isNaN(parsedMin) ? -Infinity : parsedMin
116
- let max = unsafeMax === null || Number.isNaN(parsedMax) ? Infinity : parsedMax
117
-
118
- if (min > max) {
119
- const temp = min
120
- min = max
121
- max = temp
122
- }
123
-
124
- return [min, max] as const
125
- }
126
-
127
- inNumberRange.autoRemove = (val: any) =>
128
- testFalsey(val) || (testFalsey(val[0]) && testFalsey(val[1]))
129
-
130
- // Export
131
-
132
- export const filterFns = {
133
- includesString,
134
- includesStringSensitive,
135
- equalsString,
136
- arrIncludes,
137
- arrIncludesAll,
138
- arrIncludesSome,
139
- equals,
140
- weakEquals,
141
- inNumberRange,
142
- }
143
-
144
- export type BuiltInFilterFn = keyof typeof filterFns
145
-
146
- // Utils
147
-
148
- function testFalsey(val: any) {
149
- return val === undefined || val === null || val === ''
150
- }