@svgrid/grid 2.2.27 → 2.2.28

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 (212) hide show
  1. package/README.md +199 -199
  2. package/dist/FlexRender.svelte +96 -96
  3. package/dist/GridFooter.svelte +179 -179
  4. package/dist/GridMenus.svelte +734 -734
  5. package/dist/SvAutoComplete.svelte +165 -165
  6. package/dist/SvCalendar.svelte +503 -503
  7. package/dist/SvCarousel.svelte +141 -141
  8. package/dist/SvCheckBox.svelte +101 -101
  9. package/dist/SvColorInput.svelte +181 -181
  10. package/dist/SvComboBox.svelte +275 -275
  11. package/dist/SvContextMenu.svelte +116 -116
  12. package/dist/SvCountryInput.svelte +160 -160
  13. package/dist/SvDrawer.svelte +254 -250
  14. package/dist/SvDropDownList.svelte +374 -374
  15. package/dist/SvDurationInput.svelte +126 -126
  16. package/dist/SvField.svelte +293 -293
  17. package/dist/SvForm.svelte +437 -437
  18. package/dist/SvGrid.css +2723 -2723
  19. package/dist/SvGrid.svelte +3333 -3333
  20. package/dist/SvGridChart.svelte +1724 -1724
  21. package/dist/SvGridChartPanel.svelte +485 -485
  22. package/dist/SvGridChartView.svelte +70 -70
  23. package/dist/SvGridDropdown.svelte +696 -696
  24. package/dist/SvGridSelect.svelte +259 -259
  25. package/dist/SvGroupCell.svelte +109 -109
  26. package/dist/SvListBox.svelte +287 -287
  27. package/dist/SvMaskedInput.svelte +122 -122
  28. package/dist/SvMenu.svelte +124 -124
  29. package/dist/SvMenuList.svelte +146 -146
  30. package/dist/SvMultiSelect.svelte +281 -281
  31. package/dist/SvNumberInput.svelte +168 -168
  32. package/dist/SvOtpInput.svelte +158 -158
  33. package/dist/SvPasswordInput.svelte +151 -151
  34. package/dist/SvPhoneInput.svelte +133 -131
  35. package/dist/SvPopover.svelte +197 -197
  36. package/dist/SvRadioGroup.svelte +107 -107
  37. package/dist/SvRowGroupPanel.svelte +170 -170
  38. package/dist/SvScrollArea.svelte +61 -61
  39. package/dist/SvSlider.svelte +200 -200
  40. package/dist/SvSwitchButton.svelte +107 -107
  41. package/dist/SvTagsInput.svelte +112 -112
  42. package/dist/SvTextInput.svelte +147 -147
  43. package/dist/SvTimePicker.svelte +245 -245
  44. package/dist/SvToaster.svelte +159 -159
  45. package/dist/SvToggleButton.svelte +85 -85
  46. package/dist/SvTooltip.svelte +161 -161
  47. package/dist/SvTour.svelte +204 -204
  48. package/dist/SvTree.svelte +437 -437
  49. package/dist/SvTreeSelect.svelte +233 -233
  50. package/dist/cdn/{GridMenus-BzxEYNtW.js → GridMenus-BbzEvTYO.js} +2 -2
  51. package/dist/cdn/{GridMenus-Dr-nGEXn.js → GridMenus-E220X2kM.js} +2 -2
  52. package/dist/cdn/{SvDateTimePicker-B1sDc9Pz.js → SvDateTimePicker-B8GopjhC.js} +2 -2
  53. package/dist/cdn/{SvDateTimePicker-Bh0FTs1E.js → SvDateTimePicker-DB0aIEk8.js} +2 -2
  54. package/dist/cdn/{SvGridChart-Bgk4hDs8.js → SvGridChart-BcLCYvw9.js} +1 -1
  55. package/dist/cdn/{SvGridChart-BKQsO5fZ.js → SvGridChart-BhnFdLd0.js} +1 -1
  56. package/dist/cdn/{SvGridChartPanel-DkCc2Z7b.js → SvGridChartPanel-Cmx9DHAS.js} +1 -1
  57. package/dist/cdn/{SvGridChartPanel-DSkHIQDd.js → SvGridChartPanel-DvjwxLvK.js} +1 -1
  58. package/dist/cdn/{SvGridChartView-BrbVaELm.js → SvGridChartView-B40DTJSX.js} +1 -1
  59. package/dist/cdn/{SvGridChartView-i9rWvSKg.js → SvGridChartView-PwqI4s02.js} +1 -1
  60. package/dist/cdn/{SvGridDropdown-D08sVmAy.js → SvGridDropdown-DjALc_4f.js} +1 -1
  61. package/dist/cdn/{SvGridDropdown-CGxxopQ4.js → SvGridDropdown-hpnHvOGt.js} +1 -1
  62. package/dist/cdn/{src-cgs1wcUS.js → src-BxNEslEo.js} +25 -25
  63. package/dist/cdn/{src-Cw8d9U8j.js → src-C4yKQZ5t.js} +26 -26
  64. package/dist/cdn/svgrid.js +5 -5
  65. package/dist/cdn/svgrid.svelte-external.js +5 -5
  66. package/dist/chart-export.js +8 -8
  67. package/package.json +10 -10
  68. package/src/FlexRender.svelte +96 -96
  69. package/src/GridFooter.svelte +179 -179
  70. package/src/GridMenus.svelte +734 -734
  71. package/src/SvAutoComplete.svelte +165 -165
  72. package/src/SvCalendar.svelte +503 -503
  73. package/src/SvCalendar.test.ts +226 -226
  74. package/src/SvCarousel.svelte +141 -141
  75. package/src/SvCheckBox.svelte +101 -101
  76. package/src/SvColorInput.svelte +181 -181
  77. package/src/SvComboBox.svelte +275 -275
  78. package/src/SvContextMenu.svelte +116 -116
  79. package/src/SvCountryInput.svelte +160 -160
  80. package/src/SvDrawer.svelte +254 -250
  81. package/src/SvDrawer.test.ts +18 -1
  82. package/src/SvDropDownList.svelte +374 -374
  83. package/src/SvDurationInput.svelte +126 -126
  84. package/src/SvField.svelte +293 -293
  85. package/src/SvForm.svelte +437 -437
  86. package/src/SvForm.test.ts +411 -411
  87. package/src/SvGrid.controller.svelte.ts +3239 -3239
  88. package/src/SvGrid.css +2723 -2723
  89. package/src/SvGrid.svelte +3333 -3333
  90. package/src/SvGrid.types.ts +1613 -1613
  91. package/src/SvGridChart.svelte +1724 -1724
  92. package/src/SvGridChartPanel.svelte +485 -485
  93. package/src/SvGridChartView.svelte +70 -70
  94. package/src/SvGridDropdown.svelte +696 -696
  95. package/src/SvGridSelect.svelte +259 -259
  96. package/src/SvGroupCell.svelte +109 -109
  97. package/src/SvListBox.svelte +287 -287
  98. package/src/SvMaskedInput.svelte +122 -122
  99. package/src/SvMenu.svelte +124 -124
  100. package/src/SvMenu.test.ts +97 -97
  101. package/src/SvMenuList.svelte +146 -146
  102. package/src/SvMultiSelect.svelte +281 -281
  103. package/src/SvNavPane.test.ts +15 -4
  104. package/src/SvNumberInput.svelte +168 -168
  105. package/src/SvOtpInput.svelte +158 -158
  106. package/src/SvPasswordInput.svelte +151 -151
  107. package/src/SvPhoneInput.svelte +133 -131
  108. package/src/SvPopover.svelte +197 -197
  109. package/src/SvRadioGroup.svelte +107 -107
  110. package/src/SvRowGroupPanel.svelte +170 -170
  111. package/src/SvScrollArea.svelte +61 -61
  112. package/src/SvSlider.svelte +200 -200
  113. package/src/SvSwitchButton.svelte +107 -107
  114. package/src/SvTagsInput.svelte +112 -112
  115. package/src/SvTextInput.svelte +147 -147
  116. package/src/SvTimePicker.svelte +245 -245
  117. package/src/SvToaster.svelte +159 -159
  118. package/src/SvToaster.test.ts +95 -95
  119. package/src/SvToggleButton.svelte +85 -85
  120. package/src/SvTooltip.svelte +161 -161
  121. package/src/SvTour.svelte +204 -204
  122. package/src/SvTree.svelte +437 -437
  123. package/src/SvTreeSelect.svelte +233 -233
  124. package/src/a11y/dismissable.test.ts +119 -119
  125. package/src/a11y/dismissable.ts +114 -114
  126. package/src/a11y.contract.test.ts +49 -49
  127. package/src/a11y.test.ts +59 -59
  128. package/src/a11y.ts +61 -61
  129. package/src/ai.test.ts +502 -502
  130. package/src/ai.ts +1391 -1391
  131. package/src/build-api.coverage.test.ts +633 -633
  132. package/src/build-api.ts +895 -895
  133. package/src/builtin-editors.grid.test.ts +85 -85
  134. package/src/cell-formatting.ts +169 -169
  135. package/src/cell-render.ts +469 -469
  136. package/src/chart-export.ts +201 -201
  137. package/src/chart-view.svelte.ts +36 -36
  138. package/src/chart.ts +2296 -2296
  139. package/src/collaboration.test.ts +104 -104
  140. package/src/collaboration.ts +167 -167
  141. package/src/core.performance.test.ts +30 -30
  142. package/src/core.ts +1111 -1111
  143. package/src/createAutocomplete.svelte.ts +132 -132
  144. package/src/createCombobox.svelte.ts +191 -191
  145. package/src/createCountryInput.svelte.ts +157 -157
  146. package/src/createDropdownList.svelte.ts +168 -168
  147. package/src/createForm.svelte.ts +386 -386
  148. package/src/createGrid.svelte.ts +42 -42
  149. package/src/createGrid.test.ts +10 -10
  150. package/src/createGridState.svelte.ts +17 -17
  151. package/src/createMenu.svelte.ts +225 -225
  152. package/src/createPopoverSelect.svelte.ts +213 -213
  153. package/src/createSlider.svelte.ts +191 -191
  154. package/src/createTooltip.svelte.ts +144 -144
  155. package/src/createTree.svelte.ts +319 -319
  156. package/src/editing.test.ts +859 -859
  157. package/src/editing.ts +675 -675
  158. package/src/editor-contract.ts +157 -157
  159. package/src/export-data-api.test.ts +126 -126
  160. package/src/export-format.test.ts +107 -107
  161. package/src/export-format.ts +598 -598
  162. package/src/filter-operators.ts +157 -157
  163. package/src/flex-render.ts +3 -3
  164. package/src/form-field.ts +127 -127
  165. package/src/index.ts +713 -713
  166. package/src/js-scroller.svelte.ts +173 -173
  167. package/src/keyboard.test.ts +59 -59
  168. package/src/keyboard.ts +97 -97
  169. package/src/list-nav.test.ts +49 -49
  170. package/src/list-nav.ts +29 -29
  171. package/src/list-option.test.ts +56 -56
  172. package/src/list-option.ts +172 -172
  173. package/src/menus.test.ts +700 -700
  174. package/src/menus.ts +652 -652
  175. package/src/merge-objects.ts +48 -48
  176. package/src/overlays.test.ts +90 -90
  177. package/src/render-component.ts +28 -28
  178. package/src/scheduler-model.test.ts +562 -562
  179. package/src/scheduler-model.ts +872 -872
  180. package/src/selection.test.ts +754 -754
  181. package/src/selection.ts +600 -600
  182. package/src/server-data-source.test.ts +289 -289
  183. package/src/server-data-source.ts +413 -413
  184. package/src/sparkline.test.ts +68 -68
  185. package/src/sparkline.ts +169 -169
  186. package/src/spreadsheet.test.ts +489 -489
  187. package/src/spreadsheet.ts +312 -312
  188. package/src/static-functions.ts +11 -11
  189. package/src/subscribe.ts +38 -38
  190. package/src/svgrid-wrapper.types.ts +524 -524
  191. package/src/svgrid.behavior.test.ts +706 -706
  192. package/src/svgrid.charting.test.ts +534 -534
  193. package/src/svgrid.features.test.ts +157 -157
  194. package/src/svgrid.new-features.wrapper.test.ts +251 -251
  195. package/src/svgrid.wrapper.test.ts +40 -40
  196. package/src/test-setup.ts +62 -62
  197. package/src/themes/index.ts +215 -215
  198. package/src/toast-store.svelte.ts +246 -246
  199. package/src/toast-store.test.ts +147 -147
  200. package/src/ui-buttons.test.ts +144 -144
  201. package/src/ui-inputs.test.ts +118 -118
  202. package/src/ui-range.test.ts +70 -70
  203. package/src/ui-selection.test.ts +155 -155
  204. package/src/ui-tier1.test.ts +142 -142
  205. package/src/virtual.test.ts +88 -88
  206. package/src/virtualization/column-virtualizer.test.ts +27 -27
  207. package/src/virtualization/column-virtualizer.ts +30 -30
  208. package/src/virtualization/svelte-virtualizer.svelte.ts +26 -26
  209. package/src/virtualization/types.ts +30 -30
  210. package/src/virtualization/virtualizer.test.ts +47 -47
  211. package/src/virtualization/virtualizer.ts +296 -296
  212. package/themes/ember.css +71 -71
@@ -1,312 +1,312 @@
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
- const OBSERVE_OPTIONS: MutationObserverInit = {
269
- childList: true,
270
- subtree: true,
271
- attributes: true,
272
- attributeFilter: [
273
- 'data-svgrid-row', 'data-col-id', 'style',
274
- // Watch selection-range attrs so we can transfer them from
275
- // hidden covered cells to merge origins.
276
- 'data-range-top', 'data-range-bottom', 'data-range-left',
277
- 'data-range-right', 'data-selected-range',
278
- ],
279
- }
280
- // The MutationObserver fires for EVERY DOM change inside the grid -
281
- // batch them into one rAF so a big virtualization scroll doesn't run
282
- // apply() dozens of times in a tick.
283
- function schedule() {
284
- if (frame) return
285
- frame = requestAnimationFrame(() => {
286
- frame = 0
287
- // Stop observing while apply() mutates the DOM itself (it writes cell
288
- // `style.display`/`position` and appends overlay children). Otherwise
289
- // those writes re-trigger this observer and loop at 60fps on merged
290
- // cells (#50). A full apply() recomputes from the live DOM, so discarding
291
- // the queued records here loses nothing.
292
- observer.disconnect()
293
- apply(node, current)
294
- observer.observe(node, OBSERVE_OPTIONS)
295
- })
296
- }
297
- const observer = new MutationObserver(schedule)
298
- observer.observe(node, OBSERVE_OPTIONS)
299
- // First-paint pass: schedule the same way so we don't run before the
300
- // grid's initial render landed.
301
- schedule()
302
- return {
303
- update(next: SpreadsheetActionOptions) {
304
- current = next
305
- schedule()
306
- },
307
- destroy() {
308
- observer.disconnect()
309
- if (frame) cancelAnimationFrame(frame)
310
- },
311
- }
312
- }
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
+ const OBSERVE_OPTIONS: MutationObserverInit = {
269
+ childList: true,
270
+ subtree: true,
271
+ attributes: true,
272
+ attributeFilter: [
273
+ 'data-svgrid-row', 'data-col-id', 'style',
274
+ // Watch selection-range attrs so we can transfer them from
275
+ // hidden covered cells to merge origins.
276
+ 'data-range-top', 'data-range-bottom', 'data-range-left',
277
+ 'data-range-right', 'data-selected-range',
278
+ ],
279
+ }
280
+ // The MutationObserver fires for EVERY DOM change inside the grid -
281
+ // batch them into one rAF so a big virtualization scroll doesn't run
282
+ // apply() dozens of times in a tick.
283
+ function schedule() {
284
+ if (frame) return
285
+ frame = requestAnimationFrame(() => {
286
+ frame = 0
287
+ // Stop observing while apply() mutates the DOM itself (it writes cell
288
+ // `style.display`/`position` and appends overlay children). Otherwise
289
+ // those writes re-trigger this observer and loop at 60fps on merged
290
+ // cells (#50). A full apply() recomputes from the live DOM, so discarding
291
+ // the queued records here loses nothing.
292
+ observer.disconnect()
293
+ apply(node, current)
294
+ observer.observe(node, OBSERVE_OPTIONS)
295
+ })
296
+ }
297
+ const observer = new MutationObserver(schedule)
298
+ observer.observe(node, OBSERVE_OPTIONS)
299
+ // First-paint pass: schedule the same way so we don't run before the
300
+ // grid's initial render landed.
301
+ schedule()
302
+ return {
303
+ update(next: SpreadsheetActionOptions) {
304
+ current = next
305
+ schedule()
306
+ },
307
+ destroy() {
308
+ observer.disconnect()
309
+ if (frame) cancelAnimationFrame(frame)
310
+ },
311
+ }
312
+ }
@@ -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'