@viewkitjs/views 0.0.0-stage → 0.2.0

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 (451) hide show
  1. package/CHANGELOG.md +615 -0
  2. package/LICENSE.md +7 -0
  3. package/README.md +99 -2
  4. package/dist/atoms/CommandMenu.d.ts +2 -0
  5. package/dist/atoms/CommandMenu.js +20 -0
  6. package/dist/atoms/List.d.ts +2 -0
  7. package/dist/atoms/List.js +6 -0
  8. package/dist/atoms/LoadMore.d.ts +2 -0
  9. package/dist/atoms/LoadMore.js +25 -0
  10. package/dist/atoms/Loading.d.ts +2 -0
  11. package/dist/atoms/Loading.js +7 -0
  12. package/dist/atoms/PlatformMark.d.ts +2 -0
  13. package/dist/atoms/PlatformMark.js +4 -0
  14. package/dist/atoms/RelationLink.d.ts +2 -0
  15. package/dist/atoms/RelationLink.js +6 -0
  16. package/dist/atoms/Row.d.ts +3 -0
  17. package/dist/atoms/Row.js +30 -0
  18. package/dist/atoms/RowMenu.d.ts +2 -0
  19. package/dist/atoms/RowMenu.js +112 -0
  20. package/dist/atoms/StatusBadge.d.ts +2 -0
  21. package/dist/atoms/StatusBadge.js +7 -0
  22. package/dist/atoms/StatusMarker.d.ts +2 -0
  23. package/dist/atoms/StatusMarker.js +19 -0
  24. package/dist/atoms/Tag.d.ts +2 -0
  25. package/dist/atoms/Tag.js +13 -0
  26. package/dist/atoms/TickBox.d.ts +2 -0
  27. package/dist/atoms/TickBox.js +8 -0
  28. package/dist/atoms/defaults.d.ts +2 -0
  29. package/dist/atoms/defaults.js +27 -0
  30. package/dist/atoms/tones.d.ts +5 -0
  31. package/dist/atoms/tones.js +28 -0
  32. package/dist/atoms/types.d.ts +178 -0
  33. package/dist/atoms/types.js +3 -0
  34. package/dist/cells/cell-format.d.ts +138 -0
  35. package/dist/cells/cell-format.js +16 -0
  36. package/dist/cells/cell-title.d.ts +17 -0
  37. package/dist/cells/cell-title.js +8 -0
  38. package/dist/cells/cell-values.d.ts +28 -0
  39. package/dist/cells/cell-values.js +87 -0
  40. package/dist/cells/index.d.ts +4 -0
  41. package/dist/cells/index.js +4 -0
  42. package/dist/cells/legacy-field.d.ts +52 -0
  43. package/dist/cells/legacy-field.js +164 -0
  44. package/dist/cells/relation-wrap.d.ts +3 -0
  45. package/dist/cells/relation-wrap.js +24 -0
  46. package/dist/cells/use-cell-format.d.ts +5 -0
  47. package/dist/cells/use-cell-format.js +10 -0
  48. package/dist/contract.d.ts +461 -0
  49. package/dist/contract.js +682 -0
  50. package/dist/display/actor.d.ts +4 -0
  51. package/dist/display/actor.js +26 -0
  52. package/dist/display/boolean.d.ts +18 -0
  53. package/dist/display/boolean.js +43 -0
  54. package/dist/display/breakdown.d.ts +15 -0
  55. package/dist/display/breakdown.js +32 -0
  56. package/dist/display/currency.d.ts +9 -0
  57. package/dist/display/currency.js +29 -0
  58. package/dist/display/date.d.ts +12 -0
  59. package/dist/display/date.js +26 -0
  60. package/dist/display/display-cores.d.ts +31 -0
  61. package/dist/display/display-cores.js +57 -0
  62. package/dist/display/entity-chip.d.ts +26 -0
  63. package/dist/display/entity-chip.js +9 -0
  64. package/dist/display/format.d.ts +66 -0
  65. package/dist/display/format.js +190 -0
  66. package/dist/display/index.d.ts +8 -0
  67. package/dist/display/index.js +7 -0
  68. package/dist/display/link.d.ts +29 -0
  69. package/dist/display/link.js +50 -0
  70. package/dist/display/location.d.ts +8 -0
  71. package/dist/display/location.js +22 -0
  72. package/dist/display/multi-value.d.ts +18 -0
  73. package/dist/display/multi-value.js +28 -0
  74. package/dist/display/name.d.ts +6 -0
  75. package/dist/display/name.js +14 -0
  76. package/dist/display/number.d.ts +11 -0
  77. package/dist/display/number.js +27 -0
  78. package/dist/display/options.d.ts +153 -0
  79. package/dist/display/options.js +1 -0
  80. package/dist/display/percent.d.ts +4 -0
  81. package/dist/display/percent.js +40 -0
  82. package/dist/display/phone.d.ts +11 -0
  83. package/dist/display/phone.js +45 -0
  84. package/dist/display/range.d.ts +6 -0
  85. package/dist/display/range.js +29 -0
  86. package/dist/display/relation.d.ts +4 -0
  87. package/dist/display/relation.js +29 -0
  88. package/dist/display/rich-text.d.ts +10 -0
  89. package/dist/display/rich-text.js +34 -0
  90. package/dist/display/select.d.ts +6 -0
  91. package/dist/display/select.js +38 -0
  92. package/dist/display/text-class.d.ts +23 -0
  93. package/dist/display/text-class.js +5 -0
  94. package/dist/display/text.d.ts +19 -0
  95. package/dist/display/text.js +8 -0
  96. package/dist/display/use-display-options.d.ts +2 -0
  97. package/dist/display/use-display-options.js +14 -0
  98. package/dist/display/user.d.ts +11 -0
  99. package/dist/display/user.js +10 -0
  100. package/dist/display/value-list.d.ts +10 -0
  101. package/dist/display/value-list.js +12 -0
  102. package/dist/display/viewer.d.ts +4 -0
  103. package/dist/display/viewer.js +11 -0
  104. package/dist/display/web-href.d.ts +8 -0
  105. package/dist/display/web-href.js +12 -0
  106. package/dist/editors/ChipsEditor.d.ts +59 -0
  107. package/dist/editors/ChipsEditor.js +73 -0
  108. package/dist/editors/DateEditor.d.ts +25 -0
  109. package/dist/editors/DateEditor.js +122 -0
  110. package/dist/editors/LocationEditor.d.ts +22 -0
  111. package/dist/editors/LocationEditor.js +228 -0
  112. package/dist/editors/NameEditor.d.ts +22 -0
  113. package/dist/editors/NameEditor.js +92 -0
  114. package/dist/editors/NumberEditor.d.ts +67 -0
  115. package/dist/editors/NumberEditor.js +86 -0
  116. package/dist/editors/RangeEditor.d.ts +22 -0
  117. package/dist/editors/RangeEditor.js +70 -0
  118. package/dist/editors/RelationEditor.d.ts +65 -0
  119. package/dist/editors/RelationEditor.js +64 -0
  120. package/dist/editors/SelectEditor.d.ts +72 -0
  121. package/dist/editors/SelectEditor.js +59 -0
  122. package/dist/editors/ValueListEditor.d.ts +38 -0
  123. package/dist/editors/ValueListEditor.js +217 -0
  124. package/dist/editors/edit-cores.d.ts +83 -0
  125. package/dist/editors/edit-cores.js +38 -0
  126. package/dist/editors/edit-session.d.ts +74 -0
  127. package/dist/editors/edit-session.js +35 -0
  128. package/dist/editors/open-values.d.ts +28 -0
  129. package/dist/editors/open-values.js +26 -0
  130. package/dist/editors/relation-source.d.ts +66 -0
  131. package/dist/editors/relation-source.js +102 -0
  132. package/dist/fields/binding.d.ts +87 -0
  133. package/dist/fields/binding.js +117 -0
  134. package/dist/fields/currency.d.ts +82 -0
  135. package/dist/fields/currency.js +41 -0
  136. package/dist/fields/denomination.d.ts +42 -0
  137. package/dist/fields/denomination.js +11 -0
  138. package/dist/fields/edit-core-types.d.ts +40 -0
  139. package/dist/fields/edit-core-types.js +29 -0
  140. package/dist/fields/format-knobs.d.ts +34 -0
  141. package/dist/fields/format-knobs.js +36 -0
  142. package/dist/fields/menus.d.ts +28 -0
  143. package/dist/fields/menus.js +1 -0
  144. package/dist/fields/money.d.ts +60 -0
  145. package/dist/fields/money.js +78 -0
  146. package/dist/fields/number-edit.d.ts +11 -0
  147. package/dist/fields/number-edit.js +17 -0
  148. package/dist/fields/prepare-write.d.ts +55 -0
  149. package/dist/fields/prepare-write.js +67 -0
  150. package/dist/fields/relation-source-types.d.ts +54 -0
  151. package/dist/fields/relation-source-types.js +1 -0
  152. package/dist/figures.d.ts +52 -0
  153. package/dist/figures.js +63 -0
  154. package/dist/filters/date-filter.d.ts +2 -0
  155. package/dist/filters/date-filter.js +1 -0
  156. package/dist/filters/filter-model.d.ts +176 -0
  157. package/dist/filters/filter-model.js +41 -0
  158. package/dist/filters/number-filter.d.ts +2 -0
  159. package/dist/filters/number-filter.js +1 -0
  160. package/dist/filters/range-filter.d.ts +2 -0
  161. package/dist/filters/range-filter.js +1 -0
  162. package/dist/filters/registry.d.ts +103 -0
  163. package/dist/filters/registry.js +8 -0
  164. package/dist/filters/relation-filter.d.ts +16 -0
  165. package/dist/filters/relation-filter.js +53 -0
  166. package/dist/filters/text-filter.d.ts +2 -0
  167. package/dist/filters/text-filter.js +1 -0
  168. package/dist/grid/chrome/GridAddColumn.d.ts +11 -0
  169. package/dist/grid/chrome/GridAddColumn.js +29 -0
  170. package/dist/grid/chrome/GridAggregateMenu.d.ts +31 -0
  171. package/dist/grid/chrome/GridAggregateMenu.js +27 -0
  172. package/dist/grid/chrome/GridCellEditors.d.ts +64 -0
  173. package/dist/grid/chrome/GridCellEditors.js +55 -0
  174. package/dist/grid/chrome/GridCellOutline.d.ts +70 -0
  175. package/dist/grid/chrome/GridCellOutline.js +21 -0
  176. package/dist/grid/chrome/GridChipsEditor.d.ts +28 -0
  177. package/dist/grid/chrome/GridChipsEditor.js +40 -0
  178. package/dist/grid/chrome/GridColumnColorSection.d.ts +11 -0
  179. package/dist/grid/chrome/GridColumnColorSection.js +40 -0
  180. package/dist/grid/chrome/GridColumnDateSection.d.ts +23 -0
  181. package/dist/grid/chrome/GridColumnDateSection.js +23 -0
  182. package/dist/grid/chrome/GridColumnDurationSection.d.ts +19 -0
  183. package/dist/grid/chrome/GridColumnDurationSection.js +24 -0
  184. package/dist/grid/chrome/GridColumnMenu.d.ts +101 -0
  185. package/dist/grid/chrome/GridColumnMenu.js +99 -0
  186. package/dist/grid/chrome/GridColumnNumberSection.d.ts +25 -0
  187. package/dist/grid/chrome/GridColumnNumberSection.js +27 -0
  188. package/dist/grid/chrome/GridColumnPercentSection.d.ts +15 -0
  189. package/dist/grid/chrome/GridColumnPercentSection.js +16 -0
  190. package/dist/grid/chrome/GridColumnSortSection.d.ts +18 -0
  191. package/dist/grid/chrome/GridColumnSortSection.js +16 -0
  192. package/dist/grid/chrome/GridDateEditor.d.ts +22 -0
  193. package/dist/grid/chrome/GridDateEditor.js +31 -0
  194. package/dist/grid/chrome/GridFlyout.d.ts +44 -0
  195. package/dist/grid/chrome/GridFlyout.js +80 -0
  196. package/dist/grid/chrome/GridFooter.d.ts +23 -0
  197. package/dist/grid/chrome/GridFooter.js +81 -0
  198. package/dist/grid/chrome/GridGroupMenu.d.ts +37 -0
  199. package/dist/grid/chrome/GridGroupMenu.js +57 -0
  200. package/dist/grid/chrome/GridHeader.d.ts +61 -0
  201. package/dist/grid/chrome/GridHeader.js +37 -0
  202. package/dist/grid/chrome/GridLongTextEditor.d.ts +36 -0
  203. package/dist/grid/chrome/GridLongTextEditor.js +127 -0
  204. package/dist/grid/chrome/GridMenuRow.d.ts +15 -0
  205. package/dist/grid/chrome/GridMenuRow.js +15 -0
  206. package/dist/grid/chrome/GridNameEditor.d.ts +19 -0
  207. package/dist/grid/chrome/GridNameEditor.js +36 -0
  208. package/dist/grid/chrome/GridNumberEditor.d.ts +35 -0
  209. package/dist/grid/chrome/GridNumberEditor.js +25 -0
  210. package/dist/grid/chrome/GridRangeEditor.d.ts +20 -0
  211. package/dist/grid/chrome/GridRangeEditor.js +25 -0
  212. package/dist/grid/chrome/GridRelationEditor.d.ts +21 -0
  213. package/dist/grid/chrome/GridRelationEditor.js +30 -0
  214. package/dist/grid/chrome/GridResizeHandle.d.ts +19 -0
  215. package/dist/grid/chrome/GridResizeHandle.js +19 -0
  216. package/dist/grid/chrome/GridRow.d.ts +25 -0
  217. package/dist/grid/chrome/GridRow.js +136 -0
  218. package/dist/grid/chrome/GridRowActions.d.ts +32 -0
  219. package/dist/grid/chrome/GridRowActions.js +25 -0
  220. package/dist/grid/chrome/GridRowCells.d.ts +4 -0
  221. package/dist/grid/chrome/GridRowCells.js +133 -0
  222. package/dist/grid/chrome/GridRowGlyph.d.ts +12 -0
  223. package/dist/grid/chrome/GridRowGlyph.js +13 -0
  224. package/dist/grid/chrome/GridSelectEditor.d.ts +18 -0
  225. package/dist/grid/chrome/GridSelectEditor.js +49 -0
  226. package/dist/grid/chrome/GridStructure.d.ts +48 -0
  227. package/dist/grid/chrome/GridStructure.js +45 -0
  228. package/dist/grid/chrome/GridTable.d.ts +4 -0
  229. package/dist/grid/chrome/GridTable.js +125 -0
  230. package/dist/grid/chrome/GridTableSurface.d.ts +15 -0
  231. package/dist/grid/chrome/GridTableSurface.js +6 -0
  232. package/dist/grid/chrome/GridTextEditor.d.ts +11 -0
  233. package/dist/grid/chrome/GridTextEditor.js +40 -0
  234. package/dist/grid/chrome/GridValueListEditor.d.ts +18 -0
  235. package/dist/grid/chrome/GridValueListEditor.js +36 -0
  236. package/dist/grid/chrome/StuckMarker.d.ts +16 -0
  237. package/dist/grid/chrome/StuckMarker.js +34 -0
  238. package/dist/grid/chrome/cell-clipboard.d.ts +9 -0
  239. package/dist/grid/chrome/cell-clipboard.js +28 -0
  240. package/dist/grid/chrome/cells.d.ts +21 -0
  241. package/dist/grid/chrome/cells.js +20 -0
  242. package/dist/grid/chrome/checks.d.ts +35 -0
  243. package/dist/grid/chrome/checks.js +22 -0
  244. package/dist/grid/chrome/column-glyph.d.ts +14 -0
  245. package/dist/grid/chrome/column-glyph.js +44 -0
  246. package/dist/grid/chrome/editors.d.ts +9 -0
  247. package/dist/grid/chrome/editors.js +10 -0
  248. package/dist/grid/chrome/grid-cell-classes.d.ts +59 -0
  249. package/dist/grid/chrome/grid-cell-classes.js +30 -0
  250. package/dist/grid/chrome/grid-menu-search.d.ts +7 -0
  251. package/dist/grid/chrome/grid-menu-search.js +7 -0
  252. package/dist/grid/chrome/grid-row-props.d.ts +131 -0
  253. package/dist/grid/chrome/grid-row-props.js +1 -0
  254. package/dist/grid/chrome/grid-styles.d.ts +37 -0
  255. package/dist/grid/chrome/grid-styles.js +8 -0
  256. package/dist/grid/chrome/grid-table-props.d.ts +173 -0
  257. package/dist/grid/chrome/grid-table-props.js +1 -0
  258. package/dist/grid/chrome/useGridBatchApi.d.ts +34 -0
  259. package/dist/grid/chrome/useGridBatchApi.js +35 -0
  260. package/dist/grid/chrome/useGridColumnLayout.d.ts +30 -0
  261. package/dist/grid/chrome/useGridColumnLayout.js +206 -0
  262. package/dist/grid/chrome/useGridHeaderDrag.d.ts +20 -0
  263. package/dist/grid/chrome/useGridHeaderDrag.js +37 -0
  264. package/dist/grid/chrome/useGridKeyboard.d.ts +47 -0
  265. package/dist/grid/chrome/useGridKeyboard.js +274 -0
  266. package/dist/grid/chrome/useGridPendingReconciliation.d.ts +12 -0
  267. package/dist/grid/chrome/useGridPendingReconciliation.js +32 -0
  268. package/dist/grid/chrome/useGridRailReveal.d.ts +57 -0
  269. package/dist/grid/chrome/useGridRailReveal.js +67 -0
  270. package/dist/grid/chrome/useGridRangeActions.d.ts +49 -0
  271. package/dist/grid/chrome/useGridRangeActions.js +188 -0
  272. package/dist/grid/chrome/useGridRangeGestures.d.ts +32 -0
  273. package/dist/grid/chrome/useGridRangeGestures.js +190 -0
  274. package/dist/grid/chrome/useGridRowContextMenu.d.ts +35 -0
  275. package/dist/grid/chrome/useGridRowContextMenu.js +127 -0
  276. package/dist/grid/chrome/useGridScaleStyles.d.ts +1 -0
  277. package/dist/grid/chrome/useGridScaleStyles.js +29 -0
  278. package/dist/grid/chrome/useGridScrollSync.d.ts +38 -0
  279. package/dist/grid/chrome/useGridScrollSync.js +176 -0
  280. package/dist/grid/chrome/useGridTableInteractionModel.d.ts +55 -0
  281. package/dist/grid/chrome/useGridTableInteractionModel.js +197 -0
  282. package/dist/grid/chrome/useGridTableSelection.d.ts +29 -0
  283. package/dist/grid/chrome/useGridTableSelection.js +55 -0
  284. package/dist/grid/chrome/useHeaderDragReorder.d.ts +21 -0
  285. package/dist/grid/chrome/useHeaderDragReorder.js +216 -0
  286. package/dist/grid/core/clipboard-model.d.ts +81 -0
  287. package/dist/grid/core/clipboard-model.js +291 -0
  288. package/dist/grid/core/column-values.d.ts +27 -0
  289. package/dist/grid/core/column-values.js +76 -0
  290. package/dist/grid/core/commit-model.d.ts +34 -0
  291. package/dist/grid/core/commit-model.js +3 -0
  292. package/dist/grid/core/coordinates.d.ts +48 -0
  293. package/dist/grid/core/coordinates.js +27 -0
  294. package/dist/grid/core/edit-values.d.ts +9 -0
  295. package/dist/grid/core/edit-values.js +1 -0
  296. package/dist/grid/core/editing-controller.d.ts +59 -0
  297. package/dist/grid/core/editing-controller.js +240 -0
  298. package/dist/grid/core/editing-model.d.ts +78 -0
  299. package/dist/grid/core/editing-model.js +136 -0
  300. package/dist/grid/core/grid-scale.d.ts +14 -0
  301. package/dist/grid/core/grid-scale.js +8 -0
  302. package/dist/grid/core/nav.d.ts +94 -0
  303. package/dist/grid/core/nav.js +92 -0
  304. package/dist/grid/core/pending-reconciliation.d.ts +50 -0
  305. package/dist/grid/core/pending-reconciliation.js +49 -0
  306. package/dist/grid/core/range-model.d.ts +25 -0
  307. package/dist/grid/core/range-model.js +59 -0
  308. package/dist/grid/core/spreadsheet-operations.d.ts +85 -0
  309. package/dist/grid/core/spreadsheet-operations.js +253 -0
  310. package/dist/grid/core/useGridEditing.d.ts +43 -0
  311. package/dist/grid/core/useGridEditing.js +90 -0
  312. package/dist/grid/core/useGridRange.d.ts +20 -0
  313. package/dist/grid/core/useGridRange.js +24 -0
  314. package/dist/grid/core/value-equality.d.ts +32 -0
  315. package/dist/grid/core/value-equality.js +34 -0
  316. package/dist/grid/index.d.ts +18 -0
  317. package/dist/grid/index.js +5 -0
  318. package/dist/grid/useGridTablePrefs.d.ts +50 -0
  319. package/dist/grid/useGridTablePrefs.js +101 -0
  320. package/dist/grouping/sort-groups.d.ts +18 -0
  321. package/dist/grouping/sort-groups.js +33 -0
  322. package/dist/grouping/types.d.ts +10 -0
  323. package/dist/grouping/types.js +1 -0
  324. package/dist/index.d.ts +28 -0
  325. package/dist/index.js +28 -0
  326. package/dist/internal/chip.d.ts +4 -0
  327. package/dist/internal/chip.js +3 -0
  328. package/dist/internal/cx.d.ts +3 -0
  329. package/dist/internal/cx.js +3 -0
  330. package/dist/internal/viewport.d.ts +5 -0
  331. package/dist/internal/viewport.js +29 -0
  332. package/dist/model/aggregates.d.ts +59 -0
  333. package/dist/model/aggregates.js +186 -0
  334. package/dist/model/card-density.d.ts +8 -0
  335. package/dist/model/card-density.js +10 -0
  336. package/dist/model/card-layout.d.ts +85 -0
  337. package/dist/model/card-layout.js +90 -0
  338. package/dist/model/column-capabilities.d.ts +162 -0
  339. package/dist/model/column-capabilities.js +233 -0
  340. package/dist/model/column-filters.d.ts +106 -0
  341. package/dist/model/column-filters.js +321 -0
  342. package/dist/model/column-format.d.ts +103 -0
  343. package/dist/model/column-format.js +1 -0
  344. package/dist/model/column-from.d.ts +28 -0
  345. package/dist/model/column-from.js +160 -0
  346. package/dist/model/column-inspect.d.ts +18 -0
  347. package/dist/model/column-inspect.js +6 -0
  348. package/dist/model/column-knobs.d.ts +20 -0
  349. package/dist/model/column-knobs.js +16 -0
  350. package/dist/model/column-money.d.ts +13 -0
  351. package/dist/model/column-money.js +27 -0
  352. package/dist/model/column-order.d.ts +36 -0
  353. package/dist/model/column-order.js +68 -0
  354. package/dist/model/column-schema.d.ts +335 -0
  355. package/dist/model/column-schema.js +1 -0
  356. package/dist/model/column-sort.d.ts +17 -0
  357. package/dist/model/column-sort.js +11 -0
  358. package/dist/model/column-state.d.ts +77 -0
  359. package/dist/model/column-state.js +95 -0
  360. package/dist/model/column-types.d.ts +109 -0
  361. package/dist/model/column-types.js +50 -0
  362. package/dist/model/column-warnings.d.ts +44 -0
  363. package/dist/model/column-warnings.js +24 -0
  364. package/dist/model/density.d.ts +3 -0
  365. package/dist/model/density.js +13 -0
  366. package/dist/model/field-type-of.d.ts +21 -0
  367. package/dist/model/field-type-of.js +11 -0
  368. package/dist/model/filter-capabilities.d.ts +1 -0
  369. package/dist/model/filter-capabilities.js +1 -0
  370. package/dist/model/index.d.ts +38 -0
  371. package/dist/model/index.js +20 -0
  372. package/dist/model/part-rows.d.ts +28 -0
  373. package/dist/model/part-rows.js +40 -0
  374. package/dist/model/preferences.d.ts +155 -0
  375. package/dist/model/preferences.js +84 -0
  376. package/dist/model/prefs-buckets.d.ts +173 -0
  377. package/dist/model/prefs-buckets.js +71 -0
  378. package/dist/model/relation-filters.d.ts +45 -0
  379. package/dist/model/relation-filters.js +78 -0
  380. package/dist/model/render-count.d.ts +2 -0
  381. package/dist/model/render-count.js +24 -0
  382. package/dist/model/row-icon.d.ts +23 -0
  383. package/dist/model/row-icon.js +5 -0
  384. package/dist/model/view-rules.d.ts +73 -0
  385. package/dist/model/view-rules.js +216 -0
  386. package/dist/provider/ViewsProvider.d.ts +26 -0
  387. package/dist/provider/ViewsProvider.js +16 -0
  388. package/dist/provider/components.d.ts +230 -0
  389. package/dist/provider/components.js +3 -0
  390. package/dist/provider/context.d.ts +20 -0
  391. package/dist/provider/context.js +10 -0
  392. package/dist/provider/icons.d.ts +6 -0
  393. package/dist/provider/icons.js +1 -0
  394. package/dist/provider/menu-groups.d.ts +8 -0
  395. package/dist/provider/menu-groups.js +38 -0
  396. package/dist/provider/ports.d.ts +57 -0
  397. package/dist/provider/ports.js +9 -0
  398. package/dist/react.d.ts +9 -0
  399. package/dist/react.js +4 -0
  400. package/dist/selection/SelectCheckbox.d.ts +17 -0
  401. package/dist/selection/SelectCheckbox.js +11 -0
  402. package/dist/selection/index.d.ts +7 -0
  403. package/dist/selection/index.js +6 -0
  404. package/dist/selection/model.d.ts +55 -0
  405. package/dist/selection/model.js +86 -0
  406. package/dist/selection/row-click.d.ts +35 -0
  407. package/dist/selection/row-click.js +20 -0
  408. package/dist/selection/types.d.ts +17 -0
  409. package/dist/selection/types.js +1 -0
  410. package/dist/selection/useCheckDragSelect.d.ts +61 -0
  411. package/dist/selection/useCheckDragSelect.js +165 -0
  412. package/dist/selection/useListSelection.d.ts +39 -0
  413. package/dist/selection/useListSelection.js +48 -0
  414. package/dist/selection/useListSelectionShortcuts.d.ts +6 -0
  415. package/dist/selection/useListSelectionShortcuts.js +14 -0
  416. package/dist/selection/useRestIntent.d.ts +18 -0
  417. package/dist/selection/useRestIntent.js +35 -0
  418. package/docs/contract.md +525 -0
  419. package/docs/getting-started.md +250 -0
  420. package/docs/guides/atoms.md +245 -0
  421. package/docs/guides/cells.md +302 -0
  422. package/docs/guides/columns.md +412 -0
  423. package/docs/guides/display.md +203 -0
  424. package/docs/guides/editors.md +404 -0
  425. package/docs/guides/ports.md +246 -0
  426. package/docs/guides/selection.md +270 -0
  427. package/docs/guides/the-grid.md +677 -0
  428. package/docs/guides/the-provider.md +446 -0
  429. package/docs/index.md +50 -0
  430. package/docs/install.md +67 -0
  431. package/docs/reference/cells.md +28 -0
  432. package/docs/reference/display.md +42 -0
  433. package/docs/reference/editors-chips.md +6 -0
  434. package/docs/reference/editors-date.md +6 -0
  435. package/docs/reference/editors-location.md +10 -0
  436. package/docs/reference/editors-name.md +6 -0
  437. package/docs/reference/editors-number.md +11 -0
  438. package/docs/reference/editors-open-values.md +9 -0
  439. package/docs/reference/editors-range.md +6 -0
  440. package/docs/reference/editors-relation.md +9 -0
  441. package/docs/reference/editors-select.md +8 -0
  442. package/docs/reference/editors-session.md +9 -0
  443. package/docs/reference/editors-value-list.md +6 -0
  444. package/docs/reference/editors.md +5 -0
  445. package/docs/reference/grid.md +39 -0
  446. package/docs/reference/react.md +86 -0
  447. package/docs/reference/selection.md +33 -0
  448. package/docs/reference/views.md +601 -0
  449. package/docs/reshaping.md +19 -0
  450. package/package.json +118 -3
  451. package/skills/views/SKILL.md +102 -0
@@ -0,0 +1,57 @@
1
+ export type ViewsToastPort = {
2
+ success: (message: string) => void;
3
+ error: (message: string) => void;
4
+ info: (message: string) => void;
5
+ /** A change the person did not make — a value someone else wrote — said with a second line. */
6
+ warning: (message: string, options?: {
7
+ description?: string;
8
+ }) => void;
9
+ };
10
+ export type ViewsHapticsPort = {
11
+ selection: () => void;
12
+ impact: (style: "light" | "medium" | "heavy") => void;
13
+ notification: (type: "success" | "warning" | "error") => void;
14
+ };
15
+ export type ViewsClipboardPort = {
16
+ /** Resolves to whether the text reached the clipboard. */
17
+ writeText: (text: string) => Promise<boolean>;
18
+ /** Resolves to the clipboard's text, or null where reading is refused. */
19
+ readText: () => Promise<string | null>;
20
+ };
21
+ /** Per-device state the grid keeps between visits: a width before the view
22
+ * saved it, a collapsed group. Keys are the package's, namespaced `vk:`. */
23
+ export type ViewsPrefsPort = {
24
+ get: <T>(key: string) => T | undefined;
25
+ set: <T>(key: string, value: T) => void;
26
+ subscribe: (key: string, listener: () => void) => () => void;
27
+ };
28
+ /** A question asked before an act, for the person to answer: the app's own dialog, or the browser's. */
29
+ export type ViewsConfirmRequest = {
30
+ /** The question, worded by the package's message (a row's Delete: `views.menus.row-delete-confirm`). */
31
+ message: string;
32
+ /** The yes button's words (a row's Delete: `views.menus.row-delete`). */
33
+ confirmLabel: string;
34
+ /** What the act is done to, as the host names it (a row's `deleteLabel`). Absent when it names nothing. */
35
+ subject?: string;
36
+ /** The act removes something: the app draws its destructive look. */
37
+ destructive?: boolean;
38
+ };
39
+ /** Resolves to whether the person said yes. */
40
+ export type ViewsConfirmPort = (request: ViewsConfirmRequest) => Promise<boolean>;
41
+ export type ViewsPorts = {
42
+ toast: ViewsToastPort;
43
+ haptics: ViewsHapticsPort;
44
+ clipboard: ViewsClipboardPort;
45
+ viewPrefs: ViewsPrefsPort;
46
+ /** Asks before a destructive act (a row's Delete). Absent: the browser's own confirm with `message`. */
47
+ confirm?: ViewsConfirmPort;
48
+ };
49
+ /** The ports as the provider hands them on: `confirm` always there, the browser's where the app
50
+ * handed none. */
51
+ export type ViewsResolvedPorts = ViewsPorts & {
52
+ confirm: ViewsConfirmPort;
53
+ };
54
+ /** The browser's own dialog, read when it is asked, so a server render never reaches `window`. */
55
+ export declare const browserConfirm: ViewsConfirmPort;
56
+ /** Ports that do nothing: a server render, a test, an app without a device. */
57
+ export declare const NOOP_PORTS: ViewsPorts;
@@ -0,0 +1,9 @@
1
+ export const browserConfirm = async ({ message }) => window.confirm(message);
2
+ const _portsMatchContract = true;
3
+ void _portsMatchContract;
4
+ export const NOOP_PORTS = {
5
+ toast: { success() { }, error() { }, info() { }, warning() { } },
6
+ haptics: { selection() { }, impact() { }, notification() { } },
7
+ clipboard: { writeText: async () => false, readText: async () => null },
8
+ viewPrefs: { get: () => undefined, set() { }, subscribe: () => () => { } },
9
+ };
@@ -0,0 +1,9 @@
1
+ export { ViewsProvider, useViews } from "./provider/ViewsProvider.js";
2
+ export type { ViewsContextValue, ViewsProviderProps } from "./provider/ViewsProvider.js";
3
+ export type { ViewsAlign, ViewsAnchor, ViewsButtonProps, ViewsCalendarProps, ViewsCheckboxProps, ViewsCloseReason, ViewsCollapseProps, ViewsCommandParts, ViewsComponents, ViewsMenuItem, ViewsMenuProps, ViewsOpenChange, ViewsPopoverProps, ViewsSheetProps, ViewsSide, ViewsTooltipProps, } from "./provider/components.js";
4
+ export type { ViewsIconProps, ViewsIcons } from "./provider/icons.js";
5
+ export { NOOP_PORTS } from "./provider/ports.js";
6
+ export type { ViewsClipboardPort, ViewsConfirmPort, ViewsConfirmRequest, ViewsHapticsPort, ViewsPorts, ViewsPrefsPort, ViewsResolvedPorts, ViewsToastPort, } from "./provider/ports.js";
7
+ export { DEFAULT_VIEWS_ATOMS } from "./atoms/defaults.js";
8
+ export type { ViewsAtoms, ViewsCommandMenuProps, ViewsRowMenuItem, ViewsRowMenuProps, ViewsListProps, ViewsRelationLinkProps, ViewsLoadingProps, ViewsLoadMoreProps, ViewsPlatformMarkProps, ViewsRowContentProps, ViewsRowProps, ViewsStatusBadgeProps, ViewsStatusMarkerProps, ViewsTagProps, ViewsTickBoxProps, } from "./atoms/types.js";
9
+ export type { ComponentName, PortName, ViewsIconName, ViewsMessage, ViewsMessageResolver } from "./contract.js";
package/dist/react.js ADDED
@@ -0,0 +1,4 @@
1
+ "use client";
2
+ export { ViewsProvider, useViews } from "./provider/ViewsProvider.js";
3
+ export { NOOP_PORTS } from "./provider/ports.js";
4
+ export { DEFAULT_VIEWS_ATOMS } from "./atoms/defaults.js";
@@ -0,0 +1,17 @@
1
+ type SelectCheckboxProps = {
2
+ checked: boolean;
3
+ /** When true the checkbox is pinned visible; otherwise it reveals on the gutter zone hover. */
4
+ revealed: boolean;
5
+ /** `shift` is true when the click was a shift-click (range select). */
6
+ onChange: (next: boolean, shift: boolean) => void;
7
+ "aria-label"?: string;
8
+ className?: string;
9
+ };
10
+ /**
11
+ * Row selection checkbox: the app's checkbox (in the portal, its neutral selection skin).
12
+ * Reveals only while the surrounding gutter hover-zone (`group/selzone`, set by the lane that
13
+ * holds it) is hovered — not the whole row — and reads the shift key off the press that changed
14
+ * it, for range selection.
15
+ */
16
+ export declare function SelectCheckbox({ checked, revealed, onChange, className, "aria-label": ariaLabel, }: SelectCheckboxProps): import("react/jsx-runtime").JSX.Element;
17
+ export {};
@@ -0,0 +1,11 @@
1
+ "use client";
2
+ import { jsx as _jsx } from "react/jsx-runtime";
3
+ import { cx } from "../internal/cx.js";
4
+ import { useViews } from "../provider/context.js";
5
+ export function SelectCheckbox({ checked, revealed, onChange, className, "aria-label": ariaLabel, }) {
6
+ const { Checkbox } = useViews().components;
7
+ return (_jsx(Checkbox, { checked: checked, "aria-label": ariaLabel, onCheckedChange: (next, details) => onChange(next, pressedWithShift(details?.event)), className: cx("opacity-0 group-hover/selzone:opacity-100", revealed && "opacity-100", checked && "opacity-100", className) }));
8
+ }
9
+ function pressedWithShift(event) {
10
+ return event !== undefined && "shiftKey" in event && event.shiftKey === true;
11
+ }
@@ -0,0 +1,7 @@
1
+ export type { ListBatchApi, ListSelectionConfig } from "./types.js";
2
+ export { SelectCheckbox } from "./SelectCheckbox.js";
3
+ export { useCheckDragSelect, ROW_CHECK_ATTR } from "./useCheckDragSelect.js";
4
+ export { preventShiftTextSelect, selectFromClick, ROW_INTERACTIVE_SELECTOR, ROW_NO_TEXT_SELECT, ROW_OPEN_STOP_SELECTOR, } from "./row-click.js";
5
+ export { REST_INTENT_MS, useRestIntent } from "./useRestIntent.js";
6
+ export { useListSelection, type SelectionRetention, type UseListSelectionResult } from "./useListSelection.js";
7
+ export { useEscapeToClear } from "./useListSelectionShortcuts.js";
@@ -0,0 +1,6 @@
1
+ export { SelectCheckbox } from "./SelectCheckbox.js";
2
+ export { useCheckDragSelect, ROW_CHECK_ATTR } from "./useCheckDragSelect.js";
3
+ export { preventShiftTextSelect, selectFromClick, ROW_INTERACTIVE_SELECTOR, ROW_NO_TEXT_SELECT, ROW_OPEN_STOP_SELECTOR, } from "./row-click.js";
4
+ export { REST_INTENT_MS, useRestIntent } from "./useRestIntent.js";
5
+ export { useListSelection } from "./useListSelection.js";
6
+ export { useEscapeToClear } from "./useListSelectionShortcuts.js";
@@ -0,0 +1,55 @@
1
+ export type SelectionRetention = "ordered" | "external";
2
+ export type SelectionContext = {
3
+ orderedIds: readonly string[];
4
+ retention: SelectionRetention;
5
+ resetKey?: string;
6
+ };
7
+ export type SelectionState = {
8
+ selectedIds: Set<string>;
9
+ anchorId: string | null;
10
+ orderKey: string;
11
+ retention: SelectionRetention;
12
+ resetKey?: string;
13
+ };
14
+ export type SelectionAction = {
15
+ type: "reconcile";
16
+ context: SelectionContext;
17
+ } | {
18
+ type: "toggle";
19
+ id: string;
20
+ next?: boolean;
21
+ context: SelectionContext;
22
+ } | {
23
+ type: "toggle-range";
24
+ id: string;
25
+ context: SelectionContext;
26
+ } | {
27
+ type: "toggle-many";
28
+ ids: readonly string[];
29
+ context: SelectionContext;
30
+ } | {
31
+ type: "select-all";
32
+ context: SelectionContext;
33
+ } | {
34
+ type: "clear";
35
+ context: SelectionContext;
36
+ } | {
37
+ type: "set-selected";
38
+ ids: readonly string[];
39
+ context: SelectionContext;
40
+ };
41
+ export declare function createSelectionState(context: SelectionContext): SelectionState;
42
+ /**
43
+ * Reconciles stored selection against the current visual order.
44
+ *
45
+ * `ordered` is the safe default for ordinary lists: ids that disappear from the
46
+ * current order are removed. `external` is reserved for query-wide or modal
47
+ * selections whose selected ids intentionally outlive the currently loaded or
48
+ * filtered rows. In both modes, a range anchor must remain visible to be valid.
49
+ */
50
+ export declare function reconcileSelection(state: SelectionState, context: SelectionContext): SelectionState;
51
+ export declare function selectionReducer(state: SelectionState, action: SelectionAction): SelectionState;
52
+ export declare function getSelectionSummary(selectedIds: ReadonlySet<string>, orderedIds: readonly string[]): {
53
+ allSelected: boolean;
54
+ someSelected: boolean;
55
+ };
@@ -0,0 +1,86 @@
1
+ function orderKey(orderedIds) {
2
+ return JSON.stringify(orderedIds);
3
+ }
4
+ export function createSelectionState(context) {
5
+ return {
6
+ selectedIds: new Set(),
7
+ anchorId: null,
8
+ orderKey: orderKey(context.orderedIds),
9
+ retention: context.retention,
10
+ resetKey: context.resetKey,
11
+ };
12
+ }
13
+ export function reconcileSelection(state, context) {
14
+ const nextOrderKey = orderKey(context.orderedIds);
15
+ if (state.resetKey !== context.resetKey) {
16
+ return createSelectionState(context);
17
+ }
18
+ if (state.orderKey === nextOrderKey && state.retention === context.retention)
19
+ return state;
20
+ const orderedSet = new Set(context.orderedIds);
21
+ const selectedIds = context.retention === "external"
22
+ ? state.selectedIds
23
+ : new Set([...state.selectedIds].filter((id) => orderedSet.has(id)));
24
+ return {
25
+ selectedIds,
26
+ anchorId: state.anchorId && orderedSet.has(state.anchorId) ? state.anchorId : null,
27
+ orderKey: nextOrderKey,
28
+ retention: context.retention,
29
+ resetKey: context.resetKey,
30
+ };
31
+ }
32
+ export function selectionReducer(state, action) {
33
+ const current = reconcileSelection(state, action.context);
34
+ switch (action.type) {
35
+ case "reconcile":
36
+ return current;
37
+ case "toggle": {
38
+ const selectedIds = new Set(current.selectedIds);
39
+ const shouldSelect = action.next ?? !selectedIds.has(action.id);
40
+ if (shouldSelect)
41
+ selectedIds.add(action.id);
42
+ else
43
+ selectedIds.delete(action.id);
44
+ return { ...current, selectedIds, anchorId: action.id };
45
+ }
46
+ case "toggle-range": {
47
+ const selectedIds = new Set(current.selectedIds);
48
+ const from = current.anchorId ? action.context.orderedIds.indexOf(current.anchorId) : -1;
49
+ const to = action.context.orderedIds.indexOf(action.id);
50
+ if (from === -1 || to === -1) {
51
+ selectedIds.add(action.id);
52
+ return { ...current, selectedIds };
53
+ }
54
+ const [lo, hi] = from <= to ? [from, to] : [to, from];
55
+ for (let index = lo; index <= hi; index += 1) {
56
+ selectedIds.add(action.context.orderedIds[index]);
57
+ }
58
+ return { ...current, selectedIds };
59
+ }
60
+ case "toggle-many": {
61
+ const selectedIds = new Set(current.selectedIds);
62
+ const allSelected = action.ids.length > 0 && action.ids.every((id) => selectedIds.has(id));
63
+ for (const id of action.ids) {
64
+ if (allSelected)
65
+ selectedIds.delete(id);
66
+ else
67
+ selectedIds.add(id);
68
+ }
69
+ return { ...current, selectedIds };
70
+ }
71
+ case "select-all":
72
+ return { ...current, selectedIds: new Set(action.context.orderedIds) };
73
+ case "clear":
74
+ return { ...current, selectedIds: new Set(), anchorId: null };
75
+ case "set-selected":
76
+ return { ...current, selectedIds: new Set(action.ids), anchorId: null };
77
+ }
78
+ }
79
+ export function getSelectionSummary(selectedIds, orderedIds) {
80
+ const selectedOrderedCount = orderedIds.reduce((count, id) => count + Number(selectedIds.has(id)), 0);
81
+ const allSelected = orderedIds.length > 0 && selectedOrderedCount === orderedIds.length;
82
+ return {
83
+ allSelected,
84
+ someSelected: selectedOrderedCount > 0 && !allSelected,
85
+ };
86
+ }
@@ -0,0 +1,35 @@
1
+ import type { MouseEvent } from "react";
2
+ import type { UseListSelectionResult } from "./useListSelection.js";
3
+ /**
4
+ * Modifier-click selection for a list row. Cmd/Ctrl-click toggles the row;
5
+ * Shift-click extends the range. Returns `true` when it handled a modifier
6
+ * click — the caller should then `return` before opening the drawer.
7
+ *
8
+ * onClick={(e) => {
9
+ * // ...existing guards (data-action-menu, links, etc.)...
10
+ * if (selectFromClick(e, id, sel)) return;
11
+ * openDrawer(...);
12
+ * }}
13
+ */
14
+ export declare function selectFromClick(e: MouseEvent, id: string, sel: Pick<UseListSelectionResult, "toggle" | "toggleRange">): boolean;
15
+ /** `onMouseDown` guard that stops shift-click from triggering native text selection. */
16
+ export declare function preventShiftTextSelect(e: MouseEvent): void;
17
+ /**
18
+ * A row click lands on something genuinely interactive → that control handles it
19
+ * (in BOTH normal and selection mode). A click anywhere else opens the row, or
20
+ * toggles it while selecting. Deliberately NOT `[data-action-menu]` — bailing on a
21
+ * wrapper (often full-width) created dead zones in the padding around a control.
22
+ */
23
+ export declare const ROW_INTERACTIVE_SELECTOR: string;
24
+ /**
25
+ * Regions that should NOT open the row (e.g. the trailing kebab/meta gutter) but
26
+ * SHOULD still toggle selection when the list is in selection mode — so the whole
27
+ * row is a selection target except for real interactive controls. Checked AFTER
28
+ * the selection-mode toggle, so it only gates the open. Apply tightly.
29
+ */
30
+ export declare const ROW_OPEN_STOP_SELECTOR = "[data-row-stop]";
31
+ /**
32
+ * Class for selectable list rows — disables native text selection and the iOS
33
+ * long-press callout, so long-press-to-select doesn't also highlight text.
34
+ */
35
+ export declare const ROW_NO_TEXT_SELECT = "select-none [-webkit-touch-callout:none]";
@@ -0,0 +1,20 @@
1
+ export function selectFromClick(e, id, sel) {
2
+ if (e.metaKey || e.ctrlKey) {
3
+ sel.toggle(id);
4
+ return true;
5
+ }
6
+ if (e.shiftKey) {
7
+ sel.toggleRange(id);
8
+ return true;
9
+ }
10
+ return false;
11
+ }
12
+ export function preventShiftTextSelect(e) {
13
+ if (e.shiftKey)
14
+ e.preventDefault();
15
+ }
16
+ export const ROW_INTERACTIVE_SELECTOR = 'a, button, input, select, textarea, label, [role="button"], [role="switch"], ' +
17
+ '[role="checkbox"], [role="menuitem"], [role="tab"], [contenteditable="true"], ' +
18
+ "[data-popover-trigger], [data-no-nav]";
19
+ export const ROW_OPEN_STOP_SELECTOR = "[data-row-stop]";
20
+ export const ROW_NO_TEXT_SELECT = "select-none [-webkit-touch-callout:none]";
@@ -0,0 +1,17 @@
1
+ import type { ReactNode } from "react";
2
+ import type { SelectionRetention, UseListSelectionResult } from "./useListSelection.js";
3
+ /** Batch-write capability supplied by a renderer with an editing model. */
4
+ export type ListBatchApi = {
5
+ setColumnValue: (rowIds: string[], columnId: string, value: unknown) => Promise<boolean>;
6
+ };
7
+ /** View-neutral multi-select contract shared by List and Table renderers. */
8
+ export type ListSelectionConfig = {
9
+ /** Visual order used by range selection and select-all. */
10
+ orderedIds?: string[];
11
+ /** Keep ids outside the current visual order only for query-wide selection. */
12
+ retention?: SelectionRetention;
13
+ /** Selection clears whenever this view/filter identity changes. */
14
+ resetKey: string;
15
+ /** Render the floating bar, optionally with the active renderer's batch API. */
16
+ renderBar: (sel: UseListSelectionResult, batch?: ListBatchApi) => ReactNode;
17
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,61 @@
1
+ import { type PointerEvent as ReactPointerEvent, type RefObject } from "react";
2
+ /**
3
+ * Marker attribute on a row's checkbox lane. The drag recognises its starting
4
+ * point by this rather than by the checkbox element itself, so the whole lane
5
+ * is grabbable — which is what you actually aim at once the lane goes opaque
6
+ * during a selection.
7
+ */
8
+ export declare const ROW_CHECK_ATTR = "data-row-check";
9
+ /**
10
+ * Drag down the checkbox lane to select a run of rows (Sheets / Notion).
11
+ *
12
+ * The gesture is a RANGE from the anchor to the row under the pointer, not a
13
+ * one-way paint. Everything between them takes a single value, decided once
14
+ * from the row you started on (`!isSelected(anchor)`) — so a drag that begins
15
+ * on an unselected row selects, and one that begins on a selected row clears.
16
+ * Deciding per row instead would flip rows back off the moment you crossed them
17
+ * twice.
18
+ *
19
+ * Dragging BACK shrinks the range: rows that fall outside it are restored to
20
+ * whatever they were before the drag touched them, which is why `original`
21
+ * exists. Without that, retreating would leave a trail of rows you'd already
22
+ * changed your mind about — the exact complaint that motivated this.
23
+ *
24
+ * The anchor is painted only after the 4px threshold, so a plain click is still
25
+ * a plain click and the checkbox's own handler owns it. Once the drag is real,
26
+ * the click that follows pointerup is swallowed by the caller (`consumeDrag`) —
27
+ * otherwise the checkbox would toggle the anchor a second time and undo the
28
+ * first row of the drag.
29
+ *
30
+ * Past the scroller's edge the drag keeps going: a rAF loop scrolls the
31
+ * container and re-hit-tests the row under the (now stationary) pointer, so
32
+ * the range keeps extending without the mouse moving.
33
+ *
34
+ * Mouse only: on touch, a vertical drag from the gutter is a scroll, and there
35
+ * is no way to tell the two apart in time.
36
+ */
37
+ export declare function useCheckDragSelect({ enabled, rootRef, rowIds, rowIdOf, isSelected, setRowSelected, }: {
38
+ /** The list is selectable. When false the hook never arms. */
39
+ enabled: boolean;
40
+ /** Container the drag stays within — rows outside it are ignored. */
41
+ rootRef: RefObject<HTMLElement | null>;
42
+ /**
43
+ * Row ids in VISIBLE order — the span between anchor and pointer is a slice
44
+ * of this. Must exclude rows the user can't see (collapsed groups), or
45
+ * dragging past a collapsed group would silently select its contents.
46
+ */
47
+ rowIds: string[];
48
+ /**
49
+ * What a row's `data-row-id` attribute resolves to in `rowIds`' id space.
50
+ * The grid writes a composite `group␟record` key there (one record can be
51
+ * drawn under several groups), while selection is keyed by record — without
52
+ * this the anchor never matches and the drag selects nothing.
53
+ */
54
+ rowIdOf?: (attr: string) => string;
55
+ isSelected: (id: string) => boolean;
56
+ /** Set one row's membership explicitly (never a toggle — see above). */
57
+ setRowSelected: (id: string, next: boolean) => void;
58
+ }): {
59
+ tryArm: (e: ReactPointerEvent) => boolean;
60
+ consumeDrag: () => boolean;
61
+ };
@@ -0,0 +1,165 @@
1
+ "use client";
2
+ import { useCallback, useEffect, useRef, } from "react";
3
+ export const ROW_CHECK_ATTR = "data-row-check";
4
+ const EDGE_PX = 40;
5
+ const MAX_STEP_PX = 24;
6
+ function verticalScrollerOf(root) {
7
+ let node = root;
8
+ while (node && node !== document.body) {
9
+ const oy = getComputedStyle(node).overflowY;
10
+ if ((oy === "auto" || oy === "scroll") && node.scrollHeight > node.clientHeight)
11
+ return node;
12
+ node = node.parentElement;
13
+ }
14
+ return (document.scrollingElement ?? document.documentElement);
15
+ }
16
+ function edgeStep(y, scroller) {
17
+ const isDocument = scroller === document.scrollingElement || scroller === document.documentElement;
18
+ const top = isDocument ? 0 : scroller.getBoundingClientRect().top;
19
+ const bottom = isDocument ? window.innerHeight : scroller.getBoundingClientRect().bottom;
20
+ if (y < top + EDGE_PX)
21
+ return -Math.min(MAX_STEP_PX, Math.ceil((top + EDGE_PX - y) / 4));
22
+ if (y > bottom - EDGE_PX)
23
+ return Math.min(MAX_STEP_PX, Math.ceil((y - (bottom - EDGE_PX)) / 4));
24
+ return 0;
25
+ }
26
+ export function useCheckDragSelect({ enabled, rootRef, rowIds, rowIdOf = (attr) => attr, isSelected, setRowSelected, }) {
27
+ const dragRef = useRef(null);
28
+ const draggedRef = useRef(false);
29
+ const isSelectedRef = useRef(isSelected);
30
+ const setRowSelectedRef = useRef(setRowSelected);
31
+ const rowIdsRef = useRef(rowIds);
32
+ const rowIdOfRef = useRef(rowIdOf);
33
+ useEffect(() => {
34
+ isSelectedRef.current = isSelected;
35
+ setRowSelectedRef.current = setRowSelected;
36
+ rowIdsRef.current = rowIds;
37
+ rowIdOfRef.current = rowIdOf;
38
+ });
39
+ useEffect(() => {
40
+ if (!enabled)
41
+ return;
42
+ let raf = null;
43
+ let scroller = null;
44
+ const applyRange = (d, headId) => {
45
+ const ids = rowIdsRef.current;
46
+ const a = ids.indexOf(d.rowId);
47
+ const h = ids.indexOf(headId);
48
+ if (a < 0 || h < 0)
49
+ return;
50
+ const inRange = new Set(ids.slice(Math.min(a, h), Math.max(a, h) + 1));
51
+ for (const [id, was] of d.original) {
52
+ if (inRange.has(id))
53
+ continue;
54
+ setRowSelectedRef.current(id, was);
55
+ d.original.delete(id);
56
+ }
57
+ for (const id of inRange) {
58
+ if (d.original.has(id))
59
+ continue;
60
+ d.original.set(id, isSelectedRef.current(id));
61
+ setRowSelectedRef.current(id, d.value);
62
+ }
63
+ };
64
+ const hitTest = (d) => {
65
+ const el = document.elementFromPoint(d.lastX, d.lastY);
66
+ const rowEl = el?.closest?.("[data-row-id]");
67
+ if (!rowEl || !rootRef.current?.contains(rowEl))
68
+ return;
69
+ const attr = rowEl.getAttribute("data-row-id");
70
+ if (attr)
71
+ applyRange(d, rowIdOfRef.current(attr));
72
+ };
73
+ const stopScrolling = () => {
74
+ if (raf != null)
75
+ cancelAnimationFrame(raf);
76
+ raf = null;
77
+ scroller = null;
78
+ };
79
+ const tick = () => {
80
+ raf = null;
81
+ const d = dragRef.current;
82
+ if (!d?.active || !scroller)
83
+ return;
84
+ const step = edgeStep(d.lastY, scroller);
85
+ if (step === 0)
86
+ return;
87
+ const before = scroller.scrollTop;
88
+ scroller.scrollTop = before + step;
89
+ if (scroller.scrollTop === before)
90
+ return;
91
+ hitTest(d);
92
+ raf = requestAnimationFrame(tick);
93
+ };
94
+ const maybeScroll = (d) => {
95
+ if (!scroller && rootRef.current)
96
+ scroller = verticalScrollerOf(rootRef.current);
97
+ if (!scroller || raf != null)
98
+ return;
99
+ if (edgeStep(d.lastY, scroller) !== 0)
100
+ raf = requestAnimationFrame(tick);
101
+ };
102
+ const onMove = (e) => {
103
+ const d = dragRef.current;
104
+ if (!d)
105
+ return;
106
+ d.lastX = e.clientX;
107
+ d.lastY = e.clientY;
108
+ if (!d.active) {
109
+ if (Math.abs(e.clientY - d.startY) < 4 && Math.abs(e.clientX - d.startX) < 4)
110
+ return;
111
+ d.active = true;
112
+ draggedRef.current = true;
113
+ document.body.style.userSelect = "none";
114
+ applyRange(d, d.rowId);
115
+ }
116
+ hitTest(d);
117
+ maybeScroll(d);
118
+ };
119
+ const onUp = () => {
120
+ const d = dragRef.current;
121
+ dragRef.current = null;
122
+ stopScrolling();
123
+ if (d?.active)
124
+ document.body.style.userSelect = "";
125
+ };
126
+ window.addEventListener("pointermove", onMove);
127
+ window.addEventListener("pointerup", onUp);
128
+ return () => {
129
+ stopScrolling();
130
+ window.removeEventListener("pointermove", onMove);
131
+ window.removeEventListener("pointerup", onUp);
132
+ };
133
+ }, [enabled, rootRef]);
134
+ const tryArm = useCallback((e) => {
135
+ if (!enabled || e.button !== 0 || e.pointerType !== "mouse")
136
+ return false;
137
+ const target = e.target;
138
+ if (!target.closest(`[${ROW_CHECK_ATTR}]`))
139
+ return false;
140
+ const rowEl = target.closest("[data-row-id]");
141
+ const attr = rowEl?.getAttribute("data-row-id");
142
+ if (!attr)
143
+ return false;
144
+ const rowId = rowIdOfRef.current(attr);
145
+ draggedRef.current = false;
146
+ dragRef.current = {
147
+ startX: e.clientX,
148
+ startY: e.clientY,
149
+ lastX: e.clientX,
150
+ lastY: e.clientY,
151
+ rowId,
152
+ value: !isSelectedRef.current(rowId),
153
+ active: false,
154
+ original: new Map(),
155
+ };
156
+ return true;
157
+ }, [enabled]);
158
+ const consumeDrag = useCallback(() => {
159
+ if (!draggedRef.current)
160
+ return false;
161
+ draggedRef.current = false;
162
+ return true;
163
+ }, []);
164
+ return { tryArm, consumeDrag };
165
+ }
@@ -0,0 +1,39 @@
1
+ import { type SelectionRetention } from "./model.js";
2
+ export type { SelectionRetention } from "./model.js";
3
+ export type UseListSelectionResult = {
4
+ selectedIds: Set<string>;
5
+ count: number;
6
+ isSelected: (id: string) => boolean;
7
+ /** Toggle one id. When `next` is omitted, flips current membership. Sets the range anchor. */
8
+ toggle: (id: string, next?: boolean) => void;
9
+ /** Shift-click: additively select the range anchor→id over the current visual order. */
10
+ toggleRange: (id: string) => void;
11
+ /** Group toggle: select all `ids` unless they're already all selected, then deselect them. */
12
+ toggleMany: (ids: string[]) => void;
13
+ /** Select every currently-ordered id. */
14
+ selectAll: () => void;
15
+ /** Empty the selection and reset the anchor. */
16
+ clear: () => void;
17
+ setSelected: (ids: string[]) => void;
18
+ /** True when every ordered id is selected (and there is at least one). */
19
+ allSelected: boolean;
20
+ /** True when some — but not all — ordered ids are selected (indeterminate). */
21
+ someSelected: boolean;
22
+ anchorId: string | null;
23
+ };
24
+ /**
25
+ * Headless multi-select state for list pages. Generalizes the per-page
26
+ * `Set<string>` selection pattern used by Tasks
27
+ * (the portal's Tasks page) and adds a range anchor for
28
+ * shift-click.
29
+ *
30
+ * `orderedIds` must be the ids in current *visual* order (post filter+sort+group
31
+ * flatten) so range-select and select-all/indeterminate honor exactly what's on
32
+ * screen. `retention="external"` is an explicit escape hatch for query-wide or
33
+ * filtered-modal selection where selected ids may intentionally be offscreen.
34
+ */
35
+ export declare function useListSelection({ orderedIds, retention, resetKey, }: {
36
+ orderedIds: string[];
37
+ retention?: SelectionRetention;
38
+ resetKey?: string;
39
+ }): UseListSelectionResult;