@svgrid/grid 2.6.17 → 2.6.19

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 (253) hide show
  1. package/CHANGELOG.md +346 -346
  2. package/README.md +199 -199
  3. package/dist/FlexRender.svelte +96 -96
  4. package/dist/GridFooter.svelte +181 -181
  5. package/dist/GridMenus.svelte +705 -705
  6. package/dist/SvAutoComplete.svelte +165 -165
  7. package/dist/SvAvatar.svelte +75 -75
  8. package/dist/SvCalendar.svelte +503 -503
  9. package/dist/SvCarousel.svelte +141 -141
  10. package/dist/SvCheckBox.svelte +102 -102
  11. package/dist/SvCircularProgress.svelte +109 -109
  12. package/dist/SvColorInput.svelte +181 -181
  13. package/dist/SvComboBox.svelte +275 -275
  14. package/dist/SvContextMenu.svelte +116 -116
  15. package/dist/SvCountryInput.svelte +163 -163
  16. package/dist/SvDrawer.svelte +254 -254
  17. package/dist/SvDropDownList.svelte +374 -374
  18. package/dist/SvDurationInput.svelte +126 -126
  19. package/dist/SvField.svelte +293 -293
  20. package/dist/SvForm.svelte +437 -437
  21. package/dist/SvGrid.css +2896 -2896
  22. package/dist/SvGrid.svelte +2956 -2956
  23. package/dist/SvGridCellEditor.svelte +662 -662
  24. package/dist/SvGridChart.svelte +1716 -1716
  25. package/dist/SvGridChartPanel.svelte +485 -485
  26. package/dist/SvGridChartView.svelte +70 -70
  27. package/dist/SvGridDropdown.svelte +728 -728
  28. package/dist/SvGridSelect.svelte +266 -266
  29. package/dist/SvGroupCell.svelte +116 -116
  30. package/dist/SvListBox.svelte +326 -326
  31. package/dist/SvMaskedInput.svelte +122 -122
  32. package/dist/SvMenu.svelte +124 -124
  33. package/dist/SvMenuList.svelte +146 -146
  34. package/dist/SvMultiSelect.svelte +289 -289
  35. package/dist/SvNumberInput.svelte +168 -168
  36. package/dist/SvOtpInput.svelte +158 -158
  37. package/dist/SvPasswordInput.svelte +151 -151
  38. package/dist/SvPhoneInput.svelte +133 -133
  39. package/dist/SvPopover.svelte +197 -197
  40. package/dist/SvProgress.svelte +116 -116
  41. package/dist/SvRadioGroup.svelte +107 -107
  42. package/dist/SvRating.svelte +112 -112
  43. package/dist/SvResult.svelte +73 -73
  44. package/dist/SvRichText.svelte +211 -211
  45. package/dist/SvRowGroupPanel.svelte +170 -170
  46. package/dist/SvScrollArea.svelte +61 -61
  47. package/dist/SvSlider.svelte +203 -203
  48. package/dist/SvSwitchButton.svelte +108 -108
  49. package/dist/SvTagsInput.svelte +115 -115
  50. package/dist/SvTextInput.svelte +147 -147
  51. package/dist/SvTimePicker.svelte +245 -245
  52. package/dist/SvToaster.svelte +159 -159
  53. package/dist/SvToggleButton.svelte +85 -85
  54. package/dist/SvTooltip.svelte +161 -161
  55. package/dist/SvTour.svelte +208 -208
  56. package/dist/SvTree.svelte +444 -444
  57. package/dist/SvTreeSelect.svelte +235 -235
  58. package/dist/cdn/{GridMenus-3kKYmYOE.js → GridMenus-B0F9iBrG.js} +2 -2
  59. package/dist/cdn/{GridMenus-BcDiwQ9U.js → GridMenus-IHK_l7m6.js} +2 -2
  60. package/dist/cdn/{SvDateTimePicker-DSUhIta8.js → SvDateTimePicker-CHnUkWcH.js} +2 -2
  61. package/dist/cdn/{SvDateTimePicker-h9kPyszT.js → SvDateTimePicker-CRQH_U7E.js} +2 -2
  62. package/dist/cdn/{SvGridCellEditor-DkyQO6FV.js → SvGridCellEditor-BGUCzuPB.js} +1 -1
  63. package/dist/cdn/{SvGridCellEditor-JpJSRhDx.js → SvGridCellEditor-G8IMWIws.js} +1 -1
  64. package/dist/cdn/{SvGridChart-CwhFz7GV.js → SvGridChart-BEJmNNx9.js} +1 -1
  65. package/dist/cdn/{SvGridChart-Bs2GIR2Q.js → SvGridChart-BwVos976.js} +1 -1
  66. package/dist/cdn/{SvGridChartPanel-1WXuStzM.js → SvGridChartPanel-BOknOkrP.js} +1 -1
  67. package/dist/cdn/{SvGridChartPanel-e5_nqNP9.js → SvGridChartPanel-D2PjII4O.js} +1 -1
  68. package/dist/cdn/{SvGridChartView-SmPW10dI.js → SvGridChartView-00LPUHL1.js} +1 -1
  69. package/dist/cdn/{SvGridChartView-eSPuJE6g.js → SvGridChartView-BhUEJ5ki.js} +1 -1
  70. package/dist/cdn/{SvGridDropdown-B1ZcLpgs.js → SvGridDropdown-D0VdjeR8.js} +1 -1
  71. package/dist/cdn/{SvGridDropdown-CtdbHcIS.js → SvGridDropdown-D13MtJ2j.js} +1 -1
  72. package/dist/cdn/{src-DMZZVVFd.js → src-B1TdiyS8.js} +26 -26
  73. package/dist/cdn/{src-D79V6bCA.js → src-Cd0tearp.js} +27 -27
  74. package/dist/cdn/svgrid.js +5 -5
  75. package/dist/cdn/svgrid.svelte-external.js +5 -5
  76. package/dist/chart-export.js +8 -8
  77. package/package.json +11 -11
  78. package/src/FlexRender.svelte +96 -96
  79. package/src/GridFooter.svelte +181 -181
  80. package/src/GridMenus.svelte +705 -705
  81. package/src/SvAutoComplete.svelte +165 -165
  82. package/src/SvAvatar.svelte +75 -75
  83. package/src/SvCalendar.svelte +503 -503
  84. package/src/SvCalendar.test.ts +226 -226
  85. package/src/SvCarousel.svelte +141 -141
  86. package/src/SvCheckBox.svelte +102 -102
  87. package/src/SvCircularProgress.svelte +109 -109
  88. package/src/SvColorInput.svelte +181 -181
  89. package/src/SvComboBox.svelte +275 -275
  90. package/src/SvContextMenu.svelte +116 -116
  91. package/src/SvCountryInput.svelte +163 -163
  92. package/src/SvDrawer.svelte +254 -254
  93. package/src/SvDropDownList.svelte +374 -374
  94. package/src/SvDurationInput.svelte +126 -126
  95. package/src/SvField.svelte +293 -293
  96. package/src/SvForm.svelte +437 -437
  97. package/src/SvForm.test.ts +411 -411
  98. package/src/SvGrid.controller.svelte.ts +3974 -3974
  99. package/src/SvGrid.css +2896 -2896
  100. package/src/SvGrid.svelte +2956 -2956
  101. package/src/SvGrid.types.ts +1790 -1790
  102. package/src/SvGridCellEditor.svelte +662 -662
  103. package/src/SvGridChart.svelte +1716 -1716
  104. package/src/SvGridChartPanel.svelte +485 -485
  105. package/src/SvGridChartView.svelte +70 -70
  106. package/src/SvGridDropdown.svelte +728 -728
  107. package/src/SvGridSelect.svelte +266 -266
  108. package/src/SvGroupCell.svelte +116 -116
  109. package/src/SvListBox.svelte +326 -326
  110. package/src/SvMaskedInput.svelte +122 -122
  111. package/src/SvMenu.svelte +124 -124
  112. package/src/SvMenu.test.ts +97 -97
  113. package/src/SvMenuList.svelte +146 -146
  114. package/src/SvMultiSelect.svelte +289 -289
  115. package/src/SvNumberInput.svelte +168 -168
  116. package/src/SvOtpInput.svelte +158 -158
  117. package/src/SvPasswordInput.svelte +151 -151
  118. package/src/SvPhoneInput.svelte +133 -133
  119. package/src/SvPopover.svelte +197 -197
  120. package/src/SvProgress.svelte +116 -116
  121. package/src/SvRadioGroup.svelte +107 -107
  122. package/src/SvRating.svelte +112 -112
  123. package/src/SvResult.svelte +73 -73
  124. package/src/SvRichText.svelte +211 -211
  125. package/src/SvRowGroupPanel.svelte +170 -170
  126. package/src/SvScrollArea.svelte +61 -61
  127. package/src/SvSlider.svelte +203 -203
  128. package/src/SvSwitchButton.svelte +108 -108
  129. package/src/SvTagsInput.svelte +115 -115
  130. package/src/SvTextInput.svelte +147 -147
  131. package/src/SvTimePicker.svelte +245 -245
  132. package/src/SvToaster.svelte +159 -159
  133. package/src/SvToaster.test.ts +95 -95
  134. package/src/SvToggleButton.svelte +85 -85
  135. package/src/SvTooltip.svelte +161 -161
  136. package/src/SvTour.svelte +208 -208
  137. package/src/SvTree.svelte +444 -444
  138. package/src/SvTreeSelect.svelte +235 -235
  139. package/src/a11y/dismissable.test.ts +119 -119
  140. package/src/a11y/dismissable.ts +114 -114
  141. package/src/a11y.contract.test.ts +49 -49
  142. package/src/a11y.test.ts +59 -59
  143. package/src/a11y.ts +61 -61
  144. package/src/ai.test.ts +502 -502
  145. package/src/ai.ts +1391 -1391
  146. package/src/build-api.coverage.test.ts +633 -633
  147. package/src/build-api.ts +846 -846
  148. package/src/builtin-editors.grid.test.ts +83 -83
  149. package/src/cell-formatting.ts +169 -169
  150. package/src/cell-render.test.ts +513 -513
  151. package/src/cell-render.ts +496 -496
  152. package/src/cell-values.ts +118 -118
  153. package/src/chart-export.ts +201 -201
  154. package/src/chart-view.svelte.ts +36 -36
  155. package/src/chart.ts +2295 -2295
  156. package/src/collaboration.test.ts +104 -104
  157. package/src/collaboration.ts +167 -167
  158. package/src/core.performance.test.ts +30 -30
  159. package/src/core.ts +1261 -1261
  160. package/src/createAutocomplete.svelte.ts +132 -132
  161. package/src/createCombobox.svelte.ts +191 -191
  162. package/src/createCountryInput.svelte.ts +157 -157
  163. package/src/createDropdownList.svelte.ts +168 -168
  164. package/src/createForm.svelte.ts +386 -386
  165. package/src/createGrid.svelte.ts +42 -42
  166. package/src/createGrid.test.ts +10 -10
  167. package/src/createGridState.svelte.ts +17 -17
  168. package/src/createListbox.svelte.ts +250 -250
  169. package/src/createMenu.svelte.ts +224 -224
  170. package/src/createPopoverSelect.svelte.ts +213 -213
  171. package/src/createSlider.svelte.ts +191 -191
  172. package/src/createTooltip.svelte.ts +144 -144
  173. package/src/createTree.svelte.ts +319 -319
  174. package/src/editing.test.ts +949 -949
  175. package/src/editing.ts +606 -606
  176. package/src/editor-contract.ts +170 -170
  177. package/src/editor-registry.grid.test.ts +144 -144
  178. package/src/editor-registry.ts +122 -122
  179. package/src/export-data-api.test.ts +126 -126
  180. package/src/export-format.test.ts +107 -107
  181. package/src/export-format.ts +601 -601
  182. package/src/filter-operators.ts +160 -160
  183. package/src/flex-render.ts +3 -3
  184. package/src/form-field.ts +127 -127
  185. package/src/group-display.test.ts +167 -167
  186. package/src/group-display.ts +200 -200
  187. package/src/headless.ts +87 -87
  188. package/src/index.ts +754 -754
  189. package/src/js-scroller.svelte.ts +173 -173
  190. package/src/keyboard-handlers.ts +270 -270
  191. package/src/keyboard.test.ts +59 -59
  192. package/src/keyboard.ts +97 -97
  193. package/src/list-nav.test.ts +49 -49
  194. package/src/list-nav.ts +29 -29
  195. package/src/list-option.test.ts +56 -56
  196. package/src/list-option.ts +172 -172
  197. package/src/menus.ts +567 -567
  198. package/src/merge-objects.ts +48 -48
  199. package/src/overlays.test.ts +90 -90
  200. package/src/render-component.ts +28 -28
  201. package/src/row-drag-touch.ts +211 -211
  202. package/src/row-drag.test.ts +353 -353
  203. package/src/row-drag.ts +415 -415
  204. package/src/row-resize.ts +210 -210
  205. package/src/scheduler-model.test.ts +562 -562
  206. package/src/scheduler-model.ts +872 -872
  207. package/src/selection.test.ts +754 -754
  208. package/src/selection.ts +491 -491
  209. package/src/server-data-source.test.ts +383 -383
  210. package/src/server-data-source.ts +469 -469
  211. package/src/sparkline.test.ts +68 -68
  212. package/src/sparkline.ts +169 -169
  213. package/src/spreadsheet.test.ts +488 -488
  214. package/src/spreadsheet.ts +312 -312
  215. package/src/static-functions.ts +11 -11
  216. package/src/subscribe.ts +38 -38
  217. package/src/svgrid-wrapper.types.ts +558 -558
  218. package/src/svgrid.async-editor-options.test.ts +273 -273
  219. package/src/svgrid.auto-row-height.test.ts +204 -204
  220. package/src/svgrid.behavior.test.ts +910 -910
  221. package/src/svgrid.charting.test.ts +534 -534
  222. package/src/svgrid.comments-autocomplete.test.ts +127 -127
  223. package/src/svgrid.context-menu.test.ts +147 -147
  224. package/src/svgrid.features.test.ts +157 -157
  225. package/src/svgrid.filter-depth.test.ts +163 -163
  226. package/src/svgrid.filter-menu-listbox.svelte.test.ts +331 -331
  227. package/src/svgrid.filter-menu-scroll.test.ts +112 -112
  228. package/src/svgrid.grand-total.test.ts +188 -188
  229. package/src/svgrid.group-display-mode.test.ts +171 -171
  230. package/src/svgrid.group-footers.test.ts +121 -121
  231. package/src/svgrid.group-pagination.test.ts +153 -153
  232. package/src/svgrid.new-features.wrapper.test.ts +251 -251
  233. package/src/svgrid.tree-data.test.ts +186 -186
  234. package/src/svgrid.wrapper.test.ts +63 -63
  235. package/src/svgriddropdown.async-panel.svelte.test.ts +195 -195
  236. package/src/test-setup.ts +62 -62
  237. package/src/themes/index.ts +288 -288
  238. package/src/toast-store.svelte.ts +246 -246
  239. package/src/toast-store.test.ts +147 -147
  240. package/src/tree-row-model.test.ts +168 -168
  241. package/src/ui-buttons.test.ts +144 -144
  242. package/src/ui-inputs.test.ts +118 -118
  243. package/src/ui-localization.test.ts +113 -113
  244. package/src/ui-range.test.ts +70 -70
  245. package/src/ui-selection.test.ts +155 -155
  246. package/src/ui-tier1.test.ts +142 -142
  247. package/src/virtual.test.ts +88 -88
  248. package/src/virtualization/column-virtualizer.test.ts +27 -27
  249. package/src/virtualization/column-virtualizer.ts +30 -30
  250. package/src/virtualization/svelte-virtualizer.svelte.ts +26 -26
  251. package/src/virtualization/types.ts +30 -30
  252. package/src/virtualization/virtualizer.test.ts +47 -47
  253. package/src/virtualization/virtualizer.ts +322 -322
@@ -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'