@svgrid/grid 1.1.0 → 1.1.1

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 (117) hide show
  1. package/dist/GridMenus.svelte +205 -127
  2. package/dist/SvGrid.controller.svelte.d.ts +44 -1
  3. package/dist/SvGrid.controller.svelte.js +223 -38
  4. package/dist/SvGrid.css +2012 -1709
  5. package/dist/SvGrid.helpers.test.d.ts +1 -0
  6. package/dist/SvGrid.helpers.test.js +298 -0
  7. package/dist/SvGrid.svelte +2346 -2043
  8. package/dist/SvGrid.types.d.ts +91 -4
  9. package/dist/aligned-grids.d.ts +6 -0
  10. package/dist/aligned-grids.js +84 -0
  11. package/dist/aligned-grids.test.d.ts +1 -0
  12. package/dist/aligned-grids.test.js +75 -0
  13. package/dist/build-api.coverage.test.d.ts +20 -0
  14. package/dist/build-api.coverage.test.js +505 -0
  15. package/dist/build-api.js +59 -29
  16. package/dist/cell-render.test.d.ts +1 -0
  17. package/dist/cell-render.test.js +338 -0
  18. package/dist/chart-export.test.d.ts +1 -0
  19. package/dist/chart-export.test.js +302 -0
  20. package/dist/chart.coverage.test.d.ts +1 -0
  21. package/dist/chart.coverage.test.js +748 -0
  22. package/dist/clipboard.js +88 -24
  23. package/dist/clipboard.test.d.ts +1 -0
  24. package/dist/clipboard.test.js +700 -0
  25. package/dist/collaboration.coverage.test.d.ts +1 -0
  26. package/dist/collaboration.coverage.test.js +200 -0
  27. package/dist/column-groups.d.ts +19 -0
  28. package/dist/column-groups.js +62 -0
  29. package/dist/column-groups.test.d.ts +1 -0
  30. package/dist/column-groups.test.js +56 -0
  31. package/dist/column-types.d.ts +10 -0
  32. package/dist/column-types.js +63 -0
  33. package/dist/column-types.test.d.ts +1 -0
  34. package/dist/column-types.test.js +62 -0
  35. package/dist/columns.test.d.ts +1 -0
  36. package/dist/columns.test.js +625 -0
  37. package/dist/core.d.ts +85 -0
  38. package/dist/editing.d.ts +7 -0
  39. package/dist/editing.js +191 -5
  40. package/dist/editing.test.d.ts +1 -0
  41. package/dist/editing.test.js +732 -0
  42. package/dist/editors/cell-editors.coverage.test.d.ts +1 -0
  43. package/dist/editors/cell-editors.coverage.test.js +139 -0
  44. package/dist/facet-buckets.test.d.ts +1 -0
  45. package/dist/facet-buckets.test.js +296 -0
  46. package/dist/filter-operators.test.d.ts +1 -0
  47. package/dist/filter-operators.test.js +135 -0
  48. package/dist/hyperformula-adapter.test.d.ts +1 -0
  49. package/dist/hyperformula-adapter.test.js +205 -0
  50. package/dist/index.d.ts +5 -2
  51. package/dist/index.js +4 -1
  52. package/dist/keyboard-handlers.coverage.test.d.ts +1 -0
  53. package/dist/keyboard-handlers.coverage.test.js +495 -0
  54. package/dist/keyboard-handlers.js +7 -2
  55. package/dist/menus.js +1 -0
  56. package/dist/menus.test.d.ts +1 -0
  57. package/dist/menus.test.js +560 -0
  58. package/dist/named-views.coverage.test.d.ts +1 -0
  59. package/dist/named-views.coverage.test.js +180 -0
  60. package/dist/row-drag.d.ts +49 -0
  61. package/dist/row-drag.js +221 -0
  62. package/dist/row-drag.test.d.ts +1 -0
  63. package/dist/row-drag.test.js +142 -0
  64. package/dist/row-resize.test.d.ts +1 -0
  65. package/dist/row-resize.test.js +329 -0
  66. package/dist/scroll-sync.js +3 -0
  67. package/dist/scroll-sync.test.d.ts +1 -0
  68. package/dist/scroll-sync.test.js +290 -0
  69. package/dist/selection.d.ts +7 -1
  70. package/dist/selection.js +76 -36
  71. package/dist/selection.multi-range.test.d.ts +1 -0
  72. package/dist/selection.multi-range.test.js +55 -0
  73. package/dist/selection.test.d.ts +1 -0
  74. package/dist/selection.test.js +647 -0
  75. package/dist/server-data-source.coverage.test.d.ts +1 -0
  76. package/dist/server-data-source.coverage.test.js +154 -0
  77. package/dist/spreadsheet.d.ts +30 -0
  78. package/dist/spreadsheet.js +48 -0
  79. package/dist/spreadsheet.test.d.ts +1 -0
  80. package/dist/spreadsheet.test.js +446 -0
  81. package/dist/sv-grid-scrollbar.js +13 -1
  82. package/dist/svgrid-wrapper.types.d.ts +19 -0
  83. package/dist/svgrid.behavior.test.js +20 -0
  84. package/dist/svgrid.interaction.test.js +31 -0
  85. package/dist/svgrid.new-features.wrapper.test.js +34 -2
  86. package/dist/test-setup.js +9 -3
  87. package/dist/virtualization/scroll-scaling.d.ts +17 -0
  88. package/dist/virtualization/scroll-scaling.js +35 -0
  89. package/dist/virtualization/scroll-scaling.test.js +42 -1
  90. package/package.json +2 -1
  91. package/src/GridMenus.svelte +205 -127
  92. package/src/SvGrid.controller.svelte.ts +2352 -2195
  93. package/src/SvGrid.css +2012 -1747
  94. package/src/SvGrid.svelte +2346 -2047
  95. package/src/SvGrid.types.ts +537 -456
  96. package/src/aligned-grids.test.ts +80 -0
  97. package/src/aligned-grids.ts +87 -0
  98. package/src/build-api.ts +683 -663
  99. package/src/clipboard.test.ts +49 -0
  100. package/src/clipboard.ts +51 -23
  101. package/src/column-groups.test.ts +59 -0
  102. package/src/column-groups.ts +80 -0
  103. package/src/column-types.test.ts +68 -0
  104. package/src/column-types.ts +82 -0
  105. package/src/core.ts +78 -0
  106. package/src/editing.ts +669 -513
  107. package/src/index.ts +12 -0
  108. package/src/menus.ts +1 -0
  109. package/src/row-drag.test.ts +168 -0
  110. package/src/row-drag.ts +255 -0
  111. package/src/scroll-sync.ts +2 -0
  112. package/src/selection.multi-range.test.ts +61 -0
  113. package/src/selection.ts +71 -37
  114. package/src/spreadsheet.test.ts +489 -445
  115. package/src/spreadsheet.ts +304 -246
  116. package/src/svgrid-wrapper.types.ts +19 -0
  117. package/src/svgrid.new-features.wrapper.test.ts +2 -2
@@ -1,246 +1,304 @@
1
- /**
2
- * Spreadsheet-style layout helpers — cell merging + per-cell borders.
3
- *
4
- * These are *layout-only* augmentations on top of `<SvGrid>`. They don't
5
- * change the grid's data model, sorting, or filtering — they just decorate
6
- * the rendered body cells. Bind the action to the wrapper around your
7
- * SvGrid and pass merge / border specs; the helper observes DOM mutations
8
- * and re-applies the layout whenever the grid re-renders.
9
- *
10
- * Limitations (worth knowing up front):
11
- * - Merges + borders index into the CURRENTLY-DISPLAYED rows (after
12
- * sort / filter), via the `data-svgrid-row` index the grid sets on
13
- * every body cell. If your data sorts or filters, recompute the
14
- * specs against the new display order.
15
- * - Merges use real `colspan` / `rowspan` plus `display:none` on
16
- * covered TDs. Column widths come from the inline styles SvGrid
17
- * emits on each TD; we don't fight those.
18
- * - For long row-merges across a virtualised window, only rows that
19
- * are actually rendered get the rowspan applied. Disable
20
- * virtualisation on grids that need a continuous merge.
21
- */
22
-
23
- /** A single edge of a cell border. */
24
- export type BorderSpec = {
25
- /** Thickness in pixels. Default 2. */
26
- width?: number
27
- /** CSS border-style. Default 'solid'. */
28
- style?: 'solid' | 'dashed' | 'dotted' | 'double'
29
- /** CSS color. Falls back to currentColor (i.e. text color). */
30
- color?: string
31
- }
32
-
33
- /** A merge declaration. The cell at (rowIndex, columnId) is the ORIGIN;
34
- * it spans `colspan` columns to the right + `rowspan` rows downward.
35
- * Covered cells are hidden so the origin visually fills the region. */
36
- export type MergeSpec = {
37
- /** Display-row index — the same value the grid puts on
38
- * `data-svgrid-row`. After sorting/filtering, recompute the spec
39
- * against the new display order. */
40
- rowIndex: number
41
- columnId: string
42
- /** Default 1. */
43
- rowspan?: number
44
- /** Default 1. */
45
- colspan?: number
46
- }
47
-
48
- /** Borders for one cell. Edges left unset render as the default
49
- * cell border (i.e. no override). */
50
- export type CellBorderSpec = {
51
- rowIndex: number
52
- columnId: string
53
- top?: BorderSpec
54
- right?: BorderSpec
55
- bottom?: BorderSpec
56
- left?: BorderSpec
57
- }
58
-
59
- /** What the Svelte action receives. Pass new values to update; pass
60
- * `null` / empty arrays to clear. */
61
- export type SpreadsheetActionOptions = {
62
- merges?: ReadonlyArray<MergeSpec> | null
63
- borders?: ReadonlyArray<CellBorderSpec> | null
64
- /** Column id order the grid uses, in left-to-right order. Required
65
- * to translate `colspan` into the right set of covered column ids.
66
- * Pass `columns.map((c) => c.id)` from the consumer. */
67
- columnOrder: ReadonlyArray<string>
68
- }
69
-
70
- const BORDER_KEYS = ['top', 'right', 'bottom', 'left'] as const
71
- type EdgeKey = (typeof BORDER_KEYS)[number]
72
- const MARK = 'data-svgrid-sheet'
73
-
74
- function borderCss(spec: BorderSpec | undefined): string | null {
75
- if (!spec) return null
76
- const w = spec.width ?? 2
77
- const s = spec.style ?? 'solid'
78
- const c = spec.color ?? 'currentColor'
79
- return `${w}px ${s} ${c}`
80
- }
81
-
82
- /** Look up a body cell by its display-row + column id. Falls back to
83
- * null if the cell isn't in the current render window (virtualisation,
84
- * scrolled out, or filtered away). */
85
- function findCell(
86
- root: HTMLElement,
87
- rowIndex: number,
88
- columnId: string,
89
- ): HTMLTableCellElement | null {
90
- return root.querySelector<HTMLTableCellElement>(
91
- `td[data-svgrid-row="${rowIndex}"][data-col-id="${CSS.escape(columnId)}"]`,
92
- )
93
- }
94
-
95
- const OVERLAY_CLASS = 'sv-cell-border-overlay'
96
-
97
- /** Apply / re-apply layout decorations. Called once on mount, again on
98
- * every relevant DOM mutation inside the grid, and whenever the action
99
- * options update. */
100
- function apply(root: HTMLElement, opts: SpreadsheetActionOptions): void {
101
- // ---- 1. Clean up anything the LAST run added -----------------------
102
- for (const td of root.querySelectorAll<HTMLTableCellElement>(`td[${MARK}]`)) {
103
- td.removeAttribute('colspan')
104
- td.removeAttribute('rowspan')
105
- if (td.style.display === 'none') td.style.display = ''
106
- // Remove the overlay child we previously injected for borders.
107
- const overlay = td.querySelector(`:scope > .${OVERLAY_CLASS}`)
108
- if (overlay) overlay.remove()
109
- td.classList.remove('sv-merge-edge-right', 'sv-merge-edge-bottom', 'sv-merge-in-range')
110
- td.removeAttribute(MARK)
111
- }
112
-
113
- const colOrder = opts.columnOrder
114
- const colIndexOf = new Map<string, number>()
115
- for (let i = 0; i < colOrder.length; i += 1) colIndexOf.set(colOrder[i]!, i)
116
-
117
- // ---- 2. Merges -----------------------------------------------------
118
- for (const m of opts.merges ?? []) {
119
- const startCol = colIndexOf.get(m.columnId)
120
- if (startCol === undefined) continue
121
- const rs = Math.max(1, m.rowspan ?? 1)
122
- const cs = Math.max(1, m.colspan ?? 1)
123
- const origin = findCell(root, m.rowIndex, m.columnId)
124
- if (!origin) continue
125
- if (cs > 1) origin.setAttribute('colspan', String(cs))
126
- if (rs > 1) origin.setAttribute('rowspan', String(rs))
127
- origin.setAttribute(MARK, '')
128
- for (let dr = 0; dr < rs; dr += 1) {
129
- for (let dc = 0; dc < cs; dc += 1) {
130
- if (dr === 0 && dc === 0) continue
131
- const colId = colOrder[startCol + dc]
132
- if (!colId) continue
133
- const td = findCell(root, m.rowIndex + dr, colId)
134
- if (!td) continue
135
- td.style.display = 'none'
136
- td.setAttribute(MARK, '')
137
- }
138
- }
139
-
140
- // Selection-edge inheritance:
141
- // The grid sets `data-range-*` per cell. The merge's RIGHTMOST /
142
- // BOTTOMMOST covered cells are `display:none`, so the borders
143
- // they would draw never render. Mirror those edge flags onto the
144
- // origin via dedicated CSS classes (so we can toggle them
145
- // independently of Svelte's own data-range-* updates without a
146
- // ping-pong loop).
147
- const lastColId = colOrder[startCol + cs - 1]
148
- const rightCell = lastColId ? findCell(root, m.rowIndex, lastColId) : null
149
- const bottomCell = findCell(root, m.rowIndex + rs - 1, m.columnId)
150
- const farCell = lastColId ? findCell(root, m.rowIndex + rs - 1, lastColId) : null
151
-
152
- const wantRight =
153
- rightCell?.getAttribute('data-range-right') === 'true' ||
154
- farCell ?.getAttribute('data-range-right') === 'true'
155
- const wantBottom =
156
- bottomCell?.getAttribute('data-range-bottom') === 'true' ||
157
- farCell ?.getAttribute('data-range-bottom') === 'true'
158
- const inRange =
159
- rightCell ?.getAttribute('data-selected-range') === 'true' ||
160
- bottomCell?.getAttribute('data-selected-range') === 'true' ||
161
- farCell ?.getAttribute('data-selected-range') === 'true' ||
162
- origin.getAttribute('data-selected-range') === 'true'
163
-
164
- origin.classList.toggle('sv-merge-edge-right', wantRight)
165
- origin.classList.toggle('sv-merge-edge-bottom', wantBottom)
166
- origin.classList.toggle('sv-merge-in-range', inRange)
167
- }
168
-
169
- // ---- 3. Borders ---------------------------------------------------
170
- // Use an absolute-positioned overlay div so each edge renders
171
- // independently of the grid's own border-collapse rules. Adjacent
172
- // TDs no longer "eat" the right / bottom edges of a bordered cell.
173
- for (const b of opts.borders ?? []) {
174
- const td = findCell(root, b.rowIndex, b.columnId)
175
- if (!td) continue
176
- let any = false
177
- const overlay = document.createElement('div')
178
- overlay.className = OVERLAY_CLASS
179
- overlay.style.cssText =
180
- 'position:absolute;inset:0;pointer-events:none;box-sizing:border-box;z-index:1;'
181
- for (const e of BORDER_KEYS) {
182
- const css = borderCss(b[e as EdgeKey])
183
- if (!css) continue
184
- overlay.style.setProperty(`border-${e}`, css)
185
- any = true
186
- }
187
- if (!any) continue
188
- // Ensure the TD is a positioning context for the overlay.
189
- if (getComputedStyle(td).position === 'static') td.style.position = 'relative'
190
- td.appendChild(overlay)
191
- td.setAttribute(MARK, '')
192
- }
193
- }
194
-
195
- /** Svelte action. Attach to the element that hosts your `<SvGrid>` so
196
- * the action can watch its DOM for re-renders.
197
- *
198
- * ```svelte
199
- * <div use:spreadsheetLayout={{ merges, borders, columnOrder }}>
200
- * <SvGrid {data} {columns} ... />
201
- * </div>
202
- * ```
203
- *
204
- * The action re-applies the layout whenever the grid's body mutates
205
- * (new rows, column reorder, virtualization scroll) and whenever the
206
- * options change. */
207
- export function spreadsheetLayout(node: HTMLElement, opts: SpreadsheetActionOptions) {
208
- let current = opts
209
- let frame = 0
210
- // The MutationObserver fires for EVERY DOM change inside the grid -
211
- // batch them into one rAF so a big virtualization scroll doesn't run
212
- // apply() dozens of times in a tick.
213
- function schedule() {
214
- if (frame) return
215
- frame = requestAnimationFrame(() => {
216
- frame = 0
217
- apply(node, current)
218
- })
219
- }
220
- const observer = new MutationObserver(schedule)
221
- observer.observe(node, {
222
- childList: true,
223
- subtree: true,
224
- attributes: true,
225
- attributeFilter: [
226
- 'data-svgrid-row', 'data-col-id', 'style',
227
- // Watch selection-range attrs so we can transfer them from
228
- // hidden covered cells to merge origins.
229
- 'data-range-top', 'data-range-bottom', 'data-range-left',
230
- 'data-range-right', 'data-selected-range',
231
- ],
232
- })
233
- // First-paint pass: schedule the same way so we don't run before the
234
- // grid's initial render landed.
235
- schedule()
236
- return {
237
- update(next: SpreadsheetActionOptions) {
238
- current = next
239
- schedule()
240
- },
241
- destroy() {
242
- observer.disconnect()
243
- if (frame) cancelAnimationFrame(frame)
244
- },
245
- }
246
- }
1
+ /**
2
+ * Spreadsheet-style layout helpers — cell merging + per-cell borders.
3
+ *
4
+ * These are *layout-only* augmentations on top of `<SvGrid>`. They don't
5
+ * change the grid's data model, sorting, or filtering — they just decorate
6
+ * the rendered body cells. Bind the action to the wrapper around your
7
+ * SvGrid and pass merge / border specs; the helper observes DOM mutations
8
+ * and re-applies the layout whenever the grid re-renders.
9
+ *
10
+ * Limitations (worth knowing up front):
11
+ * - Merges + borders index into the CURRENTLY-DISPLAYED rows (after
12
+ * sort / filter), via the `data-svgrid-row` index the grid sets on
13
+ * every body cell. If your data sorts or filters, recompute the
14
+ * specs against the new display order.
15
+ * - Merges use real `colspan` / `rowspan` plus `display:none` on
16
+ * covered TDs. Column widths come from the inline styles SvGrid
17
+ * emits on each TD; we don't fight those.
18
+ * - For long row-merges across a virtualised window, only rows that
19
+ * are actually rendered get the rowspan applied. Disable
20
+ * virtualisation on grids that need a continuous merge.
21
+ */
22
+
23
+ /** A single edge of a cell border. */
24
+ export type BorderSpec = {
25
+ /** Thickness in pixels. Default 2. */
26
+ width?: number
27
+ /** CSS border-style. Default 'solid'. */
28
+ style?: 'solid' | 'dashed' | 'dotted' | 'double'
29
+ /** CSS color. Falls back to currentColor (i.e. text color). */
30
+ color?: string
31
+ }
32
+
33
+ /** A merge declaration. The cell at (rowIndex, columnId) is the ORIGIN;
34
+ * it spans `colspan` columns to the right + `rowspan` rows downward.
35
+ * Covered cells are hidden so the origin visually fills the region. */
36
+ export type MergeSpec = {
37
+ /** Display-row index — the same value the grid puts on
38
+ * `data-svgrid-row`. After sorting/filtering, recompute the spec
39
+ * against the new display order. */
40
+ rowIndex: number
41
+ columnId: string
42
+ /** Default 1. */
43
+ rowspan?: number
44
+ /** Default 1. */
45
+ colspan?: number
46
+ }
47
+
48
+ /** A column with declarative spanning callbacks, as accepted by
49
+ * `spansToMerges`. Matches the relevant slice of `ColumnDef`. */
50
+ export type SpanColumn<TData = Record<string, unknown>> = {
51
+ id: string
52
+ field?: string
53
+ colSpan?: (params: { data: TData; rowIndex: number; columnId: string; value: unknown }) => number
54
+ rowSpan?: (params: { data: TData; rowIndex: number; columnId: string; value: unknown }) => number
55
+ }
56
+
57
+ /**
58
+ * Turn declarative per-column `colSpan` / `rowSpan` callbacks into a
59
+ * `MergeSpec[]` you can hand to `spreadsheetLayout` - so value-driven,
60
+ * AG-Grid-style spanning runs on the SAME real colspan/rowspan merge engine
61
+ * instead of a second code path. Recompute after sort/filter (indexes are
62
+ * display-row indexes). A common pattern is "merge runs of equal values":
63
+ *
64
+ * { field: 'region', rowSpan: ({ data, rowIndex }) =>
65
+ * rows.filter((r, i) => i >= rowIndex && r.region === data.region &&
66
+ * (i === rowIndex || rows[i-1].region === data.region)).length }
67
+ */
68
+ export function spansToMerges<TData = Record<string, unknown>>(
69
+ rows: ReadonlyArray<TData>,
70
+ columns: ReadonlyArray<SpanColumn<TData>>,
71
+ getValue?: (row: TData, columnId: string) => unknown,
72
+ ): MergeSpec[] {
73
+ const merges: MergeSpec[] = []
74
+ const covered = new Set<string>()
75
+ for (let r = 0; r < rows.length; r += 1) {
76
+ const row = rows[r]!
77
+ for (let ci = 0; ci < columns.length; ci += 1) {
78
+ const col = columns[ci]!
79
+ if (!col.colSpan && !col.rowSpan) continue
80
+ const key = `${r}:${ci}`
81
+ if (covered.has(key)) continue
82
+ const value = getValue
83
+ ? getValue(row, col.id)
84
+ : (row as Record<string, unknown>)[col.field ?? col.id]
85
+ const params = { data: row, rowIndex: r, columnId: col.id, value }
86
+ const cs = Math.max(1, Math.floor(col.colSpan?.(params) ?? 1))
87
+ const rs = Math.max(1, Math.floor(col.rowSpan?.(params) ?? 1))
88
+ if (cs <= 1 && rs <= 1) continue
89
+ merges.push({
90
+ rowIndex: r,
91
+ columnId: col.id,
92
+ colspan: cs > 1 ? cs : undefined,
93
+ rowspan: rs > 1 ? rs : undefined,
94
+ })
95
+ for (let dr = 0; dr < rs; dr += 1) {
96
+ for (let dc = 0; dc < cs; dc += 1) {
97
+ if (dr === 0 && dc === 0) continue
98
+ covered.add(`${r + dr}:${ci + dc}`)
99
+ }
100
+ }
101
+ }
102
+ }
103
+ return merges
104
+ }
105
+
106
+ /** Borders for one cell. Edges left unset render as the default
107
+ * cell border (i.e. no override). */
108
+ export type CellBorderSpec = {
109
+ rowIndex: number
110
+ columnId: string
111
+ top?: BorderSpec
112
+ right?: BorderSpec
113
+ bottom?: BorderSpec
114
+ left?: BorderSpec
115
+ }
116
+
117
+ /** What the Svelte action receives. Pass new values to update; pass
118
+ * `null` / empty arrays to clear. */
119
+ export type SpreadsheetActionOptions = {
120
+ merges?: ReadonlyArray<MergeSpec> | null
121
+ borders?: ReadonlyArray<CellBorderSpec> | null
122
+ /** Column id order the grid uses, in left-to-right order. Required
123
+ * to translate `colspan` into the right set of covered column ids.
124
+ * Pass `columns.map((c) => c.id)` from the consumer. */
125
+ columnOrder: ReadonlyArray<string>
126
+ }
127
+
128
+ const BORDER_KEYS = ['top', 'right', 'bottom', 'left'] as const
129
+ type EdgeKey = (typeof BORDER_KEYS)[number]
130
+ const MARK = 'data-svgrid-sheet'
131
+
132
+ function borderCss(spec: BorderSpec | undefined): string | null {
133
+ if (!spec) return null
134
+ const w = spec.width ?? 2
135
+ const s = spec.style ?? 'solid'
136
+ const c = spec.color ?? 'currentColor'
137
+ return `${w}px ${s} ${c}`
138
+ }
139
+
140
+ /** Look up a body cell by its display-row + column id. Falls back to
141
+ * null if the cell isn't in the current render window (virtualisation,
142
+ * scrolled out, or filtered away). */
143
+ function findCell(
144
+ root: HTMLElement,
145
+ rowIndex: number,
146
+ columnId: string,
147
+ ): HTMLTableCellElement | null {
148
+ return root.querySelector<HTMLTableCellElement>(
149
+ `td[data-svgrid-row="${rowIndex}"][data-col-id="${CSS.escape(columnId)}"]`,
150
+ )
151
+ }
152
+
153
+ const OVERLAY_CLASS = 'sv-cell-border-overlay'
154
+
155
+ /** Apply / re-apply layout decorations. Called once on mount, again on
156
+ * every relevant DOM mutation inside the grid, and whenever the action
157
+ * options update. */
158
+ function apply(root: HTMLElement, opts: SpreadsheetActionOptions): void {
159
+ // ---- 1. Clean up anything the LAST run added -----------------------
160
+ for (const td of root.querySelectorAll<HTMLTableCellElement>(`td[${MARK}]`)) {
161
+ td.removeAttribute('colspan')
162
+ td.removeAttribute('rowspan')
163
+ if (td.style.display === 'none') td.style.display = ''
164
+ // Remove the overlay child we previously injected for borders.
165
+ const overlay = td.querySelector(`:scope > .${OVERLAY_CLASS}`)
166
+ if (overlay) overlay.remove()
167
+ td.classList.remove('sv-merge-edge-right', 'sv-merge-edge-bottom', 'sv-merge-in-range')
168
+ td.removeAttribute(MARK)
169
+ }
170
+
171
+ const colOrder = opts.columnOrder
172
+ const colIndexOf = new Map<string, number>()
173
+ for (let i = 0; i < colOrder.length; i += 1) colIndexOf.set(colOrder[i]!, i)
174
+
175
+ // ---- 2. Merges -----------------------------------------------------
176
+ for (const m of opts.merges ?? []) {
177
+ const startCol = colIndexOf.get(m.columnId)
178
+ if (startCol === undefined) continue
179
+ const rs = Math.max(1, m.rowspan ?? 1)
180
+ const cs = Math.max(1, m.colspan ?? 1)
181
+ const origin = findCell(root, m.rowIndex, m.columnId)
182
+ if (!origin) continue
183
+ if (cs > 1) origin.setAttribute('colspan', String(cs))
184
+ if (rs > 1) origin.setAttribute('rowspan', String(rs))
185
+ origin.setAttribute(MARK, '')
186
+ for (let dr = 0; dr < rs; dr += 1) {
187
+ for (let dc = 0; dc < cs; dc += 1) {
188
+ if (dr === 0 && dc === 0) continue
189
+ const colId = colOrder[startCol + dc]
190
+ if (!colId) continue
191
+ const td = findCell(root, m.rowIndex + dr, colId)
192
+ if (!td) continue
193
+ td.style.display = 'none'
194
+ td.setAttribute(MARK, '')
195
+ }
196
+ }
197
+
198
+ // Selection-edge inheritance:
199
+ // The grid sets `data-range-*` per cell. The merge's RIGHTMOST /
200
+ // BOTTOMMOST covered cells are `display:none`, so the borders
201
+ // they would draw never render. Mirror those edge flags onto the
202
+ // origin via dedicated CSS classes (so we can toggle them
203
+ // independently of Svelte's own data-range-* updates without a
204
+ // ping-pong loop).
205
+ const lastColId = colOrder[startCol + cs - 1]
206
+ const rightCell = lastColId ? findCell(root, m.rowIndex, lastColId) : null
207
+ const bottomCell = findCell(root, m.rowIndex + rs - 1, m.columnId)
208
+ const farCell = lastColId ? findCell(root, m.rowIndex + rs - 1, lastColId) : null
209
+
210
+ const wantRight =
211
+ rightCell?.getAttribute('data-range-right') === 'true' ||
212
+ farCell ?.getAttribute('data-range-right') === 'true'
213
+ const wantBottom =
214
+ bottomCell?.getAttribute('data-range-bottom') === 'true' ||
215
+ farCell ?.getAttribute('data-range-bottom') === 'true'
216
+ const inRange =
217
+ rightCell ?.getAttribute('data-selected-range') === 'true' ||
218
+ bottomCell?.getAttribute('data-selected-range') === 'true' ||
219
+ farCell ?.getAttribute('data-selected-range') === 'true' ||
220
+ origin.getAttribute('data-selected-range') === 'true'
221
+
222
+ origin.classList.toggle('sv-merge-edge-right', wantRight)
223
+ origin.classList.toggle('sv-merge-edge-bottom', wantBottom)
224
+ origin.classList.toggle('sv-merge-in-range', inRange)
225
+ }
226
+
227
+ // ---- 3. Borders ---------------------------------------------------
228
+ // Use an absolute-positioned overlay div so each edge renders
229
+ // independently of the grid's own border-collapse rules. Adjacent
230
+ // TDs no longer "eat" the right / bottom edges of a bordered cell.
231
+ for (const b of opts.borders ?? []) {
232
+ const td = findCell(root, b.rowIndex, b.columnId)
233
+ if (!td) continue
234
+ let any = false
235
+ const overlay = document.createElement('div')
236
+ overlay.className = OVERLAY_CLASS
237
+ overlay.style.cssText =
238
+ 'position:absolute;inset:0;pointer-events:none;box-sizing:border-box;z-index:1;'
239
+ for (const e of BORDER_KEYS) {
240
+ const css = borderCss(b[e as EdgeKey])
241
+ if (!css) continue
242
+ overlay.style.setProperty(`border-${e}`, css)
243
+ any = true
244
+ }
245
+ if (!any) continue
246
+ // Ensure the TD is a positioning context for the overlay.
247
+ if (getComputedStyle(td).position === 'static') td.style.position = 'relative'
248
+ td.appendChild(overlay)
249
+ td.setAttribute(MARK, '')
250
+ }
251
+ }
252
+
253
+ /** Svelte action. Attach to the element that hosts your `<SvGrid>` so
254
+ * the action can watch its DOM for re-renders.
255
+ *
256
+ * ```svelte
257
+ * <div use:spreadsheetLayout={{ merges, borders, columnOrder }}>
258
+ * <SvGrid {data} {columns} ... />
259
+ * </div>
260
+ * ```
261
+ *
262
+ * The action re-applies the layout whenever the grid's body mutates
263
+ * (new rows, column reorder, virtualization scroll) and whenever the
264
+ * options change. */
265
+ export function spreadsheetLayout(node: HTMLElement, opts: SpreadsheetActionOptions) {
266
+ let current = opts
267
+ let frame = 0
268
+ // The MutationObserver fires for EVERY DOM change inside the grid -
269
+ // batch them into one rAF so a big virtualization scroll doesn't run
270
+ // apply() dozens of times in a tick.
271
+ function schedule() {
272
+ if (frame) return
273
+ frame = requestAnimationFrame(() => {
274
+ frame = 0
275
+ apply(node, current)
276
+ })
277
+ }
278
+ const observer = new MutationObserver(schedule)
279
+ observer.observe(node, {
280
+ childList: true,
281
+ subtree: true,
282
+ attributes: true,
283
+ attributeFilter: [
284
+ 'data-svgrid-row', 'data-col-id', 'style',
285
+ // Watch selection-range attrs so we can transfer them from
286
+ // hidden covered cells to merge origins.
287
+ 'data-range-top', 'data-range-bottom', 'data-range-left',
288
+ 'data-range-right', 'data-selected-range',
289
+ ],
290
+ })
291
+ // First-paint pass: schedule the same way so we don't run before the
292
+ // grid's initial render landed.
293
+ schedule()
294
+ return {
295
+ update(next: SpreadsheetActionOptions) {
296
+ current = next
297
+ schedule()
298
+ },
299
+ destroy() {
300
+ observer.disconnect()
301
+ if (frame) cancelAnimationFrame(frame)
302
+ },
303
+ }
304
+ }
@@ -64,6 +64,16 @@ export type SvGridApi<
64
64
  getCellValue(rowIndex: number, columnId: string): unknown
65
65
  /** Write a cell value through the column's field. */
66
66
  setCellValue(rowIndex: number, columnId: string, value: unknown): void
67
+ /**
68
+ * Programmatically begin editing a cell (as a double-click would). Returns
69
+ * `true` if editing started (cell exists, editable, editing enabled).
70
+ */
71
+ startEditing(rowIndex: number, columnId: string): boolean
72
+ /**
73
+ * Commit (default) or, with `cancel: true`, discard the active edit.
74
+ * Returns `true` if there was an edit in progress.
75
+ */
76
+ stopEditing(cancel?: boolean): boolean
67
77
 
68
78
  // ----- Cell selection -----
69
79
  /**
@@ -130,6 +140,15 @@ export type SvGridApi<
130
140
  value?: string
131
141
  /** Upper bound for the `between` operator. Required when `operator === 'between'`. */
132
142
  valueTo?: string
143
+ /**
144
+ * Optional SECOND condition on the same column, joined by `join`
145
+ * (multi-condition filtering, e.g. "> 100 AND < 500").
146
+ */
147
+ operator2?: SvGridFilterOperator
148
+ value2?: string
149
+ valueTo2?: string
150
+ /** How to combine the two conditions. Defaults to `'AND'`. */
151
+ join?: 'AND' | 'OR'
133
152
  }
134
153
  | null,
135
154
  ): void
@@ -70,7 +70,7 @@ describe('SvGrid wrapper - cellClass + rowClass', () => {
70
70
  it('computes the row-level class once per render row and threads it onto the <tr>', () => {
71
71
  expect(source).toMatch(/function computeRowClass/)
72
72
  expect(source).toMatch(/userRowClass = computeRowClass\(row, rowIndex\)/)
73
- expect(source).toMatch(/class=\{`sv-grid-row \$\{userRowClass\}`\}/)
73
+ expect(source).toMatch(/class=\{`sv-grid-row \$\{userRowClass\}/)
74
74
  })
75
75
 
76
76
  it('computes the cell-level class per column and threads it onto the <td>', () => {
@@ -137,7 +137,7 @@ describe('SvGrid wrapper - between filter operator', () => {
137
137
  })
138
138
 
139
139
  it('forwards valueTo through applyExcelFilter', () => {
140
- expect(source).toMatch(/valueTo: filter\.operator === "between" \? filter\.valueTo : undefined/)
140
+ expect(source).toMatch(/valueTo:\s*(filter\.operator|op) === "between" \? (filter\.valueTo|valueTo) : undefined/)
141
141
  })
142
142
 
143
143
  it('publishes valueTo in the onFiltersChange payload only for between clauses', () => {