@viewkitjs/views 0.1.0 → 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 (246) hide show
  1. package/CHANGELOG.md +196 -1
  2. package/README.md +90 -41
  3. package/dist/atoms/Row.js +1 -1
  4. package/dist/atoms/RowMenu.d.ts +1 -1
  5. package/dist/atoms/RowMenu.js +15 -4
  6. package/dist/atoms/types.d.ts +4 -4
  7. package/dist/contract.d.ts +37 -7
  8. package/dist/contract.js +24 -5
  9. package/dist/display/format.d.ts +16 -1
  10. package/dist/display/format.js +10 -1
  11. package/dist/display/index.d.ts +1 -1
  12. package/dist/display/index.js +1 -1
  13. package/dist/display/link.js +5 -3
  14. package/dist/display/location.d.ts +4 -3
  15. package/dist/display/location.js +12 -5
  16. package/dist/display/options.d.ts +1 -1
  17. package/dist/display/percent.js +10 -3
  18. package/dist/display/phone.d.ts +2 -1
  19. package/dist/display/phone.js +8 -1
  20. package/dist/display/relation.js +1 -1
  21. package/dist/editors/ChipsEditor.js +1 -1
  22. package/dist/editors/LocationEditor.js +16 -17
  23. package/dist/editors/NameEditor.js +5 -4
  24. package/dist/editors/NumberEditor.js +2 -2
  25. package/dist/editors/RangeEditor.js +2 -2
  26. package/dist/editors/ValueListEditor.d.ts +2 -2
  27. package/dist/editors/ValueListEditor.js +8 -8
  28. package/dist/editors/edit-cores.d.ts +1 -1
  29. package/dist/fields/binding.d.ts +1 -1
  30. package/dist/fields/currency.d.ts +0 -10
  31. package/dist/fields/currency.js +0 -14
  32. package/dist/fields/money.d.ts +1 -0
  33. package/dist/fields/money.js +1 -0
  34. package/dist/filters/filter-model.d.ts +0 -1
  35. package/dist/filters/registry.d.ts +3 -36
  36. package/dist/filters/registry.js +0 -38
  37. package/dist/grid/chrome/GridAddColumn.d.ts +11 -0
  38. package/dist/grid/chrome/GridAddColumn.js +29 -0
  39. package/dist/grid/chrome/GridAggregateMenu.d.ts +31 -0
  40. package/dist/grid/chrome/GridAggregateMenu.js +27 -0
  41. package/dist/grid/chrome/GridCellEditors.d.ts +64 -0
  42. package/dist/grid/chrome/GridCellEditors.js +55 -0
  43. package/dist/grid/chrome/GridCellOutline.d.ts +70 -0
  44. package/dist/grid/chrome/GridCellOutline.js +21 -0
  45. package/dist/grid/chrome/GridChipsEditor.d.ts +28 -0
  46. package/dist/grid/chrome/GridChipsEditor.js +40 -0
  47. package/dist/grid/chrome/GridColumnColorSection.d.ts +11 -0
  48. package/dist/grid/chrome/GridColumnColorSection.js +40 -0
  49. package/dist/grid/chrome/GridColumnDateSection.d.ts +23 -0
  50. package/dist/grid/chrome/GridColumnDateSection.js +23 -0
  51. package/dist/grid/chrome/GridColumnDurationSection.d.ts +19 -0
  52. package/dist/grid/chrome/GridColumnDurationSection.js +24 -0
  53. package/dist/grid/chrome/GridColumnMenu.d.ts +101 -0
  54. package/dist/grid/chrome/GridColumnMenu.js +99 -0
  55. package/dist/grid/chrome/GridColumnNumberSection.d.ts +25 -0
  56. package/dist/grid/chrome/GridColumnNumberSection.js +27 -0
  57. package/dist/grid/chrome/GridColumnPercentSection.d.ts +15 -0
  58. package/dist/grid/chrome/GridColumnPercentSection.js +16 -0
  59. package/dist/grid/chrome/GridColumnSortSection.d.ts +18 -0
  60. package/dist/grid/chrome/GridColumnSortSection.js +16 -0
  61. package/dist/grid/chrome/GridDateEditor.d.ts +22 -0
  62. package/dist/grid/chrome/GridDateEditor.js +31 -0
  63. package/dist/grid/chrome/GridFlyout.d.ts +44 -0
  64. package/dist/grid/chrome/GridFlyout.js +80 -0
  65. package/dist/grid/chrome/GridFooter.d.ts +23 -0
  66. package/dist/grid/chrome/GridFooter.js +81 -0
  67. package/dist/grid/chrome/GridGroupMenu.d.ts +37 -0
  68. package/dist/grid/chrome/GridGroupMenu.js +57 -0
  69. package/dist/grid/chrome/GridHeader.d.ts +61 -0
  70. package/dist/grid/chrome/GridHeader.js +37 -0
  71. package/dist/grid/chrome/GridLongTextEditor.d.ts +36 -0
  72. package/dist/grid/chrome/GridLongTextEditor.js +127 -0
  73. package/dist/grid/chrome/GridMenuRow.d.ts +15 -0
  74. package/dist/grid/chrome/GridMenuRow.js +15 -0
  75. package/dist/grid/chrome/GridNameEditor.d.ts +19 -0
  76. package/dist/grid/chrome/GridNameEditor.js +36 -0
  77. package/dist/grid/chrome/GridNumberEditor.d.ts +35 -0
  78. package/dist/grid/chrome/GridNumberEditor.js +25 -0
  79. package/dist/grid/chrome/GridRangeEditor.d.ts +20 -0
  80. package/dist/grid/chrome/GridRangeEditor.js +25 -0
  81. package/dist/grid/chrome/GridRelationEditor.d.ts +21 -0
  82. package/dist/grid/chrome/GridRelationEditor.js +30 -0
  83. package/dist/grid/chrome/GridResizeHandle.d.ts +19 -0
  84. package/dist/grid/chrome/GridResizeHandle.js +19 -0
  85. package/dist/grid/chrome/GridRow.d.ts +25 -0
  86. package/dist/grid/chrome/GridRow.js +136 -0
  87. package/dist/grid/chrome/GridRowActions.d.ts +32 -0
  88. package/dist/grid/chrome/GridRowActions.js +25 -0
  89. package/dist/grid/chrome/GridRowCells.d.ts +4 -0
  90. package/dist/grid/chrome/GridRowCells.js +133 -0
  91. package/dist/grid/chrome/GridRowGlyph.d.ts +12 -0
  92. package/dist/grid/chrome/GridRowGlyph.js +13 -0
  93. package/dist/grid/chrome/GridSelectEditor.d.ts +18 -0
  94. package/dist/grid/chrome/GridSelectEditor.js +49 -0
  95. package/dist/grid/chrome/GridStructure.d.ts +48 -0
  96. package/dist/grid/chrome/GridStructure.js +45 -0
  97. package/dist/grid/chrome/GridTable.d.ts +4 -0
  98. package/dist/grid/chrome/GridTable.js +125 -0
  99. package/dist/grid/chrome/GridTableSurface.d.ts +15 -0
  100. package/dist/grid/chrome/GridTableSurface.js +6 -0
  101. package/dist/grid/chrome/GridTextEditor.d.ts +11 -0
  102. package/dist/grid/chrome/GridTextEditor.js +40 -0
  103. package/dist/grid/chrome/GridValueListEditor.d.ts +18 -0
  104. package/dist/grid/chrome/GridValueListEditor.js +36 -0
  105. package/dist/grid/chrome/StuckMarker.d.ts +16 -0
  106. package/dist/grid/chrome/StuckMarker.js +34 -0
  107. package/dist/grid/chrome/cell-clipboard.d.ts +9 -0
  108. package/dist/grid/chrome/cell-clipboard.js +28 -0
  109. package/dist/grid/chrome/cells.d.ts +21 -0
  110. package/dist/grid/chrome/cells.js +20 -0
  111. package/dist/grid/chrome/checks.d.ts +35 -0
  112. package/dist/grid/chrome/checks.js +22 -0
  113. package/dist/grid/chrome/column-glyph.d.ts +14 -0
  114. package/dist/grid/chrome/column-glyph.js +44 -0
  115. package/dist/grid/chrome/editors.d.ts +9 -0
  116. package/dist/grid/chrome/editors.js +10 -0
  117. package/dist/grid/chrome/grid-cell-classes.d.ts +59 -0
  118. package/dist/grid/chrome/grid-cell-classes.js +30 -0
  119. package/dist/grid/chrome/grid-menu-search.d.ts +7 -0
  120. package/dist/grid/chrome/grid-menu-search.js +7 -0
  121. package/dist/grid/chrome/grid-row-props.d.ts +131 -0
  122. package/dist/grid/chrome/grid-row-props.js +1 -0
  123. package/dist/grid/chrome/grid-styles.d.ts +37 -0
  124. package/dist/grid/chrome/grid-styles.js +8 -0
  125. package/dist/grid/chrome/grid-table-props.d.ts +173 -0
  126. package/dist/grid/chrome/grid-table-props.js +1 -0
  127. package/dist/grid/chrome/useGridBatchApi.d.ts +34 -0
  128. package/dist/grid/chrome/useGridBatchApi.js +35 -0
  129. package/dist/grid/chrome/useGridColumnLayout.d.ts +30 -0
  130. package/dist/grid/chrome/useGridColumnLayout.js +206 -0
  131. package/dist/grid/chrome/useGridHeaderDrag.d.ts +20 -0
  132. package/dist/grid/chrome/useGridHeaderDrag.js +37 -0
  133. package/dist/grid/chrome/useGridKeyboard.d.ts +47 -0
  134. package/dist/grid/chrome/useGridKeyboard.js +274 -0
  135. package/dist/grid/chrome/useGridPendingReconciliation.d.ts +12 -0
  136. package/dist/grid/chrome/useGridPendingReconciliation.js +32 -0
  137. package/dist/grid/chrome/useGridRailReveal.d.ts +57 -0
  138. package/dist/grid/chrome/useGridRailReveal.js +67 -0
  139. package/dist/grid/chrome/useGridRangeActions.d.ts +49 -0
  140. package/dist/grid/chrome/useGridRangeActions.js +188 -0
  141. package/dist/grid/chrome/useGridRangeGestures.d.ts +32 -0
  142. package/dist/grid/chrome/useGridRangeGestures.js +190 -0
  143. package/dist/grid/chrome/useGridRowContextMenu.d.ts +35 -0
  144. package/dist/grid/chrome/useGridRowContextMenu.js +127 -0
  145. package/dist/grid/chrome/useGridScaleStyles.d.ts +1 -0
  146. package/dist/grid/chrome/useGridScaleStyles.js +29 -0
  147. package/dist/grid/chrome/useGridScrollSync.d.ts +38 -0
  148. package/dist/grid/chrome/useGridScrollSync.js +176 -0
  149. package/dist/grid/chrome/useGridTableInteractionModel.d.ts +55 -0
  150. package/dist/grid/chrome/useGridTableInteractionModel.js +197 -0
  151. package/dist/grid/chrome/useGridTableSelection.d.ts +29 -0
  152. package/dist/grid/chrome/useGridTableSelection.js +55 -0
  153. package/dist/grid/chrome/useHeaderDragReorder.d.ts +21 -0
  154. package/dist/grid/chrome/useHeaderDragReorder.js +216 -0
  155. package/dist/grid/core/clipboard-model.d.ts +81 -0
  156. package/dist/grid/core/clipboard-model.js +291 -0
  157. package/dist/grid/core/column-values.d.ts +27 -0
  158. package/dist/grid/core/column-values.js +76 -0
  159. package/dist/grid/core/commit-model.d.ts +34 -0
  160. package/dist/grid/core/commit-model.js +3 -0
  161. package/dist/grid/core/coordinates.d.ts +48 -0
  162. package/dist/grid/core/coordinates.js +27 -0
  163. package/dist/grid/core/edit-values.d.ts +9 -0
  164. package/dist/grid/core/edit-values.js +1 -0
  165. package/dist/grid/core/editing-controller.d.ts +59 -0
  166. package/dist/grid/core/editing-controller.js +240 -0
  167. package/dist/grid/core/editing-model.d.ts +78 -0
  168. package/dist/grid/core/editing-model.js +136 -0
  169. package/dist/grid/core/grid-scale.d.ts +14 -0
  170. package/dist/grid/core/grid-scale.js +8 -0
  171. package/dist/grid/core/nav.d.ts +94 -0
  172. package/dist/grid/core/nav.js +92 -0
  173. package/dist/grid/core/pending-reconciliation.d.ts +50 -0
  174. package/dist/grid/core/pending-reconciliation.js +49 -0
  175. package/dist/grid/core/range-model.d.ts +25 -0
  176. package/dist/grid/core/range-model.js +59 -0
  177. package/dist/grid/core/spreadsheet-operations.d.ts +85 -0
  178. package/dist/grid/core/spreadsheet-operations.js +253 -0
  179. package/dist/grid/core/useGridEditing.d.ts +43 -0
  180. package/dist/grid/core/useGridEditing.js +90 -0
  181. package/dist/grid/core/useGridRange.d.ts +20 -0
  182. package/dist/grid/core/useGridRange.js +24 -0
  183. package/dist/grid/core/value-equality.d.ts +32 -0
  184. package/dist/grid/core/value-equality.js +34 -0
  185. package/dist/grid/index.d.ts +18 -0
  186. package/dist/grid/index.js +5 -0
  187. package/dist/grid/useGridTablePrefs.d.ts +50 -0
  188. package/dist/grid/useGridTablePrefs.js +101 -0
  189. package/dist/index.d.ts +0 -1
  190. package/dist/index.js +0 -1
  191. package/dist/internal/viewport.d.ts +5 -0
  192. package/dist/internal/viewport.js +29 -0
  193. package/dist/model/column-capabilities.d.ts +2 -2
  194. package/dist/model/column-state.d.ts +1 -1
  195. package/dist/model/density.js +3 -3
  196. package/dist/model/filter-capabilities.d.ts +1 -1
  197. package/dist/model/filter-capabilities.js +1 -1
  198. package/dist/model/index.d.ts +4 -6
  199. package/dist/model/index.js +0 -1
  200. package/dist/model/preferences.d.ts +7 -3
  201. package/dist/provider/ViewsProvider.d.ts +1 -1
  202. package/dist/provider/ViewsProvider.js +5 -1
  203. package/dist/provider/components.d.ts +16 -8
  204. package/dist/provider/context.d.ts +3 -2
  205. package/dist/provider/menu-groups.d.ts +8 -0
  206. package/dist/provider/menu-groups.js +38 -0
  207. package/dist/provider/ports.d.ts +22 -0
  208. package/dist/provider/ports.js +1 -0
  209. package/dist/react.d.ts +1 -1
  210. package/docs/contract.md +128 -56
  211. package/docs/getting-started.md +250 -0
  212. package/docs/guides/atoms.md +245 -0
  213. package/docs/guides/cells.md +302 -0
  214. package/docs/guides/columns.md +412 -0
  215. package/docs/guides/display.md +203 -0
  216. package/docs/guides/editors.md +404 -0
  217. package/docs/guides/ports.md +246 -0
  218. package/docs/guides/selection.md +270 -0
  219. package/docs/guides/the-grid.md +677 -0
  220. package/docs/guides/the-provider.md +446 -0
  221. package/docs/index.md +50 -0
  222. package/docs/install.md +9 -47
  223. package/docs/reference/cells.md +28 -0
  224. package/docs/reference/display.md +42 -0
  225. package/docs/reference/editors-chips.md +6 -0
  226. package/docs/reference/editors-date.md +6 -0
  227. package/docs/reference/editors-location.md +10 -0
  228. package/docs/reference/editors-name.md +6 -0
  229. package/docs/reference/editors-number.md +11 -0
  230. package/docs/reference/editors-open-values.md +9 -0
  231. package/docs/reference/editors-range.md +6 -0
  232. package/docs/reference/editors-relation.md +9 -0
  233. package/docs/reference/editors-select.md +8 -0
  234. package/docs/reference/editors-session.md +9 -0
  235. package/docs/reference/editors-value-list.md +6 -0
  236. package/docs/reference/editors.md +5 -0
  237. package/docs/reference/grid.md +39 -0
  238. package/docs/reference/react.md +86 -0
  239. package/docs/reference/selection.md +33 -0
  240. package/docs/reference/views.md +601 -0
  241. package/package.json +7 -3
  242. package/skills/views/SKILL.md +20 -5
  243. package/dist/filters/types.d.ts +0 -27
  244. package/dist/filters/types.js +0 -1
  245. package/dist/model/filter-pushdown.d.ts +0 -106
  246. package/dist/model/filter-pushdown.js +0 -147
@@ -0,0 +1,127 @@
1
+ "use client";
2
+ import { jsx as _jsx } from "react/jsx-runtime";
3
+ import { useState } from "react";
4
+ import { useViews } from "../../provider/context.js";
5
+ import { gridColumnHasEditor } from "../../model/column-capabilities.js";
6
+ import { cellClearPrev, cellEditBaseline, cellPrevPayload, coercePaste, copyCell, getGridClipboard, rowHoldsCurrency, } from "./cell-clipboard.js";
7
+ export function useGridRowContextMenu({ row, id, rowKey, columns, selecting, selectable, selected, toggle, editingEnabled, pendingByCol, selectValues, rowRange, contextMenu, inActiveRange, rangeCanClear, onRangeCopy, onRangeCut, onRangePaste, onRangeClear, onPasteAtCell, onCommitCell, onFocusCell, }) {
8
+ const { conventions, ports, messages, icons } = useViews();
9
+ const copyLabel = messages({ key: "views.menus.copy" });
10
+ const cutLabel = messages({ key: "views.menus.cut" });
11
+ const pasteLabel = messages({ key: "views.menus.paste" });
12
+ const clearLabel = messages({ key: "views.menus.clear" });
13
+ const [menuColumnId, setMenuColumnId] = useState(null);
14
+ const menuColumn = menuColumnId
15
+ ? columns.find((column) => column.id === menuColumnId)
16
+ : undefined;
17
+ const editBaseline = (column) => cellEditBaseline(column, row, pendingByCol);
18
+ const canEdit = (column) => editingEnabled && gridColumnHasEditor(column);
19
+ const cellItems = [];
20
+ if (menuColumn && !selecting && inActiveRange(rowKey, menuColumn.id)) {
21
+ const clipboard = getGridClipboard();
22
+ cellItems.push({
23
+ label: copyLabel,
24
+ icon: _jsx(icons.copy, { className: "h-4 w-4" }),
25
+ shortcut: "⌘C",
26
+ onClick: onRangeCopy,
27
+ });
28
+ if (editingEnabled) {
29
+ const canClear = rangeCanClear();
30
+ cellItems.push({
31
+ label: cutLabel,
32
+ icon: _jsx(icons.cut, { className: "h-4 w-4" }),
33
+ shortcut: "⌘X",
34
+ disabled: !canClear,
35
+ onClick: onRangeCut,
36
+ }, {
37
+ label: pasteLabel,
38
+ icon: _jsx(icons.paste, { className: "h-4 w-4" }),
39
+ shortcut: "⌘V",
40
+ disabled: !clipboard,
41
+ onClick: onRangePaste,
42
+ }, {
43
+ label: clearLabel,
44
+ icon: _jsx(icons.clear, { className: "h-4 w-4" }),
45
+ disabled: !canClear,
46
+ onClick: onRangeClear,
47
+ });
48
+ }
49
+ cellItems.push({ separator: true });
50
+ }
51
+ else if (menuColumn && !selecting) {
52
+ const unit = menuColumn.editUnit?.value(row);
53
+ const canWrite = canEdit(menuColumn);
54
+ const canClear = canWrite && !!menuColumn.clearable;
55
+ const clipboard = getGridClipboard();
56
+ const paste = canWrite && clipboard && !clipboard.matrix
57
+ ? coercePaste(menuColumn, clipboard, {
58
+ conventions,
59
+ messages,
60
+ currentUnit: unit,
61
+ holdsCurrency: rowHoldsCurrency(menuColumn, row),
62
+ values: selectValues?.[menuColumn.id],
63
+ })
64
+ : null;
65
+ cellItems.push({
66
+ label: copyLabel,
67
+ icon: _jsx(icons.copy, { className: "h-4 w-4" }),
68
+ shortcut: "⌘C",
69
+ onClick: () => void copyCell(ports.clipboard.writeText, menuColumn, editBaseline(menuColumn), unit),
70
+ });
71
+ if (editingEnabled) {
72
+ cellItems.push({
73
+ label: cutLabel,
74
+ icon: _jsx(icons.cut, { className: "h-4 w-4" }),
75
+ shortcut: "⌘X",
76
+ disabled: !canClear,
77
+ onClick: () => {
78
+ void copyCell(ports.clipboard.writeText, menuColumn, editBaseline(menuColumn), unit);
79
+ onCommitCell(row, id, menuColumn.id, cellClearPrev(menuColumn, row, pendingByCol), "");
80
+ },
81
+ }, {
82
+ label: pasteLabel,
83
+ icon: _jsx(icons.paste, { className: "h-4 w-4" }),
84
+ shortcut: "⌘V",
85
+ disabled: clipboard?.matrix ? false : !paste?.ok,
86
+ onClick: () => {
87
+ if (clipboard?.matrix) {
88
+ onPasteAtCell(rowKey, menuColumn.id);
89
+ }
90
+ else if (paste?.ok) {
91
+ onCommitCell(row, id, menuColumn.id, cellPrevPayload(menuColumn, editBaseline(menuColumn), unit), paste.next, { overlay: paste.overlay });
92
+ }
93
+ },
94
+ }, {
95
+ label: clearLabel,
96
+ icon: _jsx(icons.clear, { className: "h-4 w-4" }),
97
+ disabled: !canClear,
98
+ onClick: () => onCommitCell(row, id, menuColumn.id, cellClearPrev(menuColumn, row, pendingByCol), ""),
99
+ });
100
+ }
101
+ cellItems.push({ separator: true });
102
+ }
103
+ const selectItems = selectable
104
+ ? [
105
+ {
106
+ label: messages({ key: "views.menus.row-select", values: { selected: selected ? "true" : "false" } }),
107
+ icon: _jsx(icons.selectRow, { className: "h-4 w-4" }),
108
+ onClick: () => toggle(id),
109
+ },
110
+ { separator: true },
111
+ ]
112
+ : [];
113
+ const contextItems = [...cellItems, ...selectItems, ...(contextMenu?.(row) ?? [])];
114
+ const handleContextMenu = (event) => {
115
+ const target = event.target;
116
+ const columnId = target.closest("[data-col-id]")?.getAttribute("data-col-id");
117
+ const column = columnId ? columns.find((item) => item.id === columnId) : undefined;
118
+ setMenuColumnId(column?.id ?? null);
119
+ if (column && !selecting) {
120
+ const index = columns.findIndex((item) => item.id === column.id);
121
+ const inRange = rowRange?.some((span) => index >= span.startCol && index <= span.endCol);
122
+ if (!inRange)
123
+ onFocusCell(rowKey, column.id);
124
+ }
125
+ };
126
+ return { contextItems, handleContextMenu };
127
+ }
@@ -0,0 +1 @@
1
+ export declare function useGridScaleStyles(scale: number, grouped: boolean, isMobile: boolean, addColumn?: boolean): import("react").CSSProperties;
@@ -0,0 +1,29 @@
1
+ "use client";
2
+ import { useMemo } from "react";
3
+ export function useGridScaleStyles(scale, grouped, isMobile, addColumn = false) {
4
+ return useMemo(() => ({
5
+ "--vk-scale": String(scale),
6
+ "--vk-indent": isMobile ? "0px" : "24px",
7
+ "--vk-row-h": "calc(37px * var(--vk-scale))",
8
+ "--vk-line-h": "calc(22px * var(--vk-scale))",
9
+ "--vk-cell-py": "calc((var(--vk-row-h) - var(--vk-line-h) - 1px) / 2)",
10
+ "--vk-tail-py": "max(0px, calc((var(--vk-row-h) - 2rem - 1px) / 2))",
11
+ "--vk-head-h": "calc(32px * var(--vk-scale))",
12
+ "--vk-head-text": "calc(12px * var(--vk-scale))",
13
+ "--vk-head-glyph": "calc(12px * var(--vk-scale))",
14
+ "--vk-footer-h": "calc(36px * var(--vk-scale))",
15
+ "--vk-label-h": "calc(36px * var(--vk-scale))",
16
+ "--vk-text": "calc(14px * var(--vk-scale))",
17
+ "--vk-text-xs": "calc(12px * var(--vk-scale))",
18
+ "--vk-text-10": "calc(10px * var(--vk-scale))",
19
+ "--vk-px": "calc(12px * var(--vk-scale))",
20
+ "--vk-rail-gap": "3px",
21
+ "--vk-rail-w": "min(32px, calc(var(--vk-gutter,0px) + var(--vk-indent,0px)))",
22
+ "--vk-tail-w": addColumn ? "calc(140px + var(--vk-px))" : "calc(36px + var(--vk-px))",
23
+ "--vk-tail-pl": addColumn
24
+ ? "max(0px, calc(var(--vk-px) + var(--vk-head-glyph) / 2 - 18px))"
25
+ : "var(--vk-px)",
26
+ "--vk-glyph": "calc(14px * var(--vk-scale))",
27
+ "--vk-scroll-mt": `calc(${grouped ? "var(--vk-label-h) + 6px" : "0px"} + ${isMobile ? "0px" : "var(--vk-head-h)"} + 4px)`,
28
+ }), [addColumn, grouped, isMobile, scale]);
29
+ }
@@ -0,0 +1,38 @@
1
+ import { type RefObject, type UIEvent } from "react";
2
+ /** What a group's rows scroller spreads on itself: its registration, its scroll handler, its
3
+ * overflow classes. Named, so its readers never spell it as an indexed type. */
4
+ export type GridScrollSurface = {
5
+ /** A ref callback: what it returns is React's ref cleanup, which a wrapper must hand back. */
6
+ register: (element: HTMLElement | null) => (() => void) | undefined;
7
+ onScroll: (event: UIEvent<HTMLElement>) => void;
8
+ className: string;
9
+ };
10
+ /**
11
+ * Horizontal lock-step scrolling for per-group scrollers and sticky headers.
12
+ *
13
+ * The page-sticky headers live OUTSIDE the scrollers (so they can pin
14
+ * vertically) but are themselves `overflow-x-hidden` scroll containers, driven
15
+ * programmatically.
16
+ *
17
+ * They must NOT be slid by `transform: translate3d(-x)`. Two bugs came from
18
+ * that: a transform has no end-stop, so the header over-travelled past its own
19
+ * content at the end of a scroll; and frozen header columns had to
20
+ * counter-transform in JS, which drifted a frame behind the compositor-driven
21
+ * body. As real scrollers, `scrollLeft` clamps itself and frozen header cells
22
+ * use plain `position: sticky` — pinned by the compositor, never lagging.
23
+ *
24
+ * Idempotent writes (`!== x` guards) make echoed scroll events terminate.
25
+ */
26
+ export declare function useGridScrollSync(rootRef: RefObject<HTMLDivElement | null>): {
27
+ scrollXRef: RefObject<number>;
28
+ getScroller: () => HTMLElement | undefined;
29
+ surface: GridScrollSurface;
30
+ registerHeader: (element: HTMLElement | null) => (() => void) | undefined;
31
+ headerWheelRef: (element: HTMLElement | null) => (() => void) | undefined;
32
+ headerPanHandlers: {
33
+ onPointerDown: (event: React.PointerEvent) => void;
34
+ onPointerMove: (event: React.PointerEvent) => void;
35
+ onPointerUp: () => void;
36
+ onPointerCancel: () => void;
37
+ };
38
+ };
@@ -0,0 +1,176 @@
1
+ "use client";
2
+ import { useCallback, useEffect, useRef } from "react";
3
+ import { useHasHover } from "../../internal/viewport.js";
4
+ export function useGridScrollSync(rootRef) {
5
+ const scrollersRef = useRef(new Set());
6
+ const headersRef = useRef(new Set());
7
+ const scrollXRef = useRef(0);
8
+ const wheelDriven = useHasHover();
9
+ const parkAtRef = useRef(0);
10
+ const applyX = useCallback((x) => {
11
+ scrollXRef.current = x;
12
+ for (const scroller of scrollersRef.current) {
13
+ if (scroller.scrollLeft !== x)
14
+ scroller.scrollLeft = x;
15
+ }
16
+ for (const header of headersRef.current) {
17
+ if (header.scrollLeft !== x)
18
+ header.scrollLeft = x;
19
+ }
20
+ const root = rootRef.current;
21
+ root?.style.setProperty("--vk-scrolled", x > 0 ? "1" : "0");
22
+ root?.style.setProperty("--vk-parked", x > 0 && x >= parkAtRef.current ? "1" : "0");
23
+ }, [rootRef]);
24
+ useEffect(() => {
25
+ const root = rootRef.current;
26
+ if (!root)
27
+ return;
28
+ const probe = document.createElement("div");
29
+ probe.setAttribute("aria-hidden", "true");
30
+ probe.style.cssText =
31
+ "position:absolute;top:0;left:0;height:0;visibility:hidden;pointer-events:none;" +
32
+ "width:calc(var(--vk-gutter,0px) + var(--vk-indent,0px) - var(--vk-rail-w))";
33
+ root.appendChild(probe);
34
+ const read = () => {
35
+ parkAtRef.current = probe.offsetWidth;
36
+ };
37
+ read();
38
+ const observer = new ResizeObserver(read);
39
+ observer.observe(probe);
40
+ return () => {
41
+ observer.disconnect();
42
+ probe.remove();
43
+ };
44
+ }, [rootRef]);
45
+ const scrollByX = useCallback((delta) => {
46
+ let max = null;
47
+ for (const scroller of scrollersRef.current) {
48
+ if (scroller.clientWidth > 0) {
49
+ max = Math.max(0, scroller.scrollWidth - scroller.clientWidth);
50
+ break;
51
+ }
52
+ }
53
+ if (max === null)
54
+ return;
55
+ const next = Math.min(max, Math.max(0, scrollXRef.current + delta));
56
+ if (next !== scrollXRef.current)
57
+ applyX(next);
58
+ }, [applyX]);
59
+ const handleScroll = (event) => {
60
+ const x = event.currentTarget.scrollLeft;
61
+ if (x === scrollXRef.current)
62
+ return;
63
+ applyX(x);
64
+ };
65
+ const handleScrollerWheel = useCallback((event) => {
66
+ if (!wheelDriven || event.deltaX === 0)
67
+ return;
68
+ scrollByX(event.deltaX);
69
+ }, [wheelDriven, scrollByX]);
70
+ const handleHeaderWheel = useCallback((event) => {
71
+ if (Math.abs(event.deltaX) <= Math.abs(event.deltaY))
72
+ return;
73
+ scrollByX(event.deltaX);
74
+ }, [scrollByX]);
75
+ const registerScroller = useCallback((element) => {
76
+ if (!element)
77
+ return;
78
+ scrollersRef.current.add(element);
79
+ if (scrollXRef.current)
80
+ element.scrollLeft = scrollXRef.current;
81
+ element.addEventListener("wheel", handleScrollerWheel, { passive: true });
82
+ const set = scrollersRef.current;
83
+ return () => {
84
+ set.delete(element);
85
+ element.removeEventListener("wheel", handleScrollerWheel);
86
+ };
87
+ }, [handleScrollerWheel]);
88
+ const registerHeader = useCallback((element) => {
89
+ if (!element)
90
+ return;
91
+ headersRef.current.add(element);
92
+ if (scrollXRef.current)
93
+ element.scrollLeft = scrollXRef.current;
94
+ const putBack = () => {
95
+ if (element.scrollLeft !== scrollXRef.current)
96
+ element.scrollLeft = scrollXRef.current;
97
+ };
98
+ element.addEventListener("scroll", putBack, { passive: true });
99
+ const set = headersRef.current;
100
+ return () => {
101
+ set.delete(element);
102
+ element.removeEventListener("scroll", putBack);
103
+ };
104
+ }, []);
105
+ const registerHeaderWheel = useCallback((element) => {
106
+ if (!element)
107
+ return;
108
+ element.addEventListener("wheel", handleHeaderWheel, { passive: true });
109
+ return () => element.removeEventListener("wheel", handleHeaderWheel);
110
+ }, [handleHeaderWheel]);
111
+ const getScroller = useCallback(() => scrollersRef.current.values().next().value, []);
112
+ const surface = {
113
+ register: registerScroller,
114
+ onScroll: handleScroll,
115
+ className: wheelDriven
116
+ ? "overflow-x-hidden overflow-y-clip"
117
+ :
118
+ "overflow-x-auto overflow-y-clip overscroll-x-none",
119
+ };
120
+ const headerPanRef = useRef(null);
121
+ const handleHeaderPanDown = (event) => {
122
+ if (event.pointerType !== "touch")
123
+ return;
124
+ headerPanRef.current = {
125
+ id: event.pointerId,
126
+ x: event.clientX,
127
+ y: event.clientY,
128
+ horizontal: null,
129
+ };
130
+ };
131
+ const handleHeaderPanMove = (event) => {
132
+ const pan = headerPanRef.current;
133
+ if (!pan || pan.id !== event.pointerId)
134
+ return;
135
+ const deltaX = event.clientX - pan.x;
136
+ const deltaY = event.clientY - pan.y;
137
+ if (pan.horizontal === null) {
138
+ if (Math.abs(deltaX) < 4 && Math.abs(deltaY) < 4)
139
+ return;
140
+ pan.horizontal = Math.abs(deltaX) > Math.abs(deltaY);
141
+ }
142
+ if (!pan.horizontal)
143
+ return;
144
+ pan.x = event.clientX;
145
+ pan.y = event.clientY;
146
+ scrollByX(-deltaX);
147
+ };
148
+ const handleHeaderPanEnd = () => {
149
+ headerPanRef.current = null;
150
+ };
151
+ const headerPanHandlers = {
152
+ onPointerDown: handleHeaderPanDown,
153
+ onPointerMove: handleHeaderPanMove,
154
+ onPointerUp: handleHeaderPanEnd,
155
+ onPointerCancel: handleHeaderPanEnd,
156
+ };
157
+ useEffect(() => {
158
+ const root = rootRef.current;
159
+ if (!root)
160
+ return;
161
+ const onTouchMove = (event) => {
162
+ if (headerPanRef.current?.horizontal && event.cancelable)
163
+ event.preventDefault();
164
+ };
165
+ root.addEventListener("touchmove", onTouchMove, { passive: false });
166
+ return () => root.removeEventListener("touchmove", onTouchMove);
167
+ }, [rootRef]);
168
+ return {
169
+ scrollXRef,
170
+ getScroller,
171
+ surface,
172
+ registerHeader,
173
+ headerWheelRef: registerHeaderWheel,
174
+ headerPanHandlers,
175
+ };
176
+ }
@@ -0,0 +1,55 @@
1
+ import { type RefObject } from "react";
2
+ import { type GridEditCell } from "../core/useGridEditing.js";
3
+ import type { ListColumn } from "../../model/column-schema.js";
4
+ import type { GridTableProps } from "./grid-table-props.js";
5
+ export declare function useGridTableInteractionModel<Row>({ rootRef, props, rows, visibleRows, rowIndex, visibleColumns, selecting, }: {
6
+ rootRef: RefObject<HTMLDivElement | null>;
7
+ props: GridTableProps<Row>;
8
+ rows: Row[];
9
+ /** Row KEYS in render order — positions, not records. See `GridCellPos`. */
10
+ visibleRows: string[];
11
+ /** Row key → the rendered row and its DATA id. */
12
+ rowIndex: ReadonlyMap<string, {
13
+ key: string;
14
+ rowId: string;
15
+ row: Row;
16
+ }>;
17
+ visibleColumns: ListColumn<Row>[];
18
+ selecting: boolean;
19
+ }): {
20
+ onEditorTab: (rowId: string, columnId: string, backwards: boolean) => void;
21
+ onEditorEnter: (rowId: string, columnId: string) => void;
22
+ visibleColIds: string[];
23
+ rowSpansMap: Map<string, import("../core/range-model.js").GridRowRangeSpan[]>;
24
+ selectValuesByColumn: Record<string, string[]>;
25
+ finishFill: (targetRowId: string) => void;
26
+ onRangeCopy: () => void | undefined;
27
+ onRangeCut: () => void | undefined;
28
+ onRangeClear: () => void | undefined;
29
+ onRangePaste: () => void | undefined;
30
+ onPasteAtCell: (rowId: string, columnId: string) => void | undefined;
31
+ inActiveRange: (rowId: string, columnId: string) => boolean;
32
+ rangeCanClear: () => boolean;
33
+ rangeVerbsRef: RefObject<import("./useGridRangeActions.js").GridRangeVerbs | null>;
34
+ editingEnabled: boolean;
35
+ focusedCell: import("../core/coordinates.js").GridCellPos | null;
36
+ editingCell: import("../core/coordinates.js").GridCellPos | null;
37
+ pendingByRow: ReadonlyMap<string, Record<string, unknown>>;
38
+ settlementByRow: import("../core/editing-model.js").GridSettlementByRow;
39
+ editSeed: string | null;
40
+ focusCellSync: (rowId: string, columnId: string) => void;
41
+ startEditSync: (rowId: string, columnId: string, seed?: string) => void;
42
+ cancelEdit: (rowId?: string, columnId?: string) => void;
43
+ commitEdit: (row: Row, rowId: string, columnId: string, prev: unknown, next: unknown, opts?: {
44
+ overlay?: boolean;
45
+ }) => void;
46
+ commitBatch: (edits: (GridEditCell<Row> & {
47
+ row: Row;
48
+ })[]) => Promise<boolean>;
49
+ refuseEdit: (columnId: string) => boolean;
50
+ onExtendCell: (rowId: string, columnId: string) => void;
51
+ onAddCell: (rowId: string, columnId: string) => void;
52
+ handleRootPointerDown: (event: React.PointerEvent) => void;
53
+ handleRootPointerDownCapture: (event: React.PointerEvent) => void;
54
+ handleRootClickCapture: (event: React.MouseEvent) => void;
55
+ };
@@ -0,0 +1,197 @@
1
+ "use client";
2
+ import { useCallback, useEffect, useMemo, useRef, useState } from "react";
3
+ import { useViews } from "../../provider/context.js";
4
+ import { useGridEditing } from "../core/useGridEditing.js";
5
+ import { useGridRange } from "../core/useGridRange.js";
6
+ import { columnEffectiveWritable, gridEditRefusal, gridNormalizeWrite, } from "../../model/column-capabilities.js";
7
+ import { gridRowIdFromKey } from "../core/coordinates.js";
8
+ import { useGridKeyboard } from "./useGridKeyboard.js";
9
+ import { useGridPendingReconciliation } from "./useGridPendingReconciliation.js";
10
+ import { useGridRangeActions } from "./useGridRangeActions.js";
11
+ import { useGridRangeGestures } from "./useGridRangeGestures.js";
12
+ const REFUSAL_REPEAT_MS = 600;
13
+ export function useGridTableInteractionModel({ rootRef, props, rows, visibleRows, rowIndex, visibleColumns, selecting, }) {
14
+ const { columns, getRowId, listConfig } = props;
15
+ const { conventions, ports, messages } = useViews();
16
+ const editingEnabled = !!props.onCellCommit;
17
+ const { focused: focusedCell, editing: editingCell, pendingByRow, settlementByRow, focusCell, clearFocus, startEdit, cancelEdit, commitEdit: commitEditRaw, commitBatch: commitBatchRaw, undo, redo, reconcile, hasInflight, pendingBaseline, } = useGridEditing(props.onCellCommit, props.onCellsCommit);
18
+ const commitEdit = useCallback((row, rowId, columnId, prev, next, opts) => {
19
+ const col = visibleColumns.find((c) => c.id === columnId);
20
+ if (col) {
21
+ const res = gridNormalizeWrite(col, next, conventions, { messages, stored: prev });
22
+ if (!res.ok) {
23
+ ports.toast.error(res.reason);
24
+ return;
25
+ }
26
+ next = res.value;
27
+ }
28
+ commitEditRaw(row, rowId, columnId, prev, next, opts);
29
+ }, [visibleColumns, commitEditRaw, conventions, messages, ports]);
30
+ const commitBatch = useCallback((edits) => {
31
+ const colById = new Map(visibleColumns.map((c) => [c.id, c]));
32
+ const kept = [];
33
+ let firstRefusal;
34
+ for (const edit of edits) {
35
+ const col = colById.get(edit.columnId);
36
+ if (!col) {
37
+ kept.push(edit);
38
+ continue;
39
+ }
40
+ const res = gridNormalizeWrite(col, edit.next, conventions, { messages, stored: edit.prev });
41
+ if (!res.ok) {
42
+ firstRefusal ??= res.reason;
43
+ continue;
44
+ }
45
+ kept.push(res.value === edit.next ? edit : { ...edit, next: res.value });
46
+ }
47
+ if (kept.length === 0) {
48
+ if (firstRefusal)
49
+ ports.toast.error(firstRefusal);
50
+ return Promise.resolve(true);
51
+ }
52
+ return commitBatchRaw(kept);
53
+ }, [visibleColumns, commitBatchRaw, conventions, messages, ports]);
54
+ const lastRefusalRef = useRef(null);
55
+ const refuseEdit = useCallback((columnId) => {
56
+ if (!editingEnabled)
57
+ return false;
58
+ const col = visibleColumns.find((c) => c.id === columnId);
59
+ if (!col || columnEffectiveWritable(col, listConfig))
60
+ return false;
61
+ const reason = gridEditRefusal(col, listConfig, conventions, messages);
62
+ if (!reason)
63
+ return false;
64
+ const now = Date.now();
65
+ const last = lastRefusalRef.current;
66
+ lastRefusalRef.current = { columnId, at: now };
67
+ if (last?.columnId === columnId && now - last.at < REFUSAL_REPEAT_MS)
68
+ return true;
69
+ ports.toast.error(reason);
70
+ return true;
71
+ }, [editingEnabled, visibleColumns, listConfig, conventions, messages, ports]);
72
+ const { ranges, setSingle: rangeSetSingle, setRect: rangeSetRect, beginDrag: rangeBeginDrag, extendTo: rangeExtendTo, addCell: rangeAddCell, clear: rangeClear, } = useGridRange();
73
+ const [editSeed, setEditSeed] = useState(null);
74
+ const focusCellSync = useCallback((rowId, columnId) => {
75
+ focusCell(rowId, columnId);
76
+ rangeSetSingle({ rowId, columnId });
77
+ }, [focusCell, rangeSetSingle]);
78
+ const startEditSync = useCallback((rowId, columnId, seed) => {
79
+ setEditSeed(seed ?? null);
80
+ startEdit(rowId, columnId);
81
+ rangeSetSingle({ rowId, columnId });
82
+ }, [startEdit, rangeSetSingle]);
83
+ const clearFocusSync = useCallback(() => {
84
+ clearFocus();
85
+ rangeClear();
86
+ }, [clearFocus, rangeClear]);
87
+ useEffect(() => {
88
+ if (!focusedCell && !editingCell)
89
+ return;
90
+ const visible = new Set(visibleRows);
91
+ const staleEdit = editingCell != null && !visible.has(editingCell.rowId);
92
+ const staleFocus = focusedCell != null && !visible.has(focusedCell.rowId);
93
+ if (!staleEdit && !staleFocus)
94
+ return;
95
+ const editedRowId = editingCell != null
96
+ ? (rowIndex.get(editingCell.rowId)?.rowId ?? gridRowIdFromKey(editingCell.rowId))
97
+ : undefined;
98
+ const editedRowGone = editingCell != null && !rows.some((row) => getRowId(row) === editedRowId);
99
+ if (staleEdit)
100
+ cancelEdit();
101
+ if (staleFocus)
102
+ clearFocusSync();
103
+ if (staleEdit && editedRowGone) {
104
+ ports.toast.error(messages({ key: "views.grid.row-left" }));
105
+ }
106
+ }, [cancelEdit, clearFocusSync, editingCell, focusedCell, getRowId, messages, ports, rowIndex, rows, visibleRows]);
107
+ const visibleColumnIds = useMemo(() => visibleColumns.map((column) => column.id), [visibleColumns]);
108
+ const spreadsheetModel = useMemo(() => ({ rows, rowByKey: rowIndex, visibleRowIds: visibleRows, visibleColumns, pendingByRow, conventions, messages }), [rows, rowIndex, visibleRows, visibleColumns, pendingByRow, conventions, messages]);
109
+ const finishFillRef = useRef(() => { });
110
+ const { fillTargetRow, onExtendCell, onAddCell, handleRootPointerDown, handleRootPointerDownCapture, handleRootClickCapture, } = useGridRangeGestures({
111
+ rootRef,
112
+ focusedCell,
113
+ editingCell,
114
+ editingEnabled,
115
+ selecting,
116
+ focusCell,
117
+ clearFocus: clearFocusSync,
118
+ rangeBeginDrag,
119
+ rangeExtendTo,
120
+ rangeAddCell,
121
+ finishFillRef,
122
+ });
123
+ const rangeActions = useGridRangeActions({
124
+ ranges,
125
+ focusedCell,
126
+ editingCell,
127
+ editingEnabled,
128
+ fillTargetRow,
129
+ visibleRowIds: visibleRows,
130
+ visibleColumns,
131
+ spreadsheetModel,
132
+ commitBatch,
133
+ focusCell,
134
+ rangeSetRect,
135
+ rangeExtendTo,
136
+ });
137
+ useEffect(() => {
138
+ finishFillRef.current = rangeActions.finishFill;
139
+ }, [rangeActions.finishFill]);
140
+ const keyboard = useGridKeyboard({
141
+ rootRef,
142
+ focusedCell,
143
+ editingCell,
144
+ editingEnabled,
145
+ listConfig,
146
+ visibleRowIds: visibleRows,
147
+ visibleColIds: visibleColumnIds,
148
+ visibleColumns,
149
+ rows,
150
+ getRowId,
151
+ rowByKey: rowIndex,
152
+ pendingByRow,
153
+ rangeVerbsRef: rangeActions.rangeVerbsRef,
154
+ focusCell: focusCellSync,
155
+ clearFocus: clearFocusSync,
156
+ startEdit: startEditSync,
157
+ cancelEdit,
158
+ commitEdit,
159
+ refuseEdit,
160
+ undo,
161
+ redo,
162
+ rangeSetSingle,
163
+ rangeSetRect,
164
+ rangeExtendTo,
165
+ ranges,
166
+ });
167
+ useGridPendingReconciliation({
168
+ rows,
169
+ columns,
170
+ getRowId,
171
+ pendingByRow,
172
+ reconcile,
173
+ hasInflight,
174
+ pendingBaseline,
175
+ });
176
+ return {
177
+ editingEnabled,
178
+ focusedCell,
179
+ editingCell,
180
+ pendingByRow,
181
+ settlementByRow,
182
+ editSeed,
183
+ focusCellSync,
184
+ startEditSync,
185
+ cancelEdit,
186
+ commitEdit,
187
+ commitBatch,
188
+ refuseEdit,
189
+ onExtendCell,
190
+ onAddCell,
191
+ handleRootPointerDown,
192
+ handleRootPointerDownCapture,
193
+ handleRootClickCapture,
194
+ ...rangeActions,
195
+ ...keyboard,
196
+ };
197
+ }
@@ -0,0 +1,29 @@
1
+ import { type RefObject } from "react";
2
+ import type { GridTableProps } from "./grid-table-props.js";
3
+ export declare function getVisibleGridRowIds<Row>({ groups, grouped, isCollapsed, getRowId, }: Pick<GridTableProps<Row>, "groups" | "grouped" | "isCollapsed" | "getRowId">): string[];
4
+ /**
5
+ * The Grid renderer's list-selection binding.
6
+ *
7
+ * Selection order includes every rendered row, while checkbox-lane drag order
8
+ * deliberately excludes rows hidden inside collapsed groups. Keeping both
9
+ * orders here prevents the renderer from accidentally feeding one contract to
10
+ * the other when its group chrome changes.
11
+ */
12
+ export declare function useGridTableSelection<Row>({ rootRef, groups, grouped, isCollapsed, getRowId, selection, }: Pick<GridTableProps<Row>, "groups" | "grouped" | "isCollapsed" | "getRowId" | "selection"> & {
13
+ rootRef: RefObject<HTMLDivElement | null>;
14
+ }): {
15
+ selectable: boolean;
16
+ selecting: boolean;
17
+ selectionState: import("../../selection/useListSelection.js").UseListSelectionResult;
18
+ derivedOrderedIds: string[];
19
+ visibleRowIds: string[];
20
+ checkDrag: {
21
+ tryArm: (e: import("react").PointerEvent) => boolean;
22
+ consumeDrag: () => boolean;
23
+ };
24
+ groupSelection: (items: Row[]) => {
25
+ allSelected: boolean;
26
+ someSelected: boolean;
27
+ onToggle: () => void;
28
+ };
29
+ };