@svgrid/grid 1.1.1 → 1.2.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 (188) hide show
  1. package/dist/FlexRender.svelte +96 -96
  2. package/dist/SvGrid.controller.svelte.js +17 -6
  3. package/dist/SvGrid.css +2012 -2012
  4. package/dist/SvGrid.svelte +2571 -2346
  5. package/dist/SvGridDropdown.svelte +7 -3
  6. package/dist/build-api.js +2 -2
  7. package/dist/cdn/svgrid.js +13504 -0
  8. package/dist/cdn/svgrid.svelte-external.js +11188 -0
  9. package/dist/cell-values.d.ts +1 -1
  10. package/dist/cell-values.js +7 -7
  11. package/dist/column-types.js +1 -1
  12. package/dist/core.d.ts +1 -1
  13. package/dist/core.js +2 -2
  14. package/dist/summaries.js +4 -4
  15. package/package.json +12 -2
  16. package/src/FlexRender.svelte +96 -96
  17. package/src/SvGrid.controller.svelte.ts +2363 -2352
  18. package/src/SvGrid.css +2012 -2012
  19. package/src/SvGrid.svelte +2571 -2346
  20. package/src/SvGrid.types.ts +537 -537
  21. package/src/SvGridDropdown.svelte +7 -3
  22. package/src/a11y.contract.test.ts +49 -49
  23. package/src/a11y.test.ts +59 -59
  24. package/src/a11y.ts +59 -59
  25. package/src/build-api.ts +683 -683
  26. package/src/cell-formatting.ts +169 -169
  27. package/src/cell-values.ts +4 -4
  28. package/src/column-types.ts +1 -1
  29. package/src/core.performance.test.ts +30 -30
  30. package/src/core.ts +1077 -1077
  31. package/src/createGrid.svelte.ts +42 -42
  32. package/src/createGrid.test.ts +10 -10
  33. package/src/createGridState.svelte.ts +17 -17
  34. package/src/editing.ts +669 -669
  35. package/src/flex-render.ts +3 -3
  36. package/src/index.ts +208 -208
  37. package/src/keyboard.test.ts +59 -59
  38. package/src/keyboard.ts +97 -97
  39. package/src/merge-objects.ts +48 -48
  40. package/src/render-component.ts +28 -28
  41. package/src/spreadsheet.test.ts +489 -489
  42. package/src/spreadsheet.ts +304 -304
  43. package/src/static-functions.ts +11 -11
  44. package/src/subscribe.ts +38 -38
  45. package/src/summaries.ts +4 -4
  46. package/src/svgrid-wrapper.types.ts +412 -412
  47. package/src/svgrid.features.test.ts +157 -157
  48. package/src/svgrid.wrapper.test.ts +40 -40
  49. package/src/virtualization/column-virtualizer.test.ts +27 -27
  50. package/src/virtualization/column-virtualizer.ts +30 -30
  51. package/src/virtualization/svelte-virtualizer.svelte.ts +26 -26
  52. package/src/virtualization/types.ts +30 -30
  53. package/src/virtualization/virtualizer.test.ts +47 -47
  54. package/src/virtualization/virtualizer.ts +296 -296
  55. package/dist/SvGrid.helpers.test.d.ts +0 -1
  56. package/dist/SvGrid.helpers.test.js +0 -298
  57. package/dist/SvGridChart.test.d.ts +0 -1
  58. package/dist/SvGridChart.test.js +0 -62
  59. package/dist/a11y.contract.test.d.ts +0 -1
  60. package/dist/a11y.contract.test.js +0 -39
  61. package/dist/a11y.test.d.ts +0 -1
  62. package/dist/a11y.test.js +0 -44
  63. package/dist/aligned-grids.test.d.ts +0 -1
  64. package/dist/aligned-grids.test.js +0 -75
  65. package/dist/build-api.coverage.test.d.ts +0 -20
  66. package/dist/build-api.coverage.test.js +0 -505
  67. package/dist/cell-formatting.test.d.ts +0 -1
  68. package/dist/cell-formatting.test.js +0 -234
  69. package/dist/cell-render.test.d.ts +0 -1
  70. package/dist/cell-render.test.js +0 -338
  71. package/dist/chart-export.test.d.ts +0 -1
  72. package/dist/chart-export.test.js +0 -302
  73. package/dist/chart.coverage.test.d.ts +0 -1
  74. package/dist/chart.coverage.test.js +0 -748
  75. package/dist/chart.test.d.ts +0 -1
  76. package/dist/chart.test.js +0 -289
  77. package/dist/clipboard.test.d.ts +0 -1
  78. package/dist/clipboard.test.js +0 -700
  79. package/dist/collaboration.coverage.test.d.ts +0 -1
  80. package/dist/collaboration.coverage.test.js +0 -200
  81. package/dist/collaboration.test.d.ts +0 -1
  82. package/dist/collaboration.test.js +0 -65
  83. package/dist/column-groups.test.d.ts +0 -1
  84. package/dist/column-groups.test.js +0 -56
  85. package/dist/column-types.test.d.ts +0 -1
  86. package/dist/column-types.test.js +0 -62
  87. package/dist/columns.test.d.ts +0 -1
  88. package/dist/columns.test.js +0 -625
  89. package/dist/conditional-formatting.test.d.ts +0 -1
  90. package/dist/conditional-formatting.test.js +0 -87
  91. package/dist/core.coverage.test.d.ts +0 -1
  92. package/dist/core.coverage.test.js +0 -186
  93. package/dist/core.performance.test.d.ts +0 -1
  94. package/dist/core.performance.test.js +0 -29
  95. package/dist/createGrid.test.d.ts +0 -1
  96. package/dist/createGrid.test.js +0 -9
  97. package/dist/editing.test.d.ts +0 -1
  98. package/dist/editing.test.js +0 -732
  99. package/dist/editors/cell-editors.coverage.test.d.ts +0 -1
  100. package/dist/editors/cell-editors.coverage.test.js +0 -139
  101. package/dist/editors/cell-editors.test.d.ts +0 -1
  102. package/dist/editors/cell-editors.test.js +0 -75
  103. package/dist/facet-buckets.test.d.ts +0 -1
  104. package/dist/facet-buckets.test.js +0 -296
  105. package/dist/fill-patterns.test.d.ts +0 -1
  106. package/dist/fill-patterns.test.js +0 -81
  107. package/dist/filter-operators.test.d.ts +0 -1
  108. package/dist/filter-operators.test.js +0 -135
  109. package/dist/filtering/excel-filters.test.d.ts +0 -1
  110. package/dist/filtering/excel-filters.test.js +0 -116
  111. package/dist/filtering/locale-filter.test.d.ts +0 -13
  112. package/dist/filtering/locale-filter.test.js +0 -189
  113. package/dist/flex-render.test.d.ts +0 -1
  114. package/dist/flex-render.test.js +0 -142
  115. package/dist/group-aggregate.test.d.ts +0 -1
  116. package/dist/group-aggregate.test.js +0 -32
  117. package/dist/hyperformula-adapter.test.d.ts +0 -1
  118. package/dist/hyperformula-adapter.test.js +0 -205
  119. package/dist/keyboard-handlers.coverage.test.d.ts +0 -1
  120. package/dist/keyboard-handlers.coverage.test.js +0 -495
  121. package/dist/keyboard.test.d.ts +0 -1
  122. package/dist/keyboard.test.js +0 -27
  123. package/dist/menus.test.d.ts +0 -1
  124. package/dist/menus.test.js +0 -560
  125. package/dist/named-views.coverage.test.d.ts +0 -1
  126. package/dist/named-views.coverage.test.js +0 -180
  127. package/dist/named-views.test.d.ts +0 -1
  128. package/dist/named-views.test.js +0 -57
  129. package/dist/new-features.test.d.ts +0 -1
  130. package/dist/new-features.test.js +0 -183
  131. package/dist/render-component.test.d.ts +0 -1
  132. package/dist/render-component.test.js +0 -41
  133. package/dist/row-drag.test.d.ts +0 -1
  134. package/dist/row-drag.test.js +0 -142
  135. package/dist/row-resize.test.d.ts +0 -1
  136. package/dist/row-resize.test.js +0 -329
  137. package/dist/scroll-sync.test.d.ts +0 -1
  138. package/dist/scroll-sync.test.js +0 -290
  139. package/dist/selection.multi-range.test.d.ts +0 -1
  140. package/dist/selection.multi-range.test.js +0 -55
  141. package/dist/selection.test.d.ts +0 -1
  142. package/dist/selection.test.js +0 -647
  143. package/dist/server-data-source.coverage.test.d.ts +0 -1
  144. package/dist/server-data-source.coverage.test.js +0 -154
  145. package/dist/server-data-source.test.d.ts +0 -1
  146. package/dist/server-data-source.test.js +0 -81
  147. package/dist/sparkline.test.d.ts +0 -1
  148. package/dist/sparkline.test.js +0 -52
  149. package/dist/spreadsheet.test.d.ts +0 -1
  150. package/dist/spreadsheet.test.js +0 -446
  151. package/dist/subscribe.test.d.ts +0 -1
  152. package/dist/subscribe.test.js +0 -93
  153. package/dist/svgrid.api-extensions.test.d.ts +0 -14
  154. package/dist/svgrid.api-extensions.test.js +0 -334
  155. package/dist/svgrid.api.test.d.ts +0 -15
  156. package/dist/svgrid.api.test.js +0 -169
  157. package/dist/svgrid.behavior.test.d.ts +0 -15
  158. package/dist/svgrid.behavior.test.js +0 -625
  159. package/dist/svgrid.column-reorder.test.d.ts +0 -15
  160. package/dist/svgrid.column-reorder.test.js +0 -224
  161. package/dist/svgrid.comments-autocomplete.test.d.ts +0 -1
  162. package/dist/svgrid.comments-autocomplete.test.js +0 -96
  163. package/dist/svgrid.context-menu.test.d.ts +0 -1
  164. package/dist/svgrid.context-menu.test.js +0 -102
  165. package/dist/svgrid.features.test.d.ts +0 -1
  166. package/dist/svgrid.features.test.js +0 -129
  167. package/dist/svgrid.interaction.test.d.ts +0 -9
  168. package/dist/svgrid.interaction.test.js +0 -349
  169. package/dist/svgrid.locale-filtering.test.d.ts +0 -15
  170. package/dist/svgrid.locale-filtering.test.js +0 -261
  171. package/dist/svgrid.new-features.wrapper.test.d.ts +0 -1
  172. package/dist/svgrid.new-features.wrapper.test.js +0 -194
  173. package/dist/svgrid.row-pinning.test.d.ts +0 -14
  174. package/dist/svgrid.row-pinning.test.js +0 -250
  175. package/dist/svgrid.set-filter.test.d.ts +0 -17
  176. package/dist/svgrid.set-filter.test.js +0 -268
  177. package/dist/svgrid.wrapper.test.d.ts +0 -1
  178. package/dist/svgrid.wrapper.test.js +0 -59
  179. package/dist/test-setup.d.ts +0 -1
  180. package/dist/test-setup.js +0 -35
  181. package/dist/transaction.test.d.ts +0 -1
  182. package/dist/transaction.test.js +0 -89
  183. package/dist/virtualization/column-virtualizer.test.d.ts +0 -1
  184. package/dist/virtualization/column-virtualizer.test.js +0 -25
  185. package/dist/virtualization/scroll-scaling.test.d.ts +0 -1
  186. package/dist/virtualization/scroll-scaling.test.js +0 -127
  187. package/dist/virtualization/virtualizer.test.d.ts +0 -1
  188. package/dist/virtualization/virtualizer.test.js +0 -41
@@ -1,304 +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
- /** 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
- }
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
+ }
@@ -1,11 +1,11 @@
1
- export {
2
- createCoreRowModel,
3
- createExpandedRowModel,
4
- createFilteredRowModel,
5
- createGroupedRowModel,
6
- createPaginatedRowModel,
7
- createSortedRowModel,
8
- filterFns,
9
- sortFns,
10
- tableFeatures,
11
- } from './core'
1
+ export {
2
+ createCoreRowModel,
3
+ createExpandedRowModel,
4
+ createFilteredRowModel,
5
+ createGroupedRowModel,
6
+ createPaginatedRowModel,
7
+ createSortedRowModel,
8
+ filterFns,
9
+ sortFns,
10
+ tableFeatures,
11
+ } from './core'