@svgrid/grid 2.6.23 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (263) hide show
  1. package/CHANGELOG.md +88 -88
  2. package/README.md +199 -199
  3. package/dist/FlexRender.svelte +96 -96
  4. package/dist/GridFooter.svelte +181 -181
  5. package/dist/SvAutoComplete.svelte +169 -169
  6. package/dist/SvAvatar.svelte +75 -75
  7. package/dist/SvCalendar.svelte +503 -503
  8. package/dist/SvCarousel.svelte +141 -141
  9. package/dist/SvCheckBox.svelte +102 -102
  10. package/dist/SvCircularProgress.svelte +109 -109
  11. package/dist/SvColorInput.svelte +181 -181
  12. package/dist/SvComboBox.svelte +279 -279
  13. package/dist/SvContextMenu.svelte +116 -116
  14. package/dist/SvCountryInput.svelte +163 -163
  15. package/dist/SvDrawer.svelte +254 -254
  16. package/dist/SvDropDownList.svelte +378 -378
  17. package/dist/SvDurationInput.svelte +126 -126
  18. package/dist/SvField.svelte +293 -293
  19. package/dist/SvForm.svelte +437 -437
  20. package/dist/SvGridCellEditor.svelte +744 -744
  21. package/dist/SvGridChart.svelte +1716 -1716
  22. package/dist/SvGridChartPanel.svelte +485 -485
  23. package/dist/SvGridChartView.svelte +70 -70
  24. package/dist/SvGridDropdown.svelte +728 -728
  25. package/dist/SvGridSelect.svelte +270 -270
  26. package/dist/SvGroupCell.svelte +116 -116
  27. package/dist/SvListBox.svelte +334 -334
  28. package/dist/SvMaskedInput.svelte +122 -122
  29. package/dist/SvMenu.svelte +124 -124
  30. package/dist/SvMenuList.svelte +146 -146
  31. package/dist/SvMultiSelect.svelte +293 -293
  32. package/dist/SvNumberInput.svelte +172 -172
  33. package/dist/SvOtpInput.svelte +158 -158
  34. package/dist/SvPasswordInput.svelte +151 -151
  35. package/dist/SvPhoneInput.svelte +133 -133
  36. package/dist/SvPopover.svelte +197 -197
  37. package/dist/SvProgress.svelte +116 -116
  38. package/dist/SvRadioGroup.svelte +107 -107
  39. package/dist/SvRating.svelte +112 -112
  40. package/dist/SvResult.svelte +73 -73
  41. package/dist/SvRichText.svelte +211 -211
  42. package/dist/SvRowGroupPanel.svelte +170 -170
  43. package/dist/SvScrollArea.svelte +61 -61
  44. package/dist/SvSlider.svelte +203 -203
  45. package/dist/SvSwitchButton.svelte +108 -108
  46. package/dist/SvTagsInput.svelte +115 -115
  47. package/dist/SvTextInput.svelte +147 -147
  48. package/dist/SvTimePicker.svelte +245 -245
  49. package/dist/SvToaster.svelte +159 -159
  50. package/dist/SvToggleButton.svelte +85 -85
  51. package/dist/SvTooltip.svelte +161 -161
  52. package/dist/SvTour.svelte +208 -208
  53. package/dist/SvTree.svelte +444 -444
  54. package/dist/SvTreeSelect.svelte +239 -239
  55. package/dist/cdn/{GridMenus-BzWXQjv3.js → GridMenus-DMihUtma.js} +3 -3
  56. package/dist/cdn/{GridMenus-xr_rHx8F.js → GridMenus-nmNDj1a3.js} +3 -3
  57. package/dist/cdn/{SvDateRangeInput-DMLKmGEc.js → SvDateRangeInput-Bh0A0JkF.js} +1 -1
  58. package/dist/cdn/{SvDateRangeInput-CaOuMs8O.js → SvDateRangeInput-DflbiP7N.js} +1 -1
  59. package/dist/cdn/{SvDateTimePicker-sonaH0oh.js → SvDateTimePicker-BWwpfB_o.js} +1 -1
  60. package/dist/cdn/{SvDateTimePicker-CCbDZNZB.js → SvDateTimePicker-Bivn8dAP.js} +1 -1
  61. package/dist/cdn/{SvGridCellEditor-BAPSC7EL.js → SvGridCellEditor-AXL8cHGO.js} +1 -1
  62. package/dist/cdn/{SvGridCellEditor-BwzmUWtL.js → SvGridCellEditor-Ba7rY3eu.js} +1 -1
  63. package/dist/cdn/{SvGridChart-BwVos976.js → SvGridChart-Bs2GIR2Q.js} +1 -1
  64. package/dist/cdn/{SvGridChart-BEJmNNx9.js → SvGridChart-CwhFz7GV.js} +1 -1
  65. package/dist/cdn/{SvGridChartPanel-BOknOkrP.js → SvGridChartPanel-1WXuStzM.js} +1 -1
  66. package/dist/cdn/{SvGridChartPanel-D2PjII4O.js → SvGridChartPanel-e5_nqNP9.js} +1 -1
  67. package/dist/cdn/{SvGridChartView-00LPUHL1.js → SvGridChartView-SmPW10dI.js} +1 -1
  68. package/dist/cdn/{SvGridChartView-BhUEJ5ki.js → SvGridChartView-eSPuJE6g.js} +1 -1
  69. package/dist/cdn/{SvGridDropdown-D0VdjeR8.js → SvGridDropdown-B1ZcLpgs.js} +1 -1
  70. package/dist/cdn/{SvGridDropdown-D13MtJ2j.js → SvGridDropdown-CtdbHcIS.js} +1 -1
  71. package/dist/cdn/{date-format-BnnHlqGw.js → date-format-CcP1tafP.js} +2 -2
  72. package/dist/cdn/{date-format-BNii4zeD.js → date-format-DZT7T1wf.js} +2 -2
  73. package/dist/cdn/{row-drag-touch-Ddaa-QeB.js → row-drag-touch-CycRR65n.js} +12 -10
  74. package/dist/cdn/{src-skQN5eqh.js → src-B_YS5AOc.js} +45 -45
  75. package/dist/cdn/{src-DGo7IHug.js → src-DYXXpuSk.js} +44 -44
  76. package/dist/cdn/svgrid.js +7 -7
  77. package/dist/cdn/svgrid.svelte-external.js +7 -7
  78. package/dist/chart-export.js +8 -8
  79. package/dist/row-drag-touch.d.ts +5 -1
  80. package/dist/row-drag-touch.js +15 -4
  81. package/dist/row-drag.js +7 -3
  82. package/package.json +11 -11
  83. package/src/FlexRender.svelte +96 -96
  84. package/src/GridFooter.svelte +181 -181
  85. package/src/SvAutoComplete.svelte +169 -169
  86. package/src/SvAvatar.svelte +75 -75
  87. package/src/SvCalendar.svelte +503 -503
  88. package/src/SvCalendar.test.ts +226 -226
  89. package/src/SvCarousel.svelte +141 -141
  90. package/src/SvCheckBox.svelte +102 -102
  91. package/src/SvCircularProgress.svelte +109 -109
  92. package/src/SvColorInput.svelte +181 -181
  93. package/src/SvComboBox.svelte +279 -279
  94. package/src/SvContextMenu.svelte +116 -116
  95. package/src/SvCountryInput.svelte +163 -163
  96. package/src/SvDrawer.svelte +254 -254
  97. package/src/SvDropDownList.svelte +378 -378
  98. package/src/SvDurationInput.svelte +126 -126
  99. package/src/SvField.svelte +293 -293
  100. package/src/SvForm.svelte +437 -437
  101. package/src/SvForm.test.ts +411 -411
  102. package/src/SvGrid.types.ts +2092 -2092
  103. package/src/SvGridCellEditor.svelte +744 -744
  104. package/src/SvGridChart.svelte +1716 -1716
  105. package/src/SvGridChartPanel.svelte +485 -485
  106. package/src/SvGridChartView.svelte +70 -70
  107. package/src/SvGridDropdown.svelte +728 -728
  108. package/src/SvGridSelect.svelte +270 -270
  109. package/src/SvGroupCell.svelte +116 -116
  110. package/src/SvListBox.svelte +334 -334
  111. package/src/SvMaskedInput.svelte +122 -122
  112. package/src/SvMenu.svelte +124 -124
  113. package/src/SvMenu.test.ts +97 -97
  114. package/src/SvMenuList.svelte +146 -146
  115. package/src/SvMultiSelect.svelte +293 -293
  116. package/src/SvNumberInput.svelte +172 -172
  117. package/src/SvOtpInput.svelte +158 -158
  118. package/src/SvPasswordInput.svelte +151 -151
  119. package/src/SvPhoneInput.svelte +133 -133
  120. package/src/SvPopover.svelte +197 -197
  121. package/src/SvProgress.svelte +116 -116
  122. package/src/SvRadioGroup.svelte +107 -107
  123. package/src/SvRating.svelte +112 -112
  124. package/src/SvResult.svelte +73 -73
  125. package/src/SvRichText.svelte +211 -211
  126. package/src/SvRowGroupPanel.svelte +170 -170
  127. package/src/SvScrollArea.svelte +61 -61
  128. package/src/SvSlider.svelte +203 -203
  129. package/src/SvSwitchButton.svelte +108 -108
  130. package/src/SvTagsInput.svelte +115 -115
  131. package/src/SvTextInput.svelte +147 -147
  132. package/src/SvTimePicker.svelte +245 -245
  133. package/src/SvToaster.svelte +159 -159
  134. package/src/SvToaster.test.ts +95 -95
  135. package/src/SvToggleButton.svelte +85 -85
  136. package/src/SvTooltip.svelte +161 -161
  137. package/src/SvTour.svelte +208 -208
  138. package/src/SvTree.svelte +444 -444
  139. package/src/SvTreeSelect.svelte +239 -239
  140. package/src/a11y/dismissable.test.ts +119 -119
  141. package/src/a11y/dismissable.ts +114 -114
  142. package/src/a11y.contract.test.ts +49 -49
  143. package/src/a11y.test.ts +59 -59
  144. package/src/a11y.ts +61 -61
  145. package/src/ai.test.ts +502 -502
  146. package/src/ai.ts +1419 -1419
  147. package/src/build-api.coverage.test.ts +633 -633
  148. package/src/build-api.ts +846 -846
  149. package/src/builtin-editors.grid.test.ts +83 -83
  150. package/src/cell-formatting.ts +171 -171
  151. package/src/cell-render.test.ts +513 -513
  152. package/src/cell-render.ts +496 -496
  153. package/src/cell-values.ts +148 -148
  154. package/src/chart-export.ts +202 -202
  155. package/src/chart-view.svelte.ts +36 -36
  156. package/src/chart.ts +2321 -2321
  157. package/src/collaboration.test.ts +104 -104
  158. package/src/collaboration.ts +167 -167
  159. package/src/column-groups.ts +78 -78
  160. package/src/core.performance.test.ts +30 -30
  161. package/src/core.ts +1865 -1865
  162. package/src/createAutocomplete.svelte.ts +132 -132
  163. package/src/createCombobox.svelte.ts +191 -191
  164. package/src/createCountryInput.svelte.ts +157 -157
  165. package/src/createDropdownList.svelte.ts +168 -168
  166. package/src/createForm.svelte.ts +386 -386
  167. package/src/createGrid.svelte.ts +42 -42
  168. package/src/createGrid.test.ts +10 -10
  169. package/src/createGridState.svelte.ts +17 -17
  170. package/src/createListbox.svelte.ts +250 -250
  171. package/src/createMenu.svelte.ts +224 -224
  172. package/src/createPopoverSelect.svelte.ts +213 -213
  173. package/src/createSlider.svelte.ts +191 -191
  174. package/src/createTooltip.svelte.ts +144 -144
  175. package/src/createTree.svelte.ts +322 -322
  176. package/src/datetime/date-core.ts +206 -206
  177. package/src/datetime/date-restrict.ts +61 -61
  178. package/src/datetime/timezone.ts +135 -135
  179. package/src/dock-manager-model.ts +596 -596
  180. package/src/dock-model.ts +374 -374
  181. package/src/editing.test.ts +974 -974
  182. package/src/editing.ts +609 -609
  183. package/src/editor-contract.ts +171 -171
  184. package/src/editor-registry.grid.test.ts +144 -144
  185. package/src/editor-registry.ts +122 -122
  186. package/src/export-data-api.test.ts +126 -126
  187. package/src/export-format.test.ts +107 -107
  188. package/src/export-format.ts +601 -601
  189. package/src/filter-operators.ts +160 -160
  190. package/src/filtering/excel-filters.ts +325 -325
  191. package/src/flex-render.ts +3 -3
  192. package/src/form-field.ts +127 -127
  193. package/src/group-display.test.ts +167 -167
  194. package/src/group-display.ts +200 -200
  195. package/src/headless.ts +87 -87
  196. package/src/js-scroller.svelte.ts +173 -173
  197. package/src/keyboard-handlers.ts +270 -270
  198. package/src/keyboard.test.ts +59 -59
  199. package/src/keyboard.ts +97 -97
  200. package/src/list-nav.test.ts +49 -49
  201. package/src/list-nav.ts +29 -29
  202. package/src/list-option.test.ts +56 -56
  203. package/src/list-option.ts +179 -179
  204. package/src/menus.ts +597 -597
  205. package/src/merge-objects.ts +48 -48
  206. package/src/overlays.test.ts +90 -90
  207. package/src/positioning.ts +268 -268
  208. package/src/render-component.ts +28 -28
  209. package/src/row-drag-touch.ts +20 -5
  210. package/src/row-drag.test.ts +401 -353
  211. package/src/row-drag.ts +419 -415
  212. package/src/row-resize.test.ts +524 -524
  213. package/src/row-resize.ts +228 -228
  214. package/src/scheduler-ical.ts +181 -181
  215. package/src/scheduler-model.test.ts +562 -562
  216. package/src/scheduler-model.ts +873 -873
  217. package/src/selection.test.ts +885 -885
  218. package/src/server-data-source.test.ts +383 -383
  219. package/src/server-data-source.ts +469 -469
  220. package/src/sparkline.test.ts +68 -68
  221. package/src/sparkline.ts +169 -169
  222. package/src/spreadsheet.test.ts +488 -488
  223. package/src/spreadsheet.ts +312 -312
  224. package/src/static-functions.ts +11 -11
  225. package/src/subscribe.ts +38 -38
  226. package/src/summaries.ts +113 -113
  227. package/src/svgrid-wrapper.types.ts +563 -563
  228. package/src/svgrid.async-editor-options.test.ts +273 -273
  229. package/src/svgrid.auto-row-height.test.ts +204 -204
  230. package/src/svgrid.behavior.test.ts +910 -910
  231. package/src/svgrid.charting.test.ts +534 -534
  232. package/src/svgrid.comments-autocomplete.test.ts +127 -127
  233. package/src/svgrid.context-menu.test.ts +147 -147
  234. package/src/svgrid.features.test.ts +157 -157
  235. package/src/svgrid.filter-depth.test.ts +163 -163
  236. package/src/svgrid.filter-menu-listbox.svelte.test.ts +377 -377
  237. package/src/svgrid.filter-menu-scroll.test.ts +112 -112
  238. package/src/svgrid.grand-total.test.ts +188 -188
  239. package/src/svgrid.group-display-mode.test.ts +171 -171
  240. package/src/svgrid.group-footers.test.ts +121 -121
  241. package/src/svgrid.group-pagination.test.ts +153 -153
  242. package/src/svgrid.new-features.wrapper.test.ts +251 -251
  243. package/src/svgrid.tree-data.test.ts +186 -186
  244. package/src/svgrid.wrapper.test.ts +63 -63
  245. package/src/svgriddropdown.async-panel.svelte.test.ts +195 -195
  246. package/src/test-setup.ts +62 -62
  247. package/src/themes/index.ts +288 -288
  248. package/src/toast-store.svelte.ts +250 -250
  249. package/src/toast-store.test.ts +147 -147
  250. package/src/tree-row-model.test.ts +168 -168
  251. package/src/ui-buttons.test.ts +144 -144
  252. package/src/ui-inputs.test.ts +118 -118
  253. package/src/ui-localization.test.ts +113 -113
  254. package/src/ui-range.test.ts +70 -70
  255. package/src/ui-selection.test.ts +155 -155
  256. package/src/ui-tier1.test.ts +142 -142
  257. package/src/virtual.test.ts +88 -88
  258. package/src/virtualization/column-virtualizer.test.ts +27 -27
  259. package/src/virtualization/column-virtualizer.ts +30 -30
  260. package/src/virtualization/svelte-virtualizer.svelte.ts +26 -26
  261. package/src/virtualization/types.ts +30 -30
  262. package/src/virtualization/virtualizer.test.ts +47 -47
  263. package/src/virtualization/virtualizer.ts +322 -322
@@ -1,322 +1,322 @@
1
- /**
2
- * createTree - the HEADLESS core behind <SvTree>, in the same spirit as
3
- * `createSvGrid` for the grid: a runes-based state machine (expand/collapse,
4
- * single-select highlight, cascading tri-state checkboxes, full keyboard) with
5
- * **prop-getters** you spread onto YOUR OWN markup. The visible tree is
6
- * flattened into `rows` so roving-focus keyboard nav stays a flat index walk.
7
- *
8
- * ```svelte
9
- * <script lang="ts">
10
- * import { createTree } from '@svgrid/grid'
11
- * let selected = $state<string | null>(null)
12
- * const tree = createTree({ nodes: () => nodes, selected: () => selected, onSelect: (id) => (selected = id) })
13
- * </script>
14
- * <div {...tree.treeProps()}>
15
- * {#each tree.rows as row (row.node.id)}
16
- * <div {...tree.itemProps(row)}>{row.node.label}</div>
17
- * {/each}
18
- * </div>
19
- * ```
20
- *
21
- * The styled <SvTree> is just one renderer over this core. The cascade math
22
- * (`treeDescendantIds`, `treeCheckState`) is exported as pure functions.
23
- */
24
- export type TreeNode = {
25
- id: string
26
- label: string
27
- children?: TreeNode[]
28
- disabled?: boolean
29
- /** Marks a node whose children are loaded on demand (shows an expand arrow
30
- * even with no children yet; the renderer loads them on first expand). */
31
- lazy?: boolean
32
- }
33
-
34
- /** A node's checkbox state. `'indeterminate'` means some but not all descendants are checked. */
35
- export type CheckState = 'checked' | 'indeterminate' | 'unchecked'
36
-
37
- /** A single visible (flattened) tree row. */
38
- export type TreeRow = {
39
- node: TreeNode
40
- depth: number
41
- hasChildren: boolean
42
- open: boolean
43
- parentId: string | null
44
- index: number
45
- }
46
-
47
- /** All descendant ids of `node` (pure, depth-first). */
48
- export function treeDescendantIds(node: TreeNode): string[] {
49
- const ids: string[] = []
50
- const walk = (n: TreeNode) => { for (const c of n.children ?? []) { ids.push(c.id); walk(c) } }
51
- walk(node)
52
- return ids
53
- }
54
-
55
- /** Tri-state check status of `node` given the set of checked ids (pure). */
56
- export function treeCheckState(node: TreeNode, checked: ReadonlySet<string>): CheckState {
57
- if (!node.children?.length) return checked.has(node.id) ? 'checked' : 'unchecked'
58
- const desc = treeDescendantIds(node)
59
- const on = desc.filter((id) => checked.has(id)).length
60
- if (on === 0 && !checked.has(node.id)) return 'unchecked'
61
- if (on === desc.length) return 'checked'
62
- return 'indeterminate'
63
- }
64
-
65
- function findNode(list: ReadonlyArray<TreeNode>, id: string): TreeNode | null {
66
- for (const n of list) {
67
- if (n.id === id) return n
68
- if (n.children) { const f = findNode(n.children, id); if (f) return f }
69
- }
70
- return null
71
- }
72
-
73
- /** Where a dragged node lands relative to the drop target. */
74
- export type TreeDropPosition = 'before' | 'after' | 'inside'
75
-
76
- /** True if `id` is inside `node`'s subtree (used to block invalid drops). */
77
- export function treeContains(node: TreeNode, id: string): boolean {
78
- return node.children?.some((c) => c.id === id || treeContains(c, id)) ?? false
79
- }
80
-
81
- /**
82
- * Return a NEW node tree with `dragId` moved before/after/inside `targetId`
83
- * (pure - the caller sets it back as the controlled `nodes`). No-ops on invalid
84
- * moves (self, or into own descendant).
85
- */
86
- export function moveTreeNode(
87
- nodes: ReadonlyArray<TreeNode>,
88
- dragId: string,
89
- targetId: string,
90
- position: TreeDropPosition,
91
- ): TreeNode[] {
92
- if (dragId === targetId) return [...nodes]
93
- const dragged = findNode(nodes, dragId)
94
- if (!dragged) return [...nodes]
95
- if (dragId === targetId || treeContains(dragged, targetId)) return [...nodes]
96
-
97
- const without = (list: ReadonlyArray<TreeNode>): TreeNode[] => {
98
- const out: TreeNode[] = []
99
- for (const n of list) {
100
- if (n.id === dragId) continue
101
- out.push(n.children ? { ...n, children: without(n.children) } : n)
102
- }
103
- return out
104
- }
105
- const insert = (list: ReadonlyArray<TreeNode>): TreeNode[] => {
106
- const out: TreeNode[] = []
107
- for (const n of list) {
108
- if (n.id === targetId) {
109
- if (position === 'before') { out.push(dragged, n) }
110
- else if (position === 'after') { out.push(n, dragged) }
111
- else out.push({ ...n, children: [...(n.children ?? []), dragged] })
112
- } else if (n.children) {
113
- out.push({ ...n, children: insert(n.children) })
114
- } else out.push(n)
115
- }
116
- return out
117
- }
118
- return insert(without(nodes))
119
- }
120
-
121
- /** Sort siblings (recursively) by a comparator (pure). */
122
- export function sortTreeNodes(
123
- nodes: ReadonlyArray<TreeNode>,
124
- compare: (a: TreeNode, b: TreeNode) => number,
125
- ): TreeNode[] {
126
- return [...nodes]
127
- .sort(compare)
128
- .map((n) => (n.children ? { ...n, children: sortTreeNodes(n.children, compare) } : n))
129
- }
130
-
131
- /** Reactive inputs are passed as getters so the core tracks live prop changes. */
132
- export type TreeConfig = {
133
- nodes: () => ReadonlyArray<TreeNode>
134
- selected?: () => string | null
135
- onSelect?: (id: string) => void
136
- /** Seed the internally-managed expanded set (read once). */
137
- expandedIds?: () => string[] | undefined
138
- onToggle?: (id: string, expanded: boolean) => void
139
- checkable?: () => boolean
140
- checked?: () => string[]
141
- onCheck?: (ids: string[]) => void
142
- ariaLabel?: () => string | undefined
143
- /** Text direction; under `'rtl'` the Left/Right expand/collapse keys swap. */
144
- dir?: () => import('./editor-contract').EditorDir | undefined
145
- /** Filter query: show only matching nodes + their ancestors, auto-expanded. */
146
- filter?: () => string | undefined
147
- }
148
-
149
- /** Build the headless tree model: expansion, selection and checkbox cascading, with no markup. */
150
- export function createTree(config: TreeConfig) {
151
- const nodes = () => config.nodes()
152
- const checkable = () => config.checkable?.() ?? false
153
- const selected = () => config.selected?.() ?? null
154
-
155
- // Internal expanded set, seeded from the prop once (then self-managed).
156
- let expanded = $state<Set<string>>(new Set())
157
- let seeded = false
158
- $effect(() => {
159
- if (!seeded) { seeded = true; const ids = config.expandedIds?.(); if (ids) expanded = new Set(ids) }
160
- })
161
-
162
- // When filtering, precompute which nodes to show (a match, or an ancestor of a
163
- // match) and which to force-open so matches are revealed.
164
- const filterInfo = $derived.by(() => {
165
- const q = config.filter?.()?.trim().toLowerCase()
166
- if (!q) return null
167
- const visible = new Set<string>()
168
- const forceOpen = new Set<string>()
169
- const walk = (node: TreeNode): boolean => {
170
- let childMatch = false
171
- for (const c of node.children ?? []) childMatch = walk(c) || childMatch
172
- const selfMatch = node.label.toLowerCase().includes(q)
173
- if (selfMatch || childMatch) { visible.add(node.id); if (childMatch) forceOpen.add(node.id) }
174
- return selfMatch || childMatch
175
- }
176
- for (const n of nodes()) walk(n)
177
- return { visible, forceOpen }
178
- })
179
-
180
- const rows = $derived.by<TreeRow[]>(() => {
181
- const out: TreeRow[] = []
182
- const fi = filterInfo
183
- const walk = (list: ReadonlyArray<TreeNode>, depth: number, parentId: string | null) => {
184
- for (const node of list) {
185
- if (fi && !fi.visible.has(node.id)) continue
186
- const hasChildren = !!node.children?.length || !!node.lazy
187
- const open = fi ? fi.forceOpen.has(node.id) || expanded.has(node.id) : expanded.has(node.id)
188
- out.push({ node, depth, hasChildren, open, parentId, index: out.length })
189
- if (open && node.children?.length) walk(node.children, depth + 1, node.id)
190
- }
191
- }
192
- walk(nodes(), 0, null)
193
- return out
194
- })
195
-
196
- let active = $state(0)
197
- $effect(() => { if (active >= rows.length) active = Math.max(0, rows.length - 1) })
198
-
199
- const checkedSet = $derived(new Set(config.checked?.() ?? []))
200
-
201
- // Roving focus target; `focusTick` bumps only on keyboard moves.
202
- let focusTick = $state(0)
203
- function setActive(i: number, focus = false) { active = i; if (focus) focusTick++ }
204
-
205
- const checkStateOf = (node: TreeNode): CheckState => treeCheckState(node, checkedSet)
206
- const isExpanded = (id: string) => expanded.has(id)
207
- const isSelected = (id: string) => id === selected()
208
-
209
- function toggleExpand(node: TreeNode) {
210
- // Lazy nodes have no children *yet* - they must still be expandable so the
211
- // toggle fires onToggle and the host can fetch children on demand.
212
- if (!node.children?.length && !node.lazy) return
213
- const next = new Set(expanded)
214
- const willOpen = !next.has(node.id)
215
- willOpen ? next.add(node.id) : next.delete(node.id)
216
- expanded = next
217
- config.onToggle?.(node.id, willOpen)
218
- }
219
- const toggle = (id: string) => { const n = findNode(nodes(), id); if (n) toggleExpand(n) }
220
-
221
- function select(node: TreeNode) {
222
- if (node.disabled) return
223
- config.onSelect?.(node.id)
224
- }
225
- const selectId = (id: string) => { const n = findNode(nodes(), id); if (n) select(n) }
226
-
227
- function toggleCheck(node: TreeNode) {
228
- if (node.disabled) return
229
- const next = new Set(checkedSet)
230
- const ids = [node.id, ...treeDescendantIds(node)]
231
- const currentlyOn = checkStateOf(node) === 'checked'
232
- for (const id of ids) currentlyOn ? next.delete(id) : next.add(id)
233
- config.onCheck?.([...next])
234
- }
235
-
236
- // Step from `from` towards `dir` (+1/-1), skipping disabled rows, so roving
237
- // focus never lands on a node with zero semantic affordance for AT users.
238
- // Falls back to `from` if every row in that direction is disabled.
239
- function stepEnabled(from: number, dir: 1 | -1): number {
240
- let i = from
241
- while (i + dir >= 0 && i + dir <= rows.length - 1) {
242
- i += dir
243
- if (!rows[i]?.node.disabled) return i
244
- }
245
- return from
246
- }
247
-
248
- function onKeydown(e: KeyboardEvent) {
249
- const item = rows[active]
250
- if (!item) return
251
- // "expand" opens the node or steps into the first child; "collapse" closes it
252
- // or jumps to the parent. Under RTL the physical Left/Right keys are swapped.
253
- const expand = () => {
254
- if (item.hasChildren && !item.open) toggleExpand(item.node)
255
- else if (item.hasChildren && item.open) setActive(Math.min(active + 1, rows.length - 1), true)
256
- }
257
- const collapse = () => {
258
- if (item.hasChildren && item.open) toggleExpand(item.node)
259
- else if (item.parentId) { const pi = rows.findIndex((r) => r.node.id === item.parentId); if (pi >= 0) setActive(pi, true) }
260
- }
261
- const rtl = config.dir?.() === 'rtl'
262
- switch (e.key) {
263
- case 'ArrowDown': e.preventDefault(); setActive(stepEnabled(active, 1), true); break
264
- case 'ArrowUp': e.preventDefault(); setActive(stepEnabled(active, -1), true); break
265
- case 'ArrowRight': e.preventDefault(); (rtl ? collapse : expand)(); break
266
- case 'ArrowLeft': e.preventDefault(); (rtl ? expand : collapse)(); break
267
- case 'Enter': e.preventDefault(); select(item.node); break
268
- case ' ': e.preventDefault(); checkable() ? toggleCheck(item.node) : select(item.node); break
269
- case 'Home': e.preventDefault(); setActive(0, true); break
270
- case 'End': e.preventDefault(); setActive(rows.length - 1, true); break
271
- }
272
- }
273
-
274
- return {
275
- /** Internally-managed set of expanded node ids. */
276
- get expanded() { return expanded },
277
- /** Selected node id (single-select highlight). */
278
- get selected() { return selected() },
279
- /** Flattened list of visible rows. */
280
- get rows() { return rows },
281
- /** Roving-focus row index. */
282
- get activeIndex() { return active },
283
- /** Monotonic counter; changes only on keyboard navigation. */
284
- get focusTick() { return focusTick },
285
- isExpanded,
286
- isSelected,
287
- checkStateOf,
288
- toggle,
289
- toggleExpand,
290
- select: selectId,
291
- toggleCheck,
292
- setActive,
293
- onKeydown,
294
- /** Spread onto the tree container element. */
295
- treeProps: () => ({
296
- role: 'tree' as const,
297
- 'aria-label': config.ariaLabel?.(),
298
- 'aria-multiselectable': checkable(),
299
- }),
300
- /** Spread onto the treeitem element for a flattened `row`. */
301
- itemProps: (row: TreeRow) => {
302
- const cs = checkable() ? checkStateOf(row.node) : 'unchecked'
303
- const ariaChecked: 'true' | 'mixed' | 'false' | undefined =
304
- checkable() ? (cs === 'checked' ? 'true' : cs === 'indeterminate' ? 'mixed' : 'false') : undefined
305
- return {
306
- role: 'treeitem' as const,
307
- 'aria-level': row.depth + 1,
308
- 'aria-selected': row.node.id === selected(),
309
- 'aria-expanded': row.hasChildren ? row.open : undefined,
310
- 'aria-checked': ariaChecked,
311
- 'aria-disabled': row.node.disabled || undefined,
312
- 'data-row': row.index,
313
- tabindex: row.index === active ? 0 : -1,
314
- onclick: () => { setActive(row.index); select(row.node) },
315
- onkeydown: onKeydown,
316
- }
317
- },
318
- }
319
- }
320
-
321
- /** The headless tree instance returned by {@link createTree}. */
322
- export type Tree = ReturnType<typeof createTree>
1
+ /**
2
+ * createTree - the HEADLESS core behind <SvTree>, in the same spirit as
3
+ * `createSvGrid` for the grid: a runes-based state machine (expand/collapse,
4
+ * single-select highlight, cascading tri-state checkboxes, full keyboard) with
5
+ * **prop-getters** you spread onto YOUR OWN markup. The visible tree is
6
+ * flattened into `rows` so roving-focus keyboard nav stays a flat index walk.
7
+ *
8
+ * ```svelte
9
+ * <script lang="ts">
10
+ * import { createTree } from '@svgrid/grid'
11
+ * let selected = $state<string | null>(null)
12
+ * const tree = createTree({ nodes: () => nodes, selected: () => selected, onSelect: (id) => (selected = id) })
13
+ * </script>
14
+ * <div {...tree.treeProps()}>
15
+ * {#each tree.rows as row (row.node.id)}
16
+ * <div {...tree.itemProps(row)}>{row.node.label}</div>
17
+ * {/each}
18
+ * </div>
19
+ * ```
20
+ *
21
+ * The styled <SvTree> is just one renderer over this core. The cascade math
22
+ * (`treeDescendantIds`, `treeCheckState`) is exported as pure functions.
23
+ */
24
+ export type TreeNode = {
25
+ id: string
26
+ label: string
27
+ children?: TreeNode[]
28
+ disabled?: boolean
29
+ /** Marks a node whose children are loaded on demand (shows an expand arrow
30
+ * even with no children yet; the renderer loads them on first expand). */
31
+ lazy?: boolean
32
+ }
33
+
34
+ /** A node's checkbox state. `'indeterminate'` means some but not all descendants are checked. */
35
+ export type CheckState = 'checked' | 'indeterminate' | 'unchecked'
36
+
37
+ /** A single visible (flattened) tree row. */
38
+ export type TreeRow = {
39
+ node: TreeNode
40
+ depth: number
41
+ hasChildren: boolean
42
+ open: boolean
43
+ parentId: string | null
44
+ index: number
45
+ }
46
+
47
+ /** All descendant ids of `node` (pure, depth-first). */
48
+ export function treeDescendantIds(node: TreeNode): string[] {
49
+ const ids: string[] = []
50
+ const walk = (n: TreeNode) => { for (const c of n.children ?? []) { ids.push(c.id); walk(c) } }
51
+ walk(node)
52
+ return ids
53
+ }
54
+
55
+ /** Tri-state check status of `node` given the set of checked ids (pure). */
56
+ export function treeCheckState(node: TreeNode, checked: ReadonlySet<string>): CheckState {
57
+ if (!node.children?.length) return checked.has(node.id) ? 'checked' : 'unchecked'
58
+ const desc = treeDescendantIds(node)
59
+ const on = desc.filter((id) => checked.has(id)).length
60
+ if (on === 0 && !checked.has(node.id)) return 'unchecked'
61
+ if (on === desc.length) return 'checked'
62
+ return 'indeterminate'
63
+ }
64
+
65
+ function findNode(list: ReadonlyArray<TreeNode>, id: string): TreeNode | null {
66
+ for (const n of list) {
67
+ if (n.id === id) return n
68
+ if (n.children) { const f = findNode(n.children, id); if (f) return f }
69
+ }
70
+ return null
71
+ }
72
+
73
+ /** Where a dragged node lands relative to the drop target. */
74
+ export type TreeDropPosition = 'before' | 'after' | 'inside'
75
+
76
+ /** True if `id` is inside `node`'s subtree (used to block invalid drops). */
77
+ export function treeContains(node: TreeNode, id: string): boolean {
78
+ return node.children?.some((c) => c.id === id || treeContains(c, id)) ?? false
79
+ }
80
+
81
+ /**
82
+ * Return a NEW node tree with `dragId` moved before/after/inside `targetId`
83
+ * (pure - the caller sets it back as the controlled `nodes`). No-ops on invalid
84
+ * moves (self, or into own descendant).
85
+ */
86
+ export function moveTreeNode(
87
+ nodes: ReadonlyArray<TreeNode>,
88
+ dragId: string,
89
+ targetId: string,
90
+ position: TreeDropPosition,
91
+ ): TreeNode[] {
92
+ if (dragId === targetId) return [...nodes]
93
+ const dragged = findNode(nodes, dragId)
94
+ if (!dragged) return [...nodes]
95
+ if (dragId === targetId || treeContains(dragged, targetId)) return [...nodes]
96
+
97
+ const without = (list: ReadonlyArray<TreeNode>): TreeNode[] => {
98
+ const out: TreeNode[] = []
99
+ for (const n of list) {
100
+ if (n.id === dragId) continue
101
+ out.push(n.children ? { ...n, children: without(n.children) } : n)
102
+ }
103
+ return out
104
+ }
105
+ const insert = (list: ReadonlyArray<TreeNode>): TreeNode[] => {
106
+ const out: TreeNode[] = []
107
+ for (const n of list) {
108
+ if (n.id === targetId) {
109
+ if (position === 'before') { out.push(dragged, n) }
110
+ else if (position === 'after') { out.push(n, dragged) }
111
+ else out.push({ ...n, children: [...(n.children ?? []), dragged] })
112
+ } else if (n.children) {
113
+ out.push({ ...n, children: insert(n.children) })
114
+ } else out.push(n)
115
+ }
116
+ return out
117
+ }
118
+ return insert(without(nodes))
119
+ }
120
+
121
+ /** Sort siblings (recursively) by a comparator (pure). */
122
+ export function sortTreeNodes(
123
+ nodes: ReadonlyArray<TreeNode>,
124
+ compare: (a: TreeNode, b: TreeNode) => number,
125
+ ): TreeNode[] {
126
+ return [...nodes]
127
+ .sort(compare)
128
+ .map((n) => (n.children ? { ...n, children: sortTreeNodes(n.children, compare) } : n))
129
+ }
130
+
131
+ /** Reactive inputs are passed as getters so the core tracks live prop changes. */
132
+ export type TreeConfig = {
133
+ nodes: () => ReadonlyArray<TreeNode>
134
+ selected?: () => string | null
135
+ onSelect?: (id: string) => void
136
+ /** Seed the internally-managed expanded set (read once). */
137
+ expandedIds?: () => string[] | undefined
138
+ onToggle?: (id: string, expanded: boolean) => void
139
+ checkable?: () => boolean
140
+ checked?: () => string[]
141
+ onCheck?: (ids: string[]) => void
142
+ ariaLabel?: () => string | undefined
143
+ /** Text direction; under `'rtl'` the Left/Right expand/collapse keys swap. */
144
+ dir?: () => import('./editor-contract').EditorDir | undefined
145
+ /** Filter query: show only matching nodes + their ancestors, auto-expanded. */
146
+ filter?: () => string | undefined
147
+ }
148
+
149
+ /** Build the headless tree model: expansion, selection and checkbox cascading, with no markup. */
150
+ export function createTree(config: TreeConfig) {
151
+ const nodes = () => config.nodes()
152
+ const checkable = () => config.checkable?.() ?? false
153
+ const selected = () => config.selected?.() ?? null
154
+
155
+ // Internal expanded set, seeded from the prop once (then self-managed).
156
+ let expanded = $state<Set<string>>(new Set())
157
+ let seeded = false
158
+ $effect(() => {
159
+ if (!seeded) { seeded = true; const ids = config.expandedIds?.(); if (ids) expanded = new Set(ids) }
160
+ })
161
+
162
+ // When filtering, precompute which nodes to show (a match, or an ancestor of a
163
+ // match) and which to force-open so matches are revealed.
164
+ const filterInfo = $derived.by(() => {
165
+ const q = config.filter?.()?.trim().toLowerCase()
166
+ if (!q) return null
167
+ const visible = new Set<string>()
168
+ const forceOpen = new Set<string>()
169
+ const walk = (node: TreeNode): boolean => {
170
+ let childMatch = false
171
+ for (const c of node.children ?? []) childMatch = walk(c) || childMatch
172
+ const selfMatch = node.label.toLowerCase().includes(q)
173
+ if (selfMatch || childMatch) { visible.add(node.id); if (childMatch) forceOpen.add(node.id) }
174
+ return selfMatch || childMatch
175
+ }
176
+ for (const n of nodes()) walk(n)
177
+ return { visible, forceOpen }
178
+ })
179
+
180
+ const rows = $derived.by<TreeRow[]>(() => {
181
+ const out: TreeRow[] = []
182
+ const fi = filterInfo
183
+ const walk = (list: ReadonlyArray<TreeNode>, depth: number, parentId: string | null) => {
184
+ for (const node of list) {
185
+ if (fi && !fi.visible.has(node.id)) continue
186
+ const hasChildren = !!node.children?.length || !!node.lazy
187
+ const open = fi ? fi.forceOpen.has(node.id) || expanded.has(node.id) : expanded.has(node.id)
188
+ out.push({ node, depth, hasChildren, open, parentId, index: out.length })
189
+ if (open && node.children?.length) walk(node.children, depth + 1, node.id)
190
+ }
191
+ }
192
+ walk(nodes(), 0, null)
193
+ return out
194
+ })
195
+
196
+ let active = $state(0)
197
+ $effect(() => { if (active >= rows.length) active = Math.max(0, rows.length - 1) })
198
+
199
+ const checkedSet = $derived(new Set(config.checked?.() ?? []))
200
+
201
+ // Roving focus target; `focusTick` bumps only on keyboard moves.
202
+ let focusTick = $state(0)
203
+ function setActive(i: number, focus = false) { active = i; if (focus) focusTick++ }
204
+
205
+ const checkStateOf = (node: TreeNode): CheckState => treeCheckState(node, checkedSet)
206
+ const isExpanded = (id: string) => expanded.has(id)
207
+ const isSelected = (id: string) => id === selected()
208
+
209
+ function toggleExpand(node: TreeNode) {
210
+ // Lazy nodes have no children *yet* - they must still be expandable so the
211
+ // toggle fires onToggle and the host can fetch children on demand.
212
+ if (!node.children?.length && !node.lazy) return
213
+ const next = new Set(expanded)
214
+ const willOpen = !next.has(node.id)
215
+ willOpen ? next.add(node.id) : next.delete(node.id)
216
+ expanded = next
217
+ config.onToggle?.(node.id, willOpen)
218
+ }
219
+ const toggle = (id: string) => { const n = findNode(nodes(), id); if (n) toggleExpand(n) }
220
+
221
+ function select(node: TreeNode) {
222
+ if (node.disabled) return
223
+ config.onSelect?.(node.id)
224
+ }
225
+ const selectId = (id: string) => { const n = findNode(nodes(), id); if (n) select(n) }
226
+
227
+ function toggleCheck(node: TreeNode) {
228
+ if (node.disabled) return
229
+ const next = new Set(checkedSet)
230
+ const ids = [node.id, ...treeDescendantIds(node)]
231
+ const currentlyOn = checkStateOf(node) === 'checked'
232
+ for (const id of ids) currentlyOn ? next.delete(id) : next.add(id)
233
+ config.onCheck?.([...next])
234
+ }
235
+
236
+ // Step from `from` towards `dir` (+1/-1), skipping disabled rows, so roving
237
+ // focus never lands on a node with zero semantic affordance for AT users.
238
+ // Falls back to `from` if every row in that direction is disabled.
239
+ function stepEnabled(from: number, dir: 1 | -1): number {
240
+ let i = from
241
+ while (i + dir >= 0 && i + dir <= rows.length - 1) {
242
+ i += dir
243
+ if (!rows[i]?.node.disabled) return i
244
+ }
245
+ return from
246
+ }
247
+
248
+ function onKeydown(e: KeyboardEvent) {
249
+ const item = rows[active]
250
+ if (!item) return
251
+ // "expand" opens the node or steps into the first child; "collapse" closes it
252
+ // or jumps to the parent. Under RTL the physical Left/Right keys are swapped.
253
+ const expand = () => {
254
+ if (item.hasChildren && !item.open) toggleExpand(item.node)
255
+ else if (item.hasChildren && item.open) setActive(Math.min(active + 1, rows.length - 1), true)
256
+ }
257
+ const collapse = () => {
258
+ if (item.hasChildren && item.open) toggleExpand(item.node)
259
+ else if (item.parentId) { const pi = rows.findIndex((r) => r.node.id === item.parentId); if (pi >= 0) setActive(pi, true) }
260
+ }
261
+ const rtl = config.dir?.() === 'rtl'
262
+ switch (e.key) {
263
+ case 'ArrowDown': e.preventDefault(); setActive(stepEnabled(active, 1), true); break
264
+ case 'ArrowUp': e.preventDefault(); setActive(stepEnabled(active, -1), true); break
265
+ case 'ArrowRight': e.preventDefault(); (rtl ? collapse : expand)(); break
266
+ case 'ArrowLeft': e.preventDefault(); (rtl ? expand : collapse)(); break
267
+ case 'Enter': e.preventDefault(); select(item.node); break
268
+ case ' ': e.preventDefault(); checkable() ? toggleCheck(item.node) : select(item.node); break
269
+ case 'Home': e.preventDefault(); setActive(0, true); break
270
+ case 'End': e.preventDefault(); setActive(rows.length - 1, true); break
271
+ }
272
+ }
273
+
274
+ return {
275
+ /** Internally-managed set of expanded node ids. */
276
+ get expanded() { return expanded },
277
+ /** Selected node id (single-select highlight). */
278
+ get selected() { return selected() },
279
+ /** Flattened list of visible rows. */
280
+ get rows() { return rows },
281
+ /** Roving-focus row index. */
282
+ get activeIndex() { return active },
283
+ /** Monotonic counter; changes only on keyboard navigation. */
284
+ get focusTick() { return focusTick },
285
+ isExpanded,
286
+ isSelected,
287
+ checkStateOf,
288
+ toggle,
289
+ toggleExpand,
290
+ select: selectId,
291
+ toggleCheck,
292
+ setActive,
293
+ onKeydown,
294
+ /** Spread onto the tree container element. */
295
+ treeProps: () => ({
296
+ role: 'tree' as const,
297
+ 'aria-label': config.ariaLabel?.(),
298
+ 'aria-multiselectable': checkable(),
299
+ }),
300
+ /** Spread onto the treeitem element for a flattened `row`. */
301
+ itemProps: (row: TreeRow) => {
302
+ const cs = checkable() ? checkStateOf(row.node) : 'unchecked'
303
+ const ariaChecked: 'true' | 'mixed' | 'false' | undefined =
304
+ checkable() ? (cs === 'checked' ? 'true' : cs === 'indeterminate' ? 'mixed' : 'false') : undefined
305
+ return {
306
+ role: 'treeitem' as const,
307
+ 'aria-level': row.depth + 1,
308
+ 'aria-selected': row.node.id === selected(),
309
+ 'aria-expanded': row.hasChildren ? row.open : undefined,
310
+ 'aria-checked': ariaChecked,
311
+ 'aria-disabled': row.node.disabled || undefined,
312
+ 'data-row': row.index,
313
+ tabindex: row.index === active ? 0 : -1,
314
+ onclick: () => { setActive(row.index); select(row.node) },
315
+ onkeydown: onKeydown,
316
+ }
317
+ },
318
+ }
319
+ }
320
+
321
+ /** The headless tree instance returned by {@link createTree}. */
322
+ export type Tree = ReturnType<typeof createTree>