@svgrid/grid 2.6.23 → 3.0.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 (263) hide show
  1. package/CHANGELOG.md +88 -88
  2. package/README.md +199 -199
  3. package/dist/FlexRender.svelte +96 -96
  4. package/dist/GridFooter.svelte +181 -181
  5. package/dist/SvAutoComplete.svelte +169 -169
  6. package/dist/SvAvatar.svelte +75 -75
  7. package/dist/SvCalendar.svelte +503 -503
  8. package/dist/SvCarousel.svelte +141 -141
  9. package/dist/SvCheckBox.svelte +102 -102
  10. package/dist/SvCircularProgress.svelte +109 -109
  11. package/dist/SvColorInput.svelte +181 -181
  12. package/dist/SvComboBox.svelte +279 -279
  13. package/dist/SvContextMenu.svelte +116 -116
  14. package/dist/SvCountryInput.svelte +163 -163
  15. package/dist/SvDrawer.svelte +254 -254
  16. package/dist/SvDropDownList.svelte +378 -378
  17. package/dist/SvDurationInput.svelte +126 -126
  18. package/dist/SvField.svelte +293 -293
  19. package/dist/SvForm.svelte +437 -437
  20. package/dist/SvGridCellEditor.svelte +744 -744
  21. package/dist/SvGridChart.svelte +1716 -1716
  22. package/dist/SvGridChartPanel.svelte +485 -485
  23. package/dist/SvGridChartView.svelte +70 -70
  24. package/dist/SvGridDropdown.svelte +728 -728
  25. package/dist/SvGridSelect.svelte +270 -270
  26. package/dist/SvGroupCell.svelte +116 -116
  27. package/dist/SvListBox.svelte +334 -334
  28. package/dist/SvMaskedInput.svelte +122 -122
  29. package/dist/SvMenu.svelte +124 -124
  30. package/dist/SvMenuList.svelte +146 -146
  31. package/dist/SvMultiSelect.svelte +293 -293
  32. package/dist/SvNumberInput.svelte +172 -172
  33. package/dist/SvOtpInput.svelte +158 -158
  34. package/dist/SvPasswordInput.svelte +151 -151
  35. package/dist/SvPhoneInput.svelte +133 -133
  36. package/dist/SvPopover.svelte +197 -197
  37. package/dist/SvProgress.svelte +116 -116
  38. package/dist/SvRadioGroup.svelte +107 -107
  39. package/dist/SvRating.svelte +112 -112
  40. package/dist/SvResult.svelte +73 -73
  41. package/dist/SvRichText.svelte +211 -211
  42. package/dist/SvRowGroupPanel.svelte +170 -170
  43. package/dist/SvScrollArea.svelte +61 -61
  44. package/dist/SvSlider.svelte +203 -203
  45. package/dist/SvSwitchButton.svelte +108 -108
  46. package/dist/SvTagsInput.svelte +115 -115
  47. package/dist/SvTextInput.svelte +147 -147
  48. package/dist/SvTimePicker.svelte +245 -245
  49. package/dist/SvToaster.svelte +159 -159
  50. package/dist/SvToggleButton.svelte +85 -85
  51. package/dist/SvTooltip.svelte +161 -161
  52. package/dist/SvTour.svelte +208 -208
  53. package/dist/SvTree.svelte +444 -444
  54. package/dist/SvTreeSelect.svelte +239 -239
  55. package/dist/cdn/{GridMenus-BzWXQjv3.js → GridMenus-DMihUtma.js} +3 -3
  56. package/dist/cdn/{GridMenus-xr_rHx8F.js → GridMenus-nmNDj1a3.js} +3 -3
  57. package/dist/cdn/{SvDateRangeInput-DMLKmGEc.js → SvDateRangeInput-Bh0A0JkF.js} +1 -1
  58. package/dist/cdn/{SvDateRangeInput-CaOuMs8O.js → SvDateRangeInput-DflbiP7N.js} +1 -1
  59. package/dist/cdn/{SvDateTimePicker-sonaH0oh.js → SvDateTimePicker-BWwpfB_o.js} +1 -1
  60. package/dist/cdn/{SvDateTimePicker-CCbDZNZB.js → SvDateTimePicker-Bivn8dAP.js} +1 -1
  61. package/dist/cdn/{SvGridCellEditor-BAPSC7EL.js → SvGridCellEditor-AXL8cHGO.js} +1 -1
  62. package/dist/cdn/{SvGridCellEditor-BwzmUWtL.js → SvGridCellEditor-Ba7rY3eu.js} +1 -1
  63. package/dist/cdn/{SvGridChart-BwVos976.js → SvGridChart-Bs2GIR2Q.js} +1 -1
  64. package/dist/cdn/{SvGridChart-BEJmNNx9.js → SvGridChart-CwhFz7GV.js} +1 -1
  65. package/dist/cdn/{SvGridChartPanel-BOknOkrP.js → SvGridChartPanel-1WXuStzM.js} +1 -1
  66. package/dist/cdn/{SvGridChartPanel-D2PjII4O.js → SvGridChartPanel-e5_nqNP9.js} +1 -1
  67. package/dist/cdn/{SvGridChartView-00LPUHL1.js → SvGridChartView-SmPW10dI.js} +1 -1
  68. package/dist/cdn/{SvGridChartView-BhUEJ5ki.js → SvGridChartView-eSPuJE6g.js} +1 -1
  69. package/dist/cdn/{SvGridDropdown-D0VdjeR8.js → SvGridDropdown-B1ZcLpgs.js} +1 -1
  70. package/dist/cdn/{SvGridDropdown-D13MtJ2j.js → SvGridDropdown-CtdbHcIS.js} +1 -1
  71. package/dist/cdn/{date-format-BnnHlqGw.js → date-format-CcP1tafP.js} +2 -2
  72. package/dist/cdn/{date-format-BNii4zeD.js → date-format-DZT7T1wf.js} +2 -2
  73. package/dist/cdn/{row-drag-touch-Ddaa-QeB.js → row-drag-touch-CycRR65n.js} +12 -10
  74. package/dist/cdn/{src-skQN5eqh.js → src-B_YS5AOc.js} +45 -45
  75. package/dist/cdn/{src-DGo7IHug.js → src-DYXXpuSk.js} +44 -44
  76. package/dist/cdn/svgrid.js +7 -7
  77. package/dist/cdn/svgrid.svelte-external.js +7 -7
  78. package/dist/chart-export.js +8 -8
  79. package/dist/row-drag-touch.d.ts +5 -1
  80. package/dist/row-drag-touch.js +15 -4
  81. package/dist/row-drag.js +7 -3
  82. package/package.json +11 -11
  83. package/src/FlexRender.svelte +96 -96
  84. package/src/GridFooter.svelte +181 -181
  85. package/src/SvAutoComplete.svelte +169 -169
  86. package/src/SvAvatar.svelte +75 -75
  87. package/src/SvCalendar.svelte +503 -503
  88. package/src/SvCalendar.test.ts +226 -226
  89. package/src/SvCarousel.svelte +141 -141
  90. package/src/SvCheckBox.svelte +102 -102
  91. package/src/SvCircularProgress.svelte +109 -109
  92. package/src/SvColorInput.svelte +181 -181
  93. package/src/SvComboBox.svelte +279 -279
  94. package/src/SvContextMenu.svelte +116 -116
  95. package/src/SvCountryInput.svelte +163 -163
  96. package/src/SvDrawer.svelte +254 -254
  97. package/src/SvDropDownList.svelte +378 -378
  98. package/src/SvDurationInput.svelte +126 -126
  99. package/src/SvField.svelte +293 -293
  100. package/src/SvForm.svelte +437 -437
  101. package/src/SvForm.test.ts +411 -411
  102. package/src/SvGrid.types.ts +2092 -2092
  103. package/src/SvGridCellEditor.svelte +744 -744
  104. package/src/SvGridChart.svelte +1716 -1716
  105. package/src/SvGridChartPanel.svelte +485 -485
  106. package/src/SvGridChartView.svelte +70 -70
  107. package/src/SvGridDropdown.svelte +728 -728
  108. package/src/SvGridSelect.svelte +270 -270
  109. package/src/SvGroupCell.svelte +116 -116
  110. package/src/SvListBox.svelte +334 -334
  111. package/src/SvMaskedInput.svelte +122 -122
  112. package/src/SvMenu.svelte +124 -124
  113. package/src/SvMenu.test.ts +97 -97
  114. package/src/SvMenuList.svelte +146 -146
  115. package/src/SvMultiSelect.svelte +293 -293
  116. package/src/SvNumberInput.svelte +172 -172
  117. package/src/SvOtpInput.svelte +158 -158
  118. package/src/SvPasswordInput.svelte +151 -151
  119. package/src/SvPhoneInput.svelte +133 -133
  120. package/src/SvPopover.svelte +197 -197
  121. package/src/SvProgress.svelte +116 -116
  122. package/src/SvRadioGroup.svelte +107 -107
  123. package/src/SvRating.svelte +112 -112
  124. package/src/SvResult.svelte +73 -73
  125. package/src/SvRichText.svelte +211 -211
  126. package/src/SvRowGroupPanel.svelte +170 -170
  127. package/src/SvScrollArea.svelte +61 -61
  128. package/src/SvSlider.svelte +203 -203
  129. package/src/SvSwitchButton.svelte +108 -108
  130. package/src/SvTagsInput.svelte +115 -115
  131. package/src/SvTextInput.svelte +147 -147
  132. package/src/SvTimePicker.svelte +245 -245
  133. package/src/SvToaster.svelte +159 -159
  134. package/src/SvToaster.test.ts +95 -95
  135. package/src/SvToggleButton.svelte +85 -85
  136. package/src/SvTooltip.svelte +161 -161
  137. package/src/SvTour.svelte +208 -208
  138. package/src/SvTree.svelte +444 -444
  139. package/src/SvTreeSelect.svelte +239 -239
  140. package/src/a11y/dismissable.test.ts +119 -119
  141. package/src/a11y/dismissable.ts +114 -114
  142. package/src/a11y.contract.test.ts +49 -49
  143. package/src/a11y.test.ts +59 -59
  144. package/src/a11y.ts +61 -61
  145. package/src/ai.test.ts +502 -502
  146. package/src/ai.ts +1419 -1419
  147. package/src/build-api.coverage.test.ts +633 -633
  148. package/src/build-api.ts +846 -846
  149. package/src/builtin-editors.grid.test.ts +83 -83
  150. package/src/cell-formatting.ts +171 -171
  151. package/src/cell-render.test.ts +513 -513
  152. package/src/cell-render.ts +496 -496
  153. package/src/cell-values.ts +148 -148
  154. package/src/chart-export.ts +202 -202
  155. package/src/chart-view.svelte.ts +36 -36
  156. package/src/chart.ts +2321 -2321
  157. package/src/collaboration.test.ts +104 -104
  158. package/src/collaboration.ts +167 -167
  159. package/src/column-groups.ts +78 -78
  160. package/src/core.performance.test.ts +30 -30
  161. package/src/core.ts +1865 -1865
  162. package/src/createAutocomplete.svelte.ts +132 -132
  163. package/src/createCombobox.svelte.ts +191 -191
  164. package/src/createCountryInput.svelte.ts +157 -157
  165. package/src/createDropdownList.svelte.ts +168 -168
  166. package/src/createForm.svelte.ts +386 -386
  167. package/src/createGrid.svelte.ts +42 -42
  168. package/src/createGrid.test.ts +10 -10
  169. package/src/createGridState.svelte.ts +17 -17
  170. package/src/createListbox.svelte.ts +250 -250
  171. package/src/createMenu.svelte.ts +224 -224
  172. package/src/createPopoverSelect.svelte.ts +213 -213
  173. package/src/createSlider.svelte.ts +191 -191
  174. package/src/createTooltip.svelte.ts +144 -144
  175. package/src/createTree.svelte.ts +322 -322
  176. package/src/datetime/date-core.ts +206 -206
  177. package/src/datetime/date-restrict.ts +61 -61
  178. package/src/datetime/timezone.ts +135 -135
  179. package/src/dock-manager-model.ts +596 -596
  180. package/src/dock-model.ts +374 -374
  181. package/src/editing.test.ts +974 -974
  182. package/src/editing.ts +609 -609
  183. package/src/editor-contract.ts +171 -171
  184. package/src/editor-registry.grid.test.ts +144 -144
  185. package/src/editor-registry.ts +122 -122
  186. package/src/export-data-api.test.ts +126 -126
  187. package/src/export-format.test.ts +107 -107
  188. package/src/export-format.ts +601 -601
  189. package/src/filter-operators.ts +160 -160
  190. package/src/filtering/excel-filters.ts +325 -325
  191. package/src/flex-render.ts +3 -3
  192. package/src/form-field.ts +127 -127
  193. package/src/group-display.test.ts +167 -167
  194. package/src/group-display.ts +200 -200
  195. package/src/headless.ts +87 -87
  196. package/src/js-scroller.svelte.ts +173 -173
  197. package/src/keyboard-handlers.ts +270 -270
  198. package/src/keyboard.test.ts +59 -59
  199. package/src/keyboard.ts +97 -97
  200. package/src/list-nav.test.ts +49 -49
  201. package/src/list-nav.ts +29 -29
  202. package/src/list-option.test.ts +56 -56
  203. package/src/list-option.ts +179 -179
  204. package/src/menus.ts +597 -597
  205. package/src/merge-objects.ts +48 -48
  206. package/src/overlays.test.ts +90 -90
  207. package/src/positioning.ts +268 -268
  208. package/src/render-component.ts +28 -28
  209. package/src/row-drag-touch.ts +20 -5
  210. package/src/row-drag.test.ts +401 -353
  211. package/src/row-drag.ts +419 -415
  212. package/src/row-resize.test.ts +524 -524
  213. package/src/row-resize.ts +228 -228
  214. package/src/scheduler-ical.ts +181 -181
  215. package/src/scheduler-model.test.ts +562 -562
  216. package/src/scheduler-model.ts +873 -873
  217. package/src/selection.test.ts +885 -885
  218. package/src/server-data-source.test.ts +383 -383
  219. package/src/server-data-source.ts +469 -469
  220. package/src/sparkline.test.ts +68 -68
  221. package/src/sparkline.ts +169 -169
  222. package/src/spreadsheet.test.ts +488 -488
  223. package/src/spreadsheet.ts +312 -312
  224. package/src/static-functions.ts +11 -11
  225. package/src/subscribe.ts +38 -38
  226. package/src/summaries.ts +113 -113
  227. package/src/svgrid-wrapper.types.ts +563 -563
  228. package/src/svgrid.async-editor-options.test.ts +273 -273
  229. package/src/svgrid.auto-row-height.test.ts +204 -204
  230. package/src/svgrid.behavior.test.ts +910 -910
  231. package/src/svgrid.charting.test.ts +534 -534
  232. package/src/svgrid.comments-autocomplete.test.ts +127 -127
  233. package/src/svgrid.context-menu.test.ts +147 -147
  234. package/src/svgrid.features.test.ts +157 -157
  235. package/src/svgrid.filter-depth.test.ts +163 -163
  236. package/src/svgrid.filter-menu-listbox.svelte.test.ts +377 -377
  237. package/src/svgrid.filter-menu-scroll.test.ts +112 -112
  238. package/src/svgrid.grand-total.test.ts +188 -188
  239. package/src/svgrid.group-display-mode.test.ts +171 -171
  240. package/src/svgrid.group-footers.test.ts +121 -121
  241. package/src/svgrid.group-pagination.test.ts +153 -153
  242. package/src/svgrid.new-features.wrapper.test.ts +251 -251
  243. package/src/svgrid.tree-data.test.ts +186 -186
  244. package/src/svgrid.wrapper.test.ts +63 -63
  245. package/src/svgriddropdown.async-panel.svelte.test.ts +195 -195
  246. package/src/test-setup.ts +62 -62
  247. package/src/themes/index.ts +288 -288
  248. package/src/toast-store.svelte.ts +250 -250
  249. package/src/toast-store.test.ts +147 -147
  250. package/src/tree-row-model.test.ts +168 -168
  251. package/src/ui-buttons.test.ts +144 -144
  252. package/src/ui-inputs.test.ts +118 -118
  253. package/src/ui-localization.test.ts +113 -113
  254. package/src/ui-range.test.ts +70 -70
  255. package/src/ui-selection.test.ts +155 -155
  256. package/src/ui-tier1.test.ts +142 -142
  257. package/src/virtual.test.ts +88 -88
  258. package/src/virtualization/column-virtualizer.test.ts +27 -27
  259. package/src/virtualization/column-virtualizer.ts +30 -30
  260. package/src/virtualization/svelte-virtualizer.svelte.ts +26 -26
  261. package/src/virtualization/types.ts +30 -30
  262. package/src/virtualization/virtualizer.test.ts +47 -47
  263. package/src/virtualization/virtualizer.ts +322 -322
package/src/editing.ts CHANGED
@@ -1,609 +1,609 @@
1
- // editing handlers extracted from the controller. Imperative event handlers
2
- // reading/writing controller state via the `ctx` handle; the reactive core
3
- // ($state/$derived/$effect) stays in the controller.
4
- import {
5
- parseEditorValue,
6
- type CellContext,
7
- type CellEditorType,
8
- type Column,
9
- type Row,
10
- type RowData,
11
- type TableFeatures,
12
- } from "./index";
13
- import "./sv-grid-scrollbar";
14
- import { getNextActiveCell } from "./keyboard";
15
- import {
16
- getCellKey,
17
- toValueArray,
18
- } from "./SvGrid.helpers";
19
- import {
20
- createDataIndexLookup,
21
- getColumnBaseValue,
22
- isGroupRow,
23
- } from "./cell-values";
24
-
25
- type HistoryStep = {
26
- rowId: string;
27
- columnId: string;
28
- field: string;
29
- before: unknown;
30
- after: unknown;
31
- };
32
-
33
- export function createEditing<
34
- TFeatures extends TableFeatures = TableFeatures,
35
- TData extends RowData = RowData,
36
- >(ctx: any) {
37
- /**
38
- * Resolve `columnDef.editable` for one row × column pair.
39
- *
40
- * - `undefined` / `true` → editable
41
- * - `false` → not editable (column-level lockdown, fastest path)
42
- * - function → call it with the cell's context and honour the
43
- * boolean it returns (cell-level lockdown - used for things like
44
- * "this field is owned by the server, this one isn't, by row")
45
- *
46
- * Called from every editing entry point: double-click, type-to-edit,
47
- * fill-handle drag, Delete-clear, clipboard paste. A central helper
48
- * keeps the cell-level callback signature consistent and saves a
49
- * lookup of CellContext at each site.
50
- */
51
- function isCellEditable(column: Column<TData>, row?: Row<TData>): boolean {
52
- const editable = column.columnDef.editable;
53
- if (editable === false) return false;
54
- if (typeof editable !== "function") return true;
55
- if (!row) return true;
56
- const cellCtx: CellContext<TData> = {
57
- cell: {
58
- id: `${row.id}_${column.id}`,
59
- row,
60
- column,
61
- getValue: () => getColumnBaseValue(row, column),
62
- getContext: () => cellCtx,
63
- },
64
- row,
65
- column,
66
- table: ctx.grid,
67
- getValue: () => getColumnBaseValue(row, column),
68
- };
69
- try {
70
- return editable(cellCtx) !== false;
71
- } catch {
72
- // A throwing predicate shouldn't crash the grid - log and treat
73
- // as not-editable so any error biases toward safety.
74
- return false;
75
- }
76
- }
77
-
78
- /** Variant that takes raw row + column indices for the rare callers
79
- * (fill-handle, paste, Delete) that already work in index-space. */
80
- function isCellEditableAt(rowIndex: number, colIndex: number): boolean {
81
- const row = ctx.allRows[rowIndex];
82
- const column = ctx.allColumns[colIndex];
83
- if (!column) return false;
84
- return isCellEditable(column, row);
85
- }
86
-
87
- function getRowColumnValue(row: Row<TData>, columnId: string) {
88
- const column = ctx.allColumns.find((entry: any) => entry.id === columnId);
89
- return column
90
- ? getColumnBaseValue(row, column)
91
- : row.getCellValueByColumnId(columnId);
92
- }
93
-
94
- function getCellDisplayValue(
95
- rowId: string,
96
- columnId: string,
97
- baseValue: unknown,
98
- ) {
99
- const key = getCellKey(rowId, columnId);
100
- return key in ctx.editedCellValues ? ctx.editedCellValues[key] : baseValue;
101
- }
102
-
103
- /** Start editing seeded with a typed character (Excel-style type-to-edit). */
104
- function startEditingWithChar(
105
- rowIndex: number,
106
- colIndex: number,
107
- char: string,
108
- ): boolean {
109
- if (!ctx.editingEnabled) return false;
110
- const row = ctx.allRows[rowIndex];
111
- const column = ctx.allColumns[colIndex];
112
- if (!row || !column || isGroupRow(row)) return false;
113
- if (!isCellEditable(column, row)) return false;
114
- const editorType = (column.columnDef.editorType ??
115
- "text") as CellEditorType;
116
- if (
117
- editorType === "checkbox" ||
118
- editorType === "date" ||
119
- editorType === "datetime" ||
120
- editorType === "list" ||
121
- editorType === "chips"
122
- ) {
123
- return false;
124
- }
125
- if (editorType === "number" && !/[0-9.+-]/.test(char)) return false;
126
- ctx.editorSelectAll = false;
127
- ctx.editingCell = {
128
- rowId: row.id,
129
- columnId: column.id,
130
- editorType,
131
- value: char,
132
- rowRef: row.original,
133
- };
134
- ctx.setActiveCell(rowIndex, colIndex);
135
- ctx.setSelection(rowIndex, colIndex);
136
- return true;
137
- }
138
-
139
- function saveEditingCell() {
140
- if (!ctx.editingCell) return;
141
- const editing = ctx.editingCell;
142
- // Resolve the row this edit belongs to. `allRows` is only the current page,
143
- // so fall back to the full filtered model, then to the data object captured
144
- // when the edit started. Without that last hop an edit is silently dropped
145
- // when a filter typed mid-edit hides the row from both models (#49).
146
- const row =
147
- ctx.allRows.find((entry: any) => entry.id === editing.rowId) ??
148
- ctx.allRowsBeforePagination.find((entry: any) => entry.id === editing.rowId);
149
- const rowData = (row?.original ?? editing.rowRef) as
150
- | Record<string, unknown>
151
- | undefined;
152
- const column = ctx.allColumns.find(
153
- (entry: any) => entry.id === ctx.editingCell?.columnId,
154
- );
155
- const parsedValue = parseEditorValue(
156
- ctx.editingCell.editorType,
157
- ctx.editingCell.value,
158
- {
159
- multiple: column?.columnDef.editorMultiple === true,
160
- // A dateString column holds 'YYYY-MM-DD', not a timestamp.
161
- dateOnly: column?.columnDef.cellDataType === "dateString",
162
- },
163
- );
164
- let oldValue: unknown = undefined;
165
- let finalValue: unknown = parsedValue;
166
- if (rowData && column?.columnDef.field) {
167
- oldValue = rowData[column.columnDef.field];
168
- // Per-column valueParser refines the type-coerced value before storing.
169
- const parser = (
170
- column.columnDef as { valueParser?: (p: unknown) => unknown }
171
- ).valueParser;
172
- if (parser) {
173
- finalValue = parser({
174
- newValue: parsedValue,
175
- oldValue,
176
- rawInput: ctx.editingCell.value,
177
- data: rowData,
178
- columnId: ctx.editingCell.columnId,
179
- });
180
- }
181
- rowData[column.columnDef.field] = finalValue;
182
- }
183
- const key = getCellKey(ctx.editingCell.rowId, ctx.editingCell.columnId);
184
- ctx.editedCellValues = {
185
- ...ctx.editedCellValues,
186
- [key]: finalValue,
187
- };
188
- ctx.grid.store.setState((prev: any) => ({ ...prev }));
189
- // Record into the history at the current pointer. Any forward
190
- // history (steps the user could have redone) is truncated - this
191
- // is the standard "edit invalidates redo" rule.
192
- if (oldValue !== finalValue && rowData && column?.columnDef.field) {
193
- const step: HistoryStep = {
194
- rowId: ctx.editingCell.rowId,
195
- columnId: ctx.editingCell.columnId,
196
- field: column.columnDef.field as string,
197
- before: oldValue,
198
- after: finalValue,
199
- }
200
- const truncated = ctx.history.slice(0, ctx.historyPtr + 1)
201
- truncated.push(step)
202
- // Cap the buffer at UNDO_LIMIT; drop the OLDEST entries so the
203
- // pointer stays valid relative to the newest steps.
204
- if (truncated.length > ctx.UNDO_LIMIT) {
205
- const drop = truncated.length - ctx.UNDO_LIMIT
206
- ctx.history = truncated.slice(drop)
207
- ctx.historyPtr = ctx.history.length - 1
208
- } else {
209
- ctx.history = truncated
210
- ctx.historyPtr = ctx.history.length - 1
211
- }
212
- ctx.historyVersion += 1
213
- }
214
- // Notify the consumer AFTER the row has been updated so any callback-
215
- // driven recompute (cascade totals, server save, undo stack) sees the
216
- // post-write state. `rowIndex` matches the position in `props.data`.
217
- if (ctx.props.onCellValueChange && rowData && column) {
218
- const rowIndex = ctx.internalData.indexOf(rowData as TData);
219
- ctx.props.onCellValueChange({
220
- rowIndex,
221
- columnId: column.id,
222
- oldValue,
223
- newValue: finalValue,
224
- row: rowData as TData,
225
- });
226
- }
227
- ctx.editingCell = null;
228
- }
229
-
230
- /** Apply an undo / redo step directly to the underlying row, bypassing
231
- * the editor pipeline so we don't accidentally re-push to the stack. */
232
- function applyHistoryStep(step: HistoryStep, direction: 'undo' | 'redo') {
233
- const row = ctx.allRows.find((r: any) => r.id === step.rowId)
234
- const col = ctx.allColumns.find((c: any) => c.id === step.columnId)
235
- if (!row?.original || !col) return
236
- const value = direction === 'undo' ? step.before : step.after
237
- ;(row.original as Record<string, unknown>)[step.field] = value
238
- const key = getCellKey(step.rowId, step.columnId)
239
- ctx.editedCellValues = { ...ctx.editedCellValues, [key]: value }
240
- ctx.grid.store.setState((prev: any) => ({ ...prev }))
241
- if (ctx.props.onCellValueChange) {
242
- const rowIndex = ctx.internalData.indexOf(row.original as TData)
243
- ctx.props.onCellValueChange({
244
- rowIndex,
245
- columnId: step.columnId,
246
- oldValue: direction === 'undo' ? step.after : step.before,
247
- newValue: value,
248
- row: row.original as TData,
249
- })
250
- }
251
- }
252
-
253
- function updateEditingCellValue(value: unknown) {
254
- ctx.editingCell = ctx.editingCell ? { ...ctx.editingCell, value } : ctx.editingCell;
255
- }
256
-
257
- /**
258
- * Commit the open editor and move the active cell one column along, wrapping
259
- * at row boundaries the way Excel does. Editors `stopPropagation()` every key
260
- * so the grid's own Tab handler never sees this one - without the explicit
261
- * move, Tab committed the edit and then let the browser walk focus out of the
262
- * grid entirely (#48). Shared by every editor type, including the textarea.
263
- */
264
- function commitAndMoveByTab(shiftKey: boolean) {
265
- const active = ctx.activeCell;
266
- saveEditingCell();
267
- ctx.gridRootEl?.focus({ preventScroll: true });
268
- if (!active) return;
269
- const next = getNextActiveCell(active, shiftKey ? "tabPrev" : "tabNext", {
270
- maxRow: ctx.allRows.length - 1,
271
- maxCol: ctx.allColumns.length - 1,
272
- });
273
- ctx.setActiveCell(next.rowIndex, next.colIndex);
274
- ctx.setSelection(next.rowIndex, next.colIndex);
275
- ctx.scrollActiveCellIntoView(next.rowIndex, next.colIndex);
276
- }
277
-
278
- function onEditorKeyDown(event: KeyboardEvent) {
279
- event.stopPropagation();
280
- if (event.key === "Enter") {
281
- event.preventDefault();
282
- saveEditingCell();
283
- ctx.gridRootEl?.focus({ preventScroll: true });
284
- } else if (event.key === "Tab") {
285
- event.preventDefault();
286
- commitAndMoveByTab(event.shiftKey);
287
- } else if (event.key === "Escape") {
288
- event.preventDefault();
289
- ctx.editingCell = null;
290
- ctx.gridRootEl?.focus({ preventScroll: true });
291
- }
292
- }
293
-
294
- function focusOnMount(node: HTMLInputElement | HTMLTextAreaElement) {
295
- const selectAll = ctx.editorSelectAll;
296
- requestAnimationFrame(() => {
297
- node.focus({ preventScroll: true });
298
- try {
299
- if (selectAll) {
300
- node.select();
301
- } else {
302
- const end = node.value.length;
303
- node.setSelectionRange(end, end);
304
- }
305
- } catch {
306
- /* date/number inputs may not support text selection */
307
- }
308
- });
309
- }
310
-
311
- function onCellDoubleClick(rowIndex: number, colIndex: number) {
312
- if (!ctx.editingEnabled) return;
313
- const row = ctx.allRows[rowIndex];
314
- const column = ctx.allColumns[colIndex];
315
- if (!row || !column) return;
316
- if (isGroupRow(row)) return;
317
- // Full-row editing: put the whole row into edit instead of one cell.
318
- if (ctx.props.fullRowEditing) {
319
- if (ctx.fullRowEdit?.rowId === row.id) return;
320
- startFullRowEdit(rowIndex);
321
- return;
322
- }
323
- if (!isCellEditable(column, row)) return;
324
- if (ctx.editingCell?.rowId === row.id && ctx.editingCell?.columnId === column.id)
325
- return;
326
- const editorType = (column.columnDef.editorType ??
327
- "text") as CellEditorType;
328
- ctx.editorSelectAll = true;
329
- let initialValue = getCellDisplayValue(
330
- row.id,
331
- column.id,
332
- row.getCellValueByColumnId(column.id),
333
- );
334
- if (editorType === "list" || editorType === "chips") {
335
- if (column.columnDef.editorMultiple) {
336
- // Seed with an array so the editor can mutate slot-by-slot.
337
- initialValue = toValueArray(initialValue);
338
- } else if (Array.isArray(initialValue)) {
339
- initialValue = initialValue[0] ?? "";
340
- }
341
- }
342
- ctx.editingCell = {
343
- rowId: row.id,
344
- columnId: column.id,
345
- editorType,
346
- value: initialValue,
347
- rowRef: row.original,
348
- };
349
- ctx.setActiveCell(rowIndex, colIndex);
350
- ctx.setSelection(rowIndex, colIndex);
351
- }
352
-
353
- async function pasteFromClipboard() {
354
- // Preferred path: the async Clipboard API. Requires a secure context
355
- // (HTTPS or localhost) AND read permission; it also works on Firefox,
356
- // where the native `paste` event does NOT fire on a non-editable element.
357
- // On plain HTTP (a XAMPP/Apache LAN host) `navigator.clipboard` is
358
- // undefined - there the Ctrl+V keydown handler skips preventDefault and
359
- // lets the browser deliver a native `paste` event to `onGridPaste`.
360
- if (!navigator.clipboard?.readText) return;
361
- let text: string;
362
- try {
363
- text = await navigator.clipboard.readText();
364
- } catch {
365
- return;
366
- }
367
- applyPastedText(text);
368
- }
369
-
370
- /**
371
- * Native `paste` ClipboardEvent fallback (insecure-context path). A real
372
- * Ctrl/Cmd+V on the focused grid root fires this with `clipboardData`
373
- * readable even over plain HTTP and with no permission prompt. Wired on the
374
- * grid root in SvGrid.svelte; the keydown handler lets the gesture through
375
- * (no preventDefault) whenever the async API is unavailable.
376
- */
377
- function onGridPaste(event: ClipboardEvent) {
378
- // A cell is being edited: the focused editor input handles its own paste
379
- // natively. Never hijack it for a range paste - doing so (on Firefox /
380
- // insecure contexts, where the async Clipboard API is unavailable) would
381
- // preventDefault the editor's paste and write to the data cell instead,
382
- // so the edit "wouldn't update".
383
- if (ctx.editingCell) return;
384
- // When the async API is available the keydown handler already pasted via
385
- // pasteFromClipboard(); ignore the (suppressed) native event so we don't
386
- // paste twice.
387
- if (typeof navigator.clipboard?.readText === "function") return;
388
- const text = event.clipboardData?.getData("text/plain") ?? "";
389
- if (!text) return;
390
- event.preventDefault();
391
- applyPastedText(text);
392
- }
393
-
394
- function applyPastedText(text: string) {
395
- const anchor = ctx.selectionRange.anchor ?? ctx.grid.getState().activeCell;
396
- if (!anchor) return;
397
- const focus = ctx.selectionRange.focus ?? anchor;
398
- const startRow = Math.min(anchor.rowIndex, focus.rowIndex);
399
- const startCol = Math.min(anchor.colIndex, focus.colIndex);
400
- const endRow = Math.max(anchor.rowIndex, focus.rowIndex);
401
- const endCol = Math.max(anchor.colIndex, focus.colIndex);
402
- const lines = text.replace(/\r\n/g, "\n").split("\n");
403
- if (lines.length > 0 && lines[lines.length - 1] === "") lines.pop();
404
- if (!lines.length) return;
405
-
406
- // Excel/Sheets behaviour: when the clipboard holds a single cell and
407
- // the selection is a range, fill the entire range with that value.
408
- // For larger clipboards (multi-row/col TSV), paste at the top-left
409
- // corner and let the clipboard determine the span (the original
410
- // behaviour).
411
- const clipboardIsSingleCell =
412
- lines.length === 1 && (lines[0]?.split("\t").length ?? 0) === 1;
413
- const selectionIsRange = startRow !== endRow || startCol !== endCol;
414
- const fillRange = clipboardIsSingleCell && selectionIsRange;
415
-
416
- const rowSpan = fillRange ? endRow - startRow + 1 : lines.length;
417
- const colSpan = fillRange
418
- ? endCol - startCol + 1
419
- : Math.max(...lines.map((l) => l.split("\t").length));
420
-
421
- const next = ctx.internalData.slice() as Array<TData>;
422
- const dataIndexOf = createDataIndexLookup(next);
423
- for (let i = 0; i < rowSpan; i += 1) {
424
- const targetRowIndex = startRow + i;
425
- const row = ctx.allRows[targetRowIndex];
426
- if (!row || isGroupRow(row)) continue;
427
- // Map the visible row back to its slot in the data array by identity -
428
- // `row.id` is only the index under the default getRowId.
429
- const dataIndex = dataIndexOf(row);
430
- if (dataIndex < 0) continue;
431
- const originalRow = next[dataIndex];
432
- if (!originalRow) continue;
433
- const sourceCells = fillRange
434
- ? null
435
- : lines[i]?.split("\t") ?? [];
436
- const updated: Record<string, unknown> = {
437
- ...(originalRow as Record<string, unknown>),
438
- };
439
- for (let j = 0; j < colSpan; j += 1) {
440
- const column = ctx.allColumns[startCol + j];
441
- if (!column?.columnDef.field) continue;
442
- if (!isCellEditableAt(targetRowIndex, startCol + j)) continue;
443
- const editorType = (column.columnDef.editorType ??
444
- "text") as CellEditorType;
445
- const raw = fillRange ? lines[0]! : sourceCells?.[j] ?? "";
446
- updated[column.columnDef.field] = parseEditorValue(editorType, raw, {
447
- dateOnly: column.columnDef.cellDataType === "dateString",
448
- });
449
- }
450
- next[dataIndex] = updated as TData;
451
- }
452
- ctx.internalData = next;
453
- ctx.grid.store.setState((prev: any) => ({ ...prev }));
454
- }
455
-
456
- /** Programmatically begin editing a cell (mirrors a double-click). */
457
- function startEditing(rowIndex: number, columnId: string): boolean {
458
- if (!ctx.editingEnabled) return false;
459
- const row = ctx.allRows[rowIndex];
460
- if (!row || isGroupRow(row)) return false;
461
- const colIndex = ctx.allColumns.findIndex((c: any) => c.id === columnId);
462
- if (colIndex < 0) return false;
463
- const column = ctx.allColumns[colIndex];
464
- if (!isCellEditable(column, row)) return false;
465
- if (
466
- ctx.editingCell?.rowId === row.id &&
467
- ctx.editingCell?.columnId === columnId
468
- )
469
- return true;
470
- onCellDoubleClick(rowIndex, colIndex);
471
- return (
472
- ctx.editingCell?.rowId === row.id &&
473
- ctx.editingCell?.columnId === columnId
474
- );
475
- }
476
-
477
- /** Commit (default) or cancel the active edit, if any. */
478
- function stopEditing(cancel = false): boolean {
479
- if (!ctx.editingCell) return false;
480
- if (cancel) {
481
- ctx.editingCell = null;
482
- } else {
483
- saveEditingCell();
484
- }
485
- return true;
486
- }
487
-
488
- // ---- Full-row editing -------------------------------------------------
489
- /** Put the whole row into edit mode, seeding a draft per editable column. */
490
- function startFullRowEdit(rowIndex: number): boolean {
491
- if (!ctx.editingEnabled || !ctx.props.fullRowEditing) return false;
492
- const row = ctx.allRows[rowIndex];
493
- if (!row || isGroupRow(row)) return false;
494
- if (ctx.fullRowEdit && ctx.fullRowEdit.rowId !== row.id) commitFullRowEdit();
495
- ctx.editingCell = null; // never both at once
496
- const draft: Record<string, unknown> = {};
497
- for (const column of ctx.allColumns) {
498
- if (!column.columnDef.field) continue;
499
- if (!isCellEditable(column, row)) continue;
500
- draft[column.id] = getCellDisplayValue(
501
- row.id,
502
- column.id,
503
- row.getCellValueByColumnId(column.id),
504
- );
505
- }
506
- ctx.fullRowEdit = { rowId: row.id, draft };
507
- ctx.setActiveCell(rowIndex, Math.max(0, ctx.allColumns.findIndex((c: any) => c.id in draft)));
508
- return true;
509
- }
510
-
511
- /** Stage one column's draft value during full-row editing. */
512
- function setFullRowDraft(columnId: string, value: unknown): void {
513
- const fr = ctx.fullRowEdit;
514
- if (!fr) return;
515
- ctx.fullRowEdit = { rowId: fr.rowId, draft: { ...fr.draft, [columnId]: value } };
516
- }
517
-
518
- /** Commit every drafted column of the full-row edit in one data update. */
519
- function commitFullRowEdit(): void {
520
- const fr = ctx.fullRowEdit;
521
- if (!fr) return;
522
- const row = ctx.allRows.find((r: any) => r.id === fr.rowId);
523
- if (!row?.original) {
524
- ctx.fullRowEdit = null;
525
- return;
526
- }
527
- const changed: Array<{ columnId: string; field: string; before: unknown; after: unknown }> = [];
528
- for (const column of ctx.allColumns) {
529
- if (!(column.id in fr.draft)) continue;
530
- const field = column.columnDef.field as string | undefined;
531
- if (!field) continue;
532
- const editorType = (column.columnDef.editorType ?? "text") as CellEditorType;
533
- const parsed = parseEditorValue(editorType, fr.draft[column.id], {
534
- multiple: column.columnDef.editorMultiple === true,
535
- dateOnly: column.columnDef.cellDataType === "dateString",
536
- });
537
- const oldValue = (row.original as Record<string, unknown>)[field];
538
- const parser = (column.columnDef as { valueParser?: (p: unknown) => unknown }).valueParser;
539
- const finalValue = parser
540
- ? parser({
541
- newValue: parsed,
542
- oldValue,
543
- rawInput: String(fr.draft[column.id] ?? ""),
544
- data: row.original,
545
- columnId: column.id,
546
- })
547
- : parsed;
548
- if (oldValue !== finalValue) {
549
- (row.original as Record<string, unknown>)[field] = finalValue;
550
- const key = getCellKey(fr.rowId, column.id);
551
- ctx.editedCellValues = { ...ctx.editedCellValues, [key]: finalValue };
552
- changed.push({ columnId: column.id, field, before: oldValue, after: finalValue });
553
- }
554
- }
555
- // Record the whole-row change as consecutive history steps.
556
- if (changed.length) {
557
- let hist = ctx.history.slice(0, ctx.historyPtr + 1);
558
- for (const c of changed) {
559
- hist.push({ rowId: fr.rowId, columnId: c.columnId, field: c.field, before: c.before, after: c.after });
560
- }
561
- if (hist.length > ctx.UNDO_LIMIT) hist = hist.slice(hist.length - ctx.UNDO_LIMIT);
562
- ctx.history = hist;
563
- ctx.historyPtr = ctx.history.length - 1;
564
- ctx.historyVersion += 1;
565
- }
566
- ctx.grid.store.setState((prev: any) => ({ ...prev }));
567
- if (ctx.props.onCellValueChange && changed.length) {
568
- const rowIndex = ctx.internalData.indexOf(row.original as TData);
569
- for (const c of changed) {
570
- ctx.props.onCellValueChange({
571
- rowIndex,
572
- columnId: c.columnId,
573
- oldValue: c.before,
574
- newValue: c.after,
575
- row: row.original as TData,
576
- });
577
- }
578
- }
579
- ctx.fullRowEdit = null;
580
- }
581
-
582
- /** Discard the full-row edit. */
583
- function cancelFullRowEdit(): void {
584
- ctx.fullRowEdit = null;
585
- }
586
-
587
- return {
588
- isCellEditable,
589
- isCellEditableAt,
590
- getRowColumnValue,
591
- getCellDisplayValue,
592
- startEditingWithChar,
593
- startEditing,
594
- stopEditing,
595
- startFullRowEdit,
596
- setFullRowDraft,
597
- commitFullRowEdit,
598
- cancelFullRowEdit,
599
- saveEditingCell,
600
- applyHistoryStep,
601
- updateEditingCellValue,
602
- onEditorKeyDown,
603
- commitAndMoveByTab,
604
- focusOnMount,
605
- onCellDoubleClick,
606
- pasteFromClipboard,
607
- onGridPaste,
608
- };
609
- }
1
+ // editing handlers extracted from the controller. Imperative event handlers
2
+ // reading/writing controller state via the `ctx` handle; the reactive core
3
+ // ($state/$derived/$effect) stays in the controller.
4
+ import {
5
+ parseEditorValue,
6
+ type CellContext,
7
+ type CellEditorType,
8
+ type Column,
9
+ type Row,
10
+ type RowData,
11
+ type TableFeatures,
12
+ } from "./index";
13
+ import "./sv-grid-scrollbar";
14
+ import { getNextActiveCell } from "./keyboard";
15
+ import {
16
+ getCellKey,
17
+ toValueArray,
18
+ } from "./SvGrid.helpers";
19
+ import {
20
+ createDataIndexLookup,
21
+ getColumnBaseValue,
22
+ isGroupRow,
23
+ } from "./cell-values";
24
+
25
+ type HistoryStep = {
26
+ rowId: string;
27
+ columnId: string;
28
+ field: string;
29
+ before: unknown;
30
+ after: unknown;
31
+ };
32
+
33
+ export function createEditing<
34
+ TFeatures extends TableFeatures = TableFeatures,
35
+ TData extends RowData = RowData,
36
+ >(ctx: any) {
37
+ /**
38
+ * Resolve `columnDef.editable` for one row × column pair.
39
+ *
40
+ * - `undefined` / `true` → editable
41
+ * - `false` → not editable (column-level lockdown, fastest path)
42
+ * - function → call it with the cell's context and honour the
43
+ * boolean it returns (cell-level lockdown - used for things like
44
+ * "this field is owned by the server, this one isn't, by row")
45
+ *
46
+ * Called from every editing entry point: double-click, type-to-edit,
47
+ * fill-handle drag, Delete-clear, clipboard paste. A central helper
48
+ * keeps the cell-level callback signature consistent and saves a
49
+ * lookup of CellContext at each site.
50
+ */
51
+ function isCellEditable(column: Column<TData>, row?: Row<TData>): boolean {
52
+ const editable = column.columnDef.editable;
53
+ if (editable === false) return false;
54
+ if (typeof editable !== "function") return true;
55
+ if (!row) return true;
56
+ const cellCtx: CellContext<TData> = {
57
+ cell: {
58
+ id: `${row.id}_${column.id}`,
59
+ row,
60
+ column,
61
+ getValue: () => getColumnBaseValue(row, column),
62
+ getContext: () => cellCtx,
63
+ },
64
+ row,
65
+ column,
66
+ table: ctx.grid,
67
+ getValue: () => getColumnBaseValue(row, column),
68
+ };
69
+ try {
70
+ return editable(cellCtx) !== false;
71
+ } catch {
72
+ // A throwing predicate shouldn't crash the grid - log and treat
73
+ // as not-editable so any error biases toward safety.
74
+ return false;
75
+ }
76
+ }
77
+
78
+ /** Variant that takes raw row + column indices for the rare callers
79
+ * (fill-handle, paste, Delete) that already work in index-space. */
80
+ function isCellEditableAt(rowIndex: number, colIndex: number): boolean {
81
+ const row = ctx.allRows[rowIndex];
82
+ const column = ctx.allColumns[colIndex];
83
+ if (!column) return false;
84
+ return isCellEditable(column, row);
85
+ }
86
+
87
+ function getRowColumnValue(row: Row<TData>, columnId: string) {
88
+ const column = ctx.allColumns.find((entry: any) => entry.id === columnId);
89
+ return column
90
+ ? getColumnBaseValue(row, column)
91
+ : row.getCellValueByColumnId(columnId);
92
+ }
93
+
94
+ function getCellDisplayValue(
95
+ rowId: string,
96
+ columnId: string,
97
+ baseValue: unknown,
98
+ ) {
99
+ const key = getCellKey(rowId, columnId);
100
+ return key in ctx.editedCellValues ? ctx.editedCellValues[key] : baseValue;
101
+ }
102
+
103
+ /** Start editing seeded with a typed character (Excel-style type-to-edit). */
104
+ function startEditingWithChar(
105
+ rowIndex: number,
106
+ colIndex: number,
107
+ char: string,
108
+ ): boolean {
109
+ if (!ctx.editingEnabled) return false;
110
+ const row = ctx.allRows[rowIndex];
111
+ const column = ctx.allColumns[colIndex];
112
+ if (!row || !column || isGroupRow(row)) return false;
113
+ if (!isCellEditable(column, row)) return false;
114
+ const editorType = (column.columnDef.editorType ??
115
+ "text") as CellEditorType;
116
+ if (
117
+ editorType === "checkbox" ||
118
+ editorType === "date" ||
119
+ editorType === "datetime" ||
120
+ editorType === "list" ||
121
+ editorType === "chips"
122
+ ) {
123
+ return false;
124
+ }
125
+ if (editorType === "number" && !/[0-9.+-]/.test(char)) return false;
126
+ ctx.editorSelectAll = false;
127
+ ctx.editingCell = {
128
+ rowId: row.id,
129
+ columnId: column.id,
130
+ editorType,
131
+ value: char,
132
+ rowRef: row.original,
133
+ };
134
+ ctx.setActiveCell(rowIndex, colIndex);
135
+ ctx.setSelection(rowIndex, colIndex);
136
+ return true;
137
+ }
138
+
139
+ function saveEditingCell() {
140
+ if (!ctx.editingCell) return;
141
+ const editing = ctx.editingCell;
142
+ // Resolve the row this edit belongs to. `allRows` is only the current page,
143
+ // so fall back to the full filtered model, then to the data object captured
144
+ // when the edit started. Without that last hop an edit is silently dropped
145
+ // when a filter typed mid-edit hides the row from both models (#49).
146
+ const row =
147
+ ctx.allRows.find((entry: any) => entry.id === editing.rowId) ??
148
+ ctx.allRowsBeforePagination.find((entry: any) => entry.id === editing.rowId);
149
+ const rowData = (row?.original ?? editing.rowRef) as
150
+ | Record<string, unknown>
151
+ | undefined;
152
+ const column = ctx.allColumns.find(
153
+ (entry: any) => entry.id === ctx.editingCell?.columnId,
154
+ );
155
+ const parsedValue = parseEditorValue(
156
+ ctx.editingCell.editorType,
157
+ ctx.editingCell.value,
158
+ {
159
+ multiple: column?.columnDef.editorMultiple === true,
160
+ // A dateString column holds 'YYYY-MM-DD', not a timestamp.
161
+ dateOnly: column?.columnDef.cellDataType === "dateString",
162
+ },
163
+ );
164
+ let oldValue: unknown = undefined;
165
+ let finalValue: unknown = parsedValue;
166
+ if (rowData && column?.columnDef.field) {
167
+ oldValue = rowData[column.columnDef.field];
168
+ // Per-column valueParser refines the type-coerced value before storing.
169
+ const parser = (
170
+ column.columnDef as { valueParser?: (p: unknown) => unknown }
171
+ ).valueParser;
172
+ if (parser) {
173
+ finalValue = parser({
174
+ newValue: parsedValue,
175
+ oldValue,
176
+ rawInput: ctx.editingCell.value,
177
+ data: rowData,
178
+ columnId: ctx.editingCell.columnId,
179
+ });
180
+ }
181
+ rowData[column.columnDef.field] = finalValue;
182
+ }
183
+ const key = getCellKey(ctx.editingCell.rowId, ctx.editingCell.columnId);
184
+ ctx.editedCellValues = {
185
+ ...ctx.editedCellValues,
186
+ [key]: finalValue,
187
+ };
188
+ ctx.grid.store.setState((prev: any) => ({ ...prev }));
189
+ // Record into the history at the current pointer. Any forward
190
+ // history (steps the user could have redone) is truncated - this
191
+ // is the standard "edit invalidates redo" rule.
192
+ if (oldValue !== finalValue && rowData && column?.columnDef.field) {
193
+ const step: HistoryStep = {
194
+ rowId: ctx.editingCell.rowId,
195
+ columnId: ctx.editingCell.columnId,
196
+ field: column.columnDef.field as string,
197
+ before: oldValue,
198
+ after: finalValue,
199
+ }
200
+ const truncated = ctx.history.slice(0, ctx.historyPtr + 1)
201
+ truncated.push(step)
202
+ // Cap the buffer at UNDO_LIMIT; drop the OLDEST entries so the
203
+ // pointer stays valid relative to the newest steps.
204
+ if (truncated.length > ctx.UNDO_LIMIT) {
205
+ const drop = truncated.length - ctx.UNDO_LIMIT
206
+ ctx.history = truncated.slice(drop)
207
+ ctx.historyPtr = ctx.history.length - 1
208
+ } else {
209
+ ctx.history = truncated
210
+ ctx.historyPtr = ctx.history.length - 1
211
+ }
212
+ ctx.historyVersion += 1
213
+ }
214
+ // Notify the consumer AFTER the row has been updated so any callback-
215
+ // driven recompute (cascade totals, server save, undo stack) sees the
216
+ // post-write state. `rowIndex` matches the position in `props.data`.
217
+ if (ctx.props.onCellValueChange && rowData && column) {
218
+ const rowIndex = ctx.internalData.indexOf(rowData as TData);
219
+ ctx.props.onCellValueChange({
220
+ rowIndex,
221
+ columnId: column.id,
222
+ oldValue,
223
+ newValue: finalValue,
224
+ row: rowData as TData,
225
+ });
226
+ }
227
+ ctx.editingCell = null;
228
+ }
229
+
230
+ /** Apply an undo / redo step directly to the underlying row, bypassing
231
+ * the editor pipeline so we don't accidentally re-push to the stack. */
232
+ function applyHistoryStep(step: HistoryStep, direction: 'undo' | 'redo') {
233
+ const row = ctx.allRows.find((r: any) => r.id === step.rowId)
234
+ const col = ctx.allColumns.find((c: any) => c.id === step.columnId)
235
+ if (!row?.original || !col) return
236
+ const value = direction === 'undo' ? step.before : step.after
237
+ ;(row.original as Record<string, unknown>)[step.field] = value
238
+ const key = getCellKey(step.rowId, step.columnId)
239
+ ctx.editedCellValues = { ...ctx.editedCellValues, [key]: value }
240
+ ctx.grid.store.setState((prev: any) => ({ ...prev }))
241
+ if (ctx.props.onCellValueChange) {
242
+ const rowIndex = ctx.internalData.indexOf(row.original as TData)
243
+ ctx.props.onCellValueChange({
244
+ rowIndex,
245
+ columnId: step.columnId,
246
+ oldValue: direction === 'undo' ? step.after : step.before,
247
+ newValue: value,
248
+ row: row.original as TData,
249
+ })
250
+ }
251
+ }
252
+
253
+ function updateEditingCellValue(value: unknown) {
254
+ ctx.editingCell = ctx.editingCell ? { ...ctx.editingCell, value } : ctx.editingCell;
255
+ }
256
+
257
+ /**
258
+ * Commit the open editor and move the active cell one column along, wrapping
259
+ * at row boundaries the way Excel does. Editors `stopPropagation()` every key
260
+ * so the grid's own Tab handler never sees this one - without the explicit
261
+ * move, Tab committed the edit and then let the browser walk focus out of the
262
+ * grid entirely (#48). Shared by every editor type, including the textarea.
263
+ */
264
+ function commitAndMoveByTab(shiftKey: boolean) {
265
+ const active = ctx.activeCell;
266
+ saveEditingCell();
267
+ ctx.gridRootEl?.focus({ preventScroll: true });
268
+ if (!active) return;
269
+ const next = getNextActiveCell(active, shiftKey ? "tabPrev" : "tabNext", {
270
+ maxRow: ctx.allRows.length - 1,
271
+ maxCol: ctx.allColumns.length - 1,
272
+ });
273
+ ctx.setActiveCell(next.rowIndex, next.colIndex);
274
+ ctx.setSelection(next.rowIndex, next.colIndex);
275
+ ctx.scrollActiveCellIntoView(next.rowIndex, next.colIndex);
276
+ }
277
+
278
+ function onEditorKeyDown(event: KeyboardEvent) {
279
+ event.stopPropagation();
280
+ if (event.key === "Enter") {
281
+ event.preventDefault();
282
+ saveEditingCell();
283
+ ctx.gridRootEl?.focus({ preventScroll: true });
284
+ } else if (event.key === "Tab") {
285
+ event.preventDefault();
286
+ commitAndMoveByTab(event.shiftKey);
287
+ } else if (event.key === "Escape") {
288
+ event.preventDefault();
289
+ ctx.editingCell = null;
290
+ ctx.gridRootEl?.focus({ preventScroll: true });
291
+ }
292
+ }
293
+
294
+ function focusOnMount(node: HTMLInputElement | HTMLTextAreaElement) {
295
+ const selectAll = ctx.editorSelectAll;
296
+ requestAnimationFrame(() => {
297
+ node.focus({ preventScroll: true });
298
+ try {
299
+ if (selectAll) {
300
+ node.select();
301
+ } else {
302
+ const end = node.value.length;
303
+ node.setSelectionRange(end, end);
304
+ }
305
+ } catch {
306
+ /* date/number inputs may not support text selection */
307
+ }
308
+ });
309
+ }
310
+
311
+ function onCellDoubleClick(rowIndex: number, colIndex: number) {
312
+ if (!ctx.editingEnabled) return;
313
+ const row = ctx.allRows[rowIndex];
314
+ const column = ctx.allColumns[colIndex];
315
+ if (!row || !column) return;
316
+ if (isGroupRow(row)) return;
317
+ // Full-row editing: put the whole row into edit instead of one cell.
318
+ if (ctx.props.fullRowEditing) {
319
+ if (ctx.fullRowEdit?.rowId === row.id) return;
320
+ startFullRowEdit(rowIndex);
321
+ return;
322
+ }
323
+ if (!isCellEditable(column, row)) return;
324
+ if (ctx.editingCell?.rowId === row.id && ctx.editingCell?.columnId === column.id)
325
+ return;
326
+ const editorType = (column.columnDef.editorType ??
327
+ "text") as CellEditorType;
328
+ ctx.editorSelectAll = true;
329
+ let initialValue = getCellDisplayValue(
330
+ row.id,
331
+ column.id,
332
+ row.getCellValueByColumnId(column.id),
333
+ );
334
+ if (editorType === "list" || editorType === "chips") {
335
+ if (column.columnDef.editorMultiple) {
336
+ // Seed with an array so the editor can mutate slot-by-slot.
337
+ initialValue = toValueArray(initialValue);
338
+ } else if (Array.isArray(initialValue)) {
339
+ initialValue = initialValue[0] ?? "";
340
+ }
341
+ }
342
+ ctx.editingCell = {
343
+ rowId: row.id,
344
+ columnId: column.id,
345
+ editorType,
346
+ value: initialValue,
347
+ rowRef: row.original,
348
+ };
349
+ ctx.setActiveCell(rowIndex, colIndex);
350
+ ctx.setSelection(rowIndex, colIndex);
351
+ }
352
+
353
+ async function pasteFromClipboard() {
354
+ // Preferred path: the async Clipboard API. Requires a secure context
355
+ // (HTTPS or localhost) AND read permission; it also works on Firefox,
356
+ // where the native `paste` event does NOT fire on a non-editable element.
357
+ // On plain HTTP (a XAMPP/Apache LAN host) `navigator.clipboard` is
358
+ // undefined - there the Ctrl+V keydown handler skips preventDefault and
359
+ // lets the browser deliver a native `paste` event to `onGridPaste`.
360
+ if (!navigator.clipboard?.readText) return;
361
+ let text: string;
362
+ try {
363
+ text = await navigator.clipboard.readText();
364
+ } catch {
365
+ return;
366
+ }
367
+ applyPastedText(text);
368
+ }
369
+
370
+ /**
371
+ * Native `paste` ClipboardEvent fallback (insecure-context path). A real
372
+ * Ctrl/Cmd+V on the focused grid root fires this with `clipboardData`
373
+ * readable even over plain HTTP and with no permission prompt. Wired on the
374
+ * grid root in SvGrid.svelte; the keydown handler lets the gesture through
375
+ * (no preventDefault) whenever the async API is unavailable.
376
+ */
377
+ function onGridPaste(event: ClipboardEvent) {
378
+ // A cell is being edited: the focused editor input handles its own paste
379
+ // natively. Never hijack it for a range paste - doing so (on Firefox /
380
+ // insecure contexts, where the async Clipboard API is unavailable) would
381
+ // preventDefault the editor's paste and write to the data cell instead,
382
+ // so the edit "wouldn't update".
383
+ if (ctx.editingCell) return;
384
+ // When the async API is available the keydown handler already pasted via
385
+ // pasteFromClipboard(); ignore the (suppressed) native event so we don't
386
+ // paste twice.
387
+ if (typeof navigator.clipboard?.readText === "function") return;
388
+ const text = event.clipboardData?.getData("text/plain") ?? "";
389
+ if (!text) return;
390
+ event.preventDefault();
391
+ applyPastedText(text);
392
+ }
393
+
394
+ function applyPastedText(text: string) {
395
+ const anchor = ctx.selectionRange.anchor ?? ctx.grid.getState().activeCell;
396
+ if (!anchor) return;
397
+ const focus = ctx.selectionRange.focus ?? anchor;
398
+ const startRow = Math.min(anchor.rowIndex, focus.rowIndex);
399
+ const startCol = Math.min(anchor.colIndex, focus.colIndex);
400
+ const endRow = Math.max(anchor.rowIndex, focus.rowIndex);
401
+ const endCol = Math.max(anchor.colIndex, focus.colIndex);
402
+ const lines = text.replace(/\r\n/g, "\n").split("\n");
403
+ if (lines.length > 0 && lines[lines.length - 1] === "") lines.pop();
404
+ if (!lines.length) return;
405
+
406
+ // Excel/Sheets behaviour: when the clipboard holds a single cell and
407
+ // the selection is a range, fill the entire range with that value.
408
+ // For larger clipboards (multi-row/col TSV), paste at the top-left
409
+ // corner and let the clipboard determine the span (the original
410
+ // behaviour).
411
+ const clipboardIsSingleCell =
412
+ lines.length === 1 && (lines[0]?.split("\t").length ?? 0) === 1;
413
+ const selectionIsRange = startRow !== endRow || startCol !== endCol;
414
+ const fillRange = clipboardIsSingleCell && selectionIsRange;
415
+
416
+ const rowSpan = fillRange ? endRow - startRow + 1 : lines.length;
417
+ const colSpan = fillRange
418
+ ? endCol - startCol + 1
419
+ : Math.max(...lines.map((l) => l.split("\t").length));
420
+
421
+ const next = ctx.internalData.slice() as Array<TData>;
422
+ const dataIndexOf = createDataIndexLookup(next);
423
+ for (let i = 0; i < rowSpan; i += 1) {
424
+ const targetRowIndex = startRow + i;
425
+ const row = ctx.allRows[targetRowIndex];
426
+ if (!row || isGroupRow(row)) continue;
427
+ // Map the visible row back to its slot in the data array by identity -
428
+ // `row.id` is only the index under the default getRowId.
429
+ const dataIndex = dataIndexOf(row);
430
+ if (dataIndex < 0) continue;
431
+ const originalRow = next[dataIndex];
432
+ if (!originalRow) continue;
433
+ const sourceCells = fillRange
434
+ ? null
435
+ : lines[i]?.split("\t") ?? [];
436
+ const updated: Record<string, unknown> = {
437
+ ...(originalRow as Record<string, unknown>),
438
+ };
439
+ for (let j = 0; j < colSpan; j += 1) {
440
+ const column = ctx.allColumns[startCol + j];
441
+ if (!column?.columnDef.field) continue;
442
+ if (!isCellEditableAt(targetRowIndex, startCol + j)) continue;
443
+ const editorType = (column.columnDef.editorType ??
444
+ "text") as CellEditorType;
445
+ const raw = fillRange ? lines[0]! : sourceCells?.[j] ?? "";
446
+ updated[column.columnDef.field] = parseEditorValue(editorType, raw, {
447
+ dateOnly: column.columnDef.cellDataType === "dateString",
448
+ });
449
+ }
450
+ next[dataIndex] = updated as TData;
451
+ }
452
+ ctx.internalData = next;
453
+ ctx.grid.store.setState((prev: any) => ({ ...prev }));
454
+ }
455
+
456
+ /** Programmatically begin editing a cell (mirrors a double-click). */
457
+ function startEditing(rowIndex: number, columnId: string): boolean {
458
+ if (!ctx.editingEnabled) return false;
459
+ const row = ctx.allRows[rowIndex];
460
+ if (!row || isGroupRow(row)) return false;
461
+ const colIndex = ctx.allColumns.findIndex((c: any) => c.id === columnId);
462
+ if (colIndex < 0) return false;
463
+ const column = ctx.allColumns[colIndex];
464
+ if (!isCellEditable(column, row)) return false;
465
+ if (
466
+ ctx.editingCell?.rowId === row.id &&
467
+ ctx.editingCell?.columnId === columnId
468
+ )
469
+ return true;
470
+ onCellDoubleClick(rowIndex, colIndex);
471
+ return (
472
+ ctx.editingCell?.rowId === row.id &&
473
+ ctx.editingCell?.columnId === columnId
474
+ );
475
+ }
476
+
477
+ /** Commit (default) or cancel the active edit, if any. */
478
+ function stopEditing(cancel = false): boolean {
479
+ if (!ctx.editingCell) return false;
480
+ if (cancel) {
481
+ ctx.editingCell = null;
482
+ } else {
483
+ saveEditingCell();
484
+ }
485
+ return true;
486
+ }
487
+
488
+ // ---- Full-row editing -------------------------------------------------
489
+ /** Put the whole row into edit mode, seeding a draft per editable column. */
490
+ function startFullRowEdit(rowIndex: number): boolean {
491
+ if (!ctx.editingEnabled || !ctx.props.fullRowEditing) return false;
492
+ const row = ctx.allRows[rowIndex];
493
+ if (!row || isGroupRow(row)) return false;
494
+ if (ctx.fullRowEdit && ctx.fullRowEdit.rowId !== row.id) commitFullRowEdit();
495
+ ctx.editingCell = null; // never both at once
496
+ const draft: Record<string, unknown> = {};
497
+ for (const column of ctx.allColumns) {
498
+ if (!column.columnDef.field) continue;
499
+ if (!isCellEditable(column, row)) continue;
500
+ draft[column.id] = getCellDisplayValue(
501
+ row.id,
502
+ column.id,
503
+ row.getCellValueByColumnId(column.id),
504
+ );
505
+ }
506
+ ctx.fullRowEdit = { rowId: row.id, draft };
507
+ ctx.setActiveCell(rowIndex, Math.max(0, ctx.allColumns.findIndex((c: any) => c.id in draft)));
508
+ return true;
509
+ }
510
+
511
+ /** Stage one column's draft value during full-row editing. */
512
+ function setFullRowDraft(columnId: string, value: unknown): void {
513
+ const fr = ctx.fullRowEdit;
514
+ if (!fr) return;
515
+ ctx.fullRowEdit = { rowId: fr.rowId, draft: { ...fr.draft, [columnId]: value } };
516
+ }
517
+
518
+ /** Commit every drafted column of the full-row edit in one data update. */
519
+ function commitFullRowEdit(): void {
520
+ const fr = ctx.fullRowEdit;
521
+ if (!fr) return;
522
+ const row = ctx.allRows.find((r: any) => r.id === fr.rowId);
523
+ if (!row?.original) {
524
+ ctx.fullRowEdit = null;
525
+ return;
526
+ }
527
+ const changed: Array<{ columnId: string; field: string; before: unknown; after: unknown }> = [];
528
+ for (const column of ctx.allColumns) {
529
+ if (!(column.id in fr.draft)) continue;
530
+ const field = column.columnDef.field as string | undefined;
531
+ if (!field) continue;
532
+ const editorType = (column.columnDef.editorType ?? "text") as CellEditorType;
533
+ const parsed = parseEditorValue(editorType, fr.draft[column.id], {
534
+ multiple: column.columnDef.editorMultiple === true,
535
+ dateOnly: column.columnDef.cellDataType === "dateString",
536
+ });
537
+ const oldValue = (row.original as Record<string, unknown>)[field];
538
+ const parser = (column.columnDef as { valueParser?: (p: unknown) => unknown }).valueParser;
539
+ const finalValue = parser
540
+ ? parser({
541
+ newValue: parsed,
542
+ oldValue,
543
+ rawInput: String(fr.draft[column.id] ?? ""),
544
+ data: row.original,
545
+ columnId: column.id,
546
+ })
547
+ : parsed;
548
+ if (oldValue !== finalValue) {
549
+ (row.original as Record<string, unknown>)[field] = finalValue;
550
+ const key = getCellKey(fr.rowId, column.id);
551
+ ctx.editedCellValues = { ...ctx.editedCellValues, [key]: finalValue };
552
+ changed.push({ columnId: column.id, field, before: oldValue, after: finalValue });
553
+ }
554
+ }
555
+ // Record the whole-row change as consecutive history steps.
556
+ if (changed.length) {
557
+ let hist = ctx.history.slice(0, ctx.historyPtr + 1);
558
+ for (const c of changed) {
559
+ hist.push({ rowId: fr.rowId, columnId: c.columnId, field: c.field, before: c.before, after: c.after });
560
+ }
561
+ if (hist.length > ctx.UNDO_LIMIT) hist = hist.slice(hist.length - ctx.UNDO_LIMIT);
562
+ ctx.history = hist;
563
+ ctx.historyPtr = ctx.history.length - 1;
564
+ ctx.historyVersion += 1;
565
+ }
566
+ ctx.grid.store.setState((prev: any) => ({ ...prev }));
567
+ if (ctx.props.onCellValueChange && changed.length) {
568
+ const rowIndex = ctx.internalData.indexOf(row.original as TData);
569
+ for (const c of changed) {
570
+ ctx.props.onCellValueChange({
571
+ rowIndex,
572
+ columnId: c.columnId,
573
+ oldValue: c.before,
574
+ newValue: c.after,
575
+ row: row.original as TData,
576
+ });
577
+ }
578
+ }
579
+ ctx.fullRowEdit = null;
580
+ }
581
+
582
+ /** Discard the full-row edit. */
583
+ function cancelFullRowEdit(): void {
584
+ ctx.fullRowEdit = null;
585
+ }
586
+
587
+ return {
588
+ isCellEditable,
589
+ isCellEditableAt,
590
+ getRowColumnValue,
591
+ getCellDisplayValue,
592
+ startEditingWithChar,
593
+ startEditing,
594
+ stopEditing,
595
+ startFullRowEdit,
596
+ setFullRowDraft,
597
+ commitFullRowEdit,
598
+ cancelFullRowEdit,
599
+ saveEditingCell,
600
+ applyHistoryStep,
601
+ updateEditingCellValue,
602
+ onEditorKeyDown,
603
+ commitAndMoveByTab,
604
+ focusOnMount,
605
+ onCellDoubleClick,
606
+ pasteFromClipboard,
607
+ onGridPaste,
608
+ };
609
+ }