@svgrid/grid 3.0.0 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (259) hide show
  1. package/CHANGELOG.md +116 -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 +748 -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-DMihUtma.js → GridMenus-CYzOvmNQ.js} +3 -3
  56. package/dist/cdn/{GridMenus-nmNDj1a3.js → GridMenus-DFB6iwF8.js} +3 -3
  57. package/dist/cdn/{SvDateRangeInput-DflbiP7N.js → SvDateRangeInput-CaOuMs8O.js} +1 -1
  58. package/dist/cdn/{SvDateRangeInput-Bh0A0JkF.js → SvDateRangeInput-DMLKmGEc.js} +1 -1
  59. package/dist/cdn/{SvDateTimePicker-Bivn8dAP.js → SvDateTimePicker-CCbDZNZB.js} +1 -1
  60. package/dist/cdn/{SvDateTimePicker-BWwpfB_o.js → SvDateTimePicker-sonaH0oh.js} +1 -1
  61. package/dist/cdn/{SvGridCellEditor-Ba7rY3eu.js → SvGridCellEditor-BWnTi2N7.js} +2 -2
  62. package/dist/cdn/{SvGridCellEditor-AXL8cHGO.js → SvGridCellEditor-CjEJMJKc.js} +2 -2
  63. package/dist/cdn/{SvGridChart-CwhFz7GV.js → SvGridChart-BEJmNNx9.js} +1 -1
  64. package/dist/cdn/{SvGridChart-Bs2GIR2Q.js → SvGridChart-BwVos976.js} +1 -1
  65. package/dist/cdn/{SvGridChartPanel-1WXuStzM.js → SvGridChartPanel-BOknOkrP.js} +1 -1
  66. package/dist/cdn/{SvGridChartPanel-e5_nqNP9.js → SvGridChartPanel-D2PjII4O.js} +1 -1
  67. package/dist/cdn/{SvGridChartView-SmPW10dI.js → SvGridChartView-00LPUHL1.js} +1 -1
  68. package/dist/cdn/{SvGridChartView-eSPuJE6g.js → SvGridChartView-BhUEJ5ki.js} +1 -1
  69. package/dist/cdn/{SvGridDropdown-B1ZcLpgs.js → SvGridDropdown-D0VdjeR8.js} +1 -1
  70. package/dist/cdn/{SvGridDropdown-CtdbHcIS.js → SvGridDropdown-D13MtJ2j.js} +1 -1
  71. package/dist/cdn/{date-format-DZT7T1wf.js → date-format-BNii4zeD.js} +2 -2
  72. package/dist/cdn/{date-format-CcP1tafP.js → date-format-BnnHlqGw.js} +2 -2
  73. package/dist/cdn/{src-B_YS5AOc.js → src-C8QjSaq-.js} +42 -44
  74. package/dist/cdn/{src-DYXXpuSk.js → src-D0hO2eYN.js} +41 -43
  75. package/dist/cdn/svgrid.js +7 -7
  76. package/dist/cdn/svgrid.svelte-external.js +7 -7
  77. package/dist/chart-export.js +8 -8
  78. package/dist/editing.js +22 -13
  79. package/package.json +11 -11
  80. package/src/FlexRender.svelte +96 -96
  81. package/src/GridFooter.svelte +181 -181
  82. package/src/SvAutoComplete.svelte +169 -169
  83. package/src/SvAvatar.svelte +75 -75
  84. package/src/SvCalendar.svelte +503 -503
  85. package/src/SvCalendar.test.ts +226 -226
  86. package/src/SvCarousel.svelte +141 -141
  87. package/src/SvCheckBox.svelte +102 -102
  88. package/src/SvCircularProgress.svelte +109 -109
  89. package/src/SvColorInput.svelte +181 -181
  90. package/src/SvComboBox.svelte +279 -279
  91. package/src/SvContextMenu.svelte +116 -116
  92. package/src/SvCountryInput.svelte +163 -163
  93. package/src/SvDrawer.svelte +254 -254
  94. package/src/SvDropDownList.svelte +378 -378
  95. package/src/SvDurationInput.svelte +126 -126
  96. package/src/SvField.svelte +293 -293
  97. package/src/SvForm.svelte +437 -437
  98. package/src/SvForm.test.ts +411 -411
  99. package/src/SvGrid.types.ts +2092 -2092
  100. package/src/SvGridCellEditor.svelte +748 -744
  101. package/src/SvGridChart.svelte +1716 -1716
  102. package/src/SvGridChartPanel.svelte +485 -485
  103. package/src/SvGridChartView.svelte +70 -70
  104. package/src/SvGridDropdown.svelte +728 -728
  105. package/src/SvGridSelect.svelte +270 -270
  106. package/src/SvGroupCell.svelte +116 -116
  107. package/src/SvListBox.svelte +334 -334
  108. package/src/SvMaskedInput.svelte +122 -122
  109. package/src/SvMenu.svelte +124 -124
  110. package/src/SvMenu.test.ts +97 -97
  111. package/src/SvMenuList.svelte +146 -146
  112. package/src/SvMultiSelect.svelte +293 -293
  113. package/src/SvNumberInput.svelte +172 -172
  114. package/src/SvOtpInput.svelte +158 -158
  115. package/src/SvPasswordInput.svelte +151 -151
  116. package/src/SvPhoneInput.svelte +133 -133
  117. package/src/SvPopover.svelte +197 -197
  118. package/src/SvProgress.svelte +116 -116
  119. package/src/SvRadioGroup.svelte +107 -107
  120. package/src/SvRating.svelte +112 -112
  121. package/src/SvResult.svelte +73 -73
  122. package/src/SvRichText.svelte +211 -211
  123. package/src/SvRowGroupPanel.svelte +170 -170
  124. package/src/SvScrollArea.svelte +61 -61
  125. package/src/SvSlider.svelte +203 -203
  126. package/src/SvSwitchButton.svelte +108 -108
  127. package/src/SvTagsInput.svelte +115 -115
  128. package/src/SvTextInput.svelte +147 -147
  129. package/src/SvTimePicker.svelte +245 -245
  130. package/src/SvToaster.svelte +159 -159
  131. package/src/SvToaster.test.ts +95 -95
  132. package/src/SvToggleButton.svelte +85 -85
  133. package/src/SvTooltip.svelte +161 -161
  134. package/src/SvTour.svelte +208 -208
  135. package/src/SvTree.svelte +444 -444
  136. package/src/SvTreeSelect.svelte +239 -239
  137. package/src/a11y/dismissable.test.ts +119 -119
  138. package/src/a11y/dismissable.ts +114 -114
  139. package/src/a11y.contract.test.ts +49 -49
  140. package/src/a11y.test.ts +59 -59
  141. package/src/a11y.ts +61 -61
  142. package/src/ai.test.ts +502 -502
  143. package/src/ai.ts +1419 -1419
  144. package/src/build-api.coverage.test.ts +633 -633
  145. package/src/build-api.ts +846 -846
  146. package/src/builtin-editors.grid.test.ts +83 -83
  147. package/src/cell-formatting.ts +171 -171
  148. package/src/cell-render.test.ts +513 -513
  149. package/src/cell-render.ts +496 -496
  150. package/src/cell-values.ts +148 -148
  151. package/src/chart-export.ts +202 -202
  152. package/src/chart-view.svelte.ts +36 -36
  153. package/src/chart.ts +2321 -2321
  154. package/src/collaboration.test.ts +104 -104
  155. package/src/collaboration.ts +167 -167
  156. package/src/column-groups.ts +78 -78
  157. package/src/core.performance.test.ts +30 -30
  158. package/src/core.ts +1865 -1865
  159. package/src/createAutocomplete.svelte.ts +132 -132
  160. package/src/createCombobox.svelte.ts +191 -191
  161. package/src/createCountryInput.svelte.ts +157 -157
  162. package/src/createDropdownList.svelte.ts +168 -168
  163. package/src/createForm.svelte.ts +386 -386
  164. package/src/createGrid.svelte.ts +42 -42
  165. package/src/createGrid.test.ts +10 -10
  166. package/src/createGridState.svelte.ts +17 -17
  167. package/src/createListbox.svelte.ts +250 -250
  168. package/src/createMenu.svelte.ts +224 -224
  169. package/src/createPopoverSelect.svelte.ts +213 -213
  170. package/src/createSlider.svelte.ts +191 -191
  171. package/src/createTooltip.svelte.ts +144 -144
  172. package/src/createTree.svelte.ts +322 -322
  173. package/src/datetime/date-core.ts +206 -206
  174. package/src/datetime/date-restrict.ts +61 -61
  175. package/src/datetime/timezone.ts +135 -135
  176. package/src/dock-manager-model.ts +596 -596
  177. package/src/dock-model.ts +374 -374
  178. package/src/editing.test.ts +974 -974
  179. package/src/editing.ts +618 -609
  180. package/src/editor-contract.ts +171 -171
  181. package/src/editor-registry.grid.test.ts +144 -144
  182. package/src/editor-registry.ts +122 -122
  183. package/src/export-data-api.test.ts +126 -126
  184. package/src/export-format.test.ts +107 -107
  185. package/src/export-format.ts +601 -601
  186. package/src/filter-operators.ts +160 -160
  187. package/src/filtering/excel-filters.ts +325 -325
  188. package/src/flex-render.ts +3 -3
  189. package/src/form-field.ts +127 -127
  190. package/src/group-display.test.ts +167 -167
  191. package/src/group-display.ts +200 -200
  192. package/src/headless.ts +87 -87
  193. package/src/js-scroller.svelte.ts +173 -173
  194. package/src/keyboard-handlers.ts +270 -270
  195. package/src/keyboard.test.ts +59 -59
  196. package/src/keyboard.ts +97 -97
  197. package/src/list-nav.test.ts +49 -49
  198. package/src/list-nav.ts +29 -29
  199. package/src/list-option.test.ts +56 -56
  200. package/src/list-option.ts +179 -179
  201. package/src/menus.ts +597 -597
  202. package/src/merge-objects.ts +48 -48
  203. package/src/overlays.test.ts +90 -90
  204. package/src/positioning.ts +268 -268
  205. package/src/render-component.ts +28 -28
  206. package/src/row-drag.test.ts +401 -401
  207. package/src/row-drag.ts +419 -419
  208. package/src/row-resize.test.ts +524 -524
  209. package/src/row-resize.ts +228 -228
  210. package/src/scheduler-ical.ts +181 -181
  211. package/src/scheduler-model.test.ts +562 -562
  212. package/src/scheduler-model.ts +873 -873
  213. package/src/selection.test.ts +885 -885
  214. package/src/server-data-source.test.ts +383 -383
  215. package/src/server-data-source.ts +469 -469
  216. package/src/sparkline.test.ts +68 -68
  217. package/src/sparkline.ts +169 -169
  218. package/src/spreadsheet.test.ts +488 -488
  219. package/src/spreadsheet.ts +312 -312
  220. package/src/static-functions.ts +11 -11
  221. package/src/subscribe.ts +38 -38
  222. package/src/summaries.ts +113 -113
  223. package/src/svgrid-wrapper.types.ts +563 -563
  224. package/src/svgrid.async-editor-options.test.ts +273 -273
  225. package/src/svgrid.auto-row-height.test.ts +204 -204
  226. package/src/svgrid.behavior.test.ts +910 -910
  227. package/src/svgrid.charting.test.ts +534 -534
  228. package/src/svgrid.comments-autocomplete.test.ts +127 -127
  229. package/src/svgrid.context-menu.test.ts +147 -147
  230. package/src/svgrid.features.test.ts +157 -157
  231. package/src/svgrid.filter-depth.test.ts +163 -163
  232. package/src/svgrid.filter-menu-listbox.svelte.test.ts +382 -377
  233. package/src/svgrid.filter-menu-scroll.test.ts +112 -112
  234. package/src/svgrid.grand-total.test.ts +188 -188
  235. package/src/svgrid.group-display-mode.test.ts +171 -171
  236. package/src/svgrid.group-footers.test.ts +121 -121
  237. package/src/svgrid.group-pagination.test.ts +153 -153
  238. package/src/svgrid.new-features.wrapper.test.ts +251 -251
  239. package/src/svgrid.tree-data.test.ts +186 -186
  240. package/src/svgrid.wrapper.test.ts +63 -63
  241. package/src/svgriddropdown.async-panel.svelte.test.ts +195 -195
  242. package/src/test-setup.ts +62 -62
  243. package/src/themes/index.ts +288 -288
  244. package/src/toast-store.svelte.ts +250 -250
  245. package/src/toast-store.test.ts +147 -147
  246. package/src/tree-row-model.test.ts +168 -168
  247. package/src/ui-buttons.test.ts +144 -144
  248. package/src/ui-inputs.test.ts +118 -118
  249. package/src/ui-localization.test.ts +113 -113
  250. package/src/ui-range.test.ts +70 -70
  251. package/src/ui-selection.test.ts +155 -155
  252. package/src/ui-tier1.test.ts +142 -142
  253. package/src/virtual.test.ts +88 -88
  254. package/src/virtualization/column-virtualizer.test.ts +27 -27
  255. package/src/virtualization/column-virtualizer.ts +30 -30
  256. package/src/virtualization/svelte-virtualizer.svelte.ts +26 -26
  257. package/src/virtualization/types.ts +30 -30
  258. package/src/virtualization/virtualizer.test.ts +47 -47
  259. package/src/virtualization/virtualizer.ts +322 -322
package/src/form-field.ts CHANGED
@@ -1,127 +1,127 @@
1
- import type { Validator } from './validators'
2
-
3
- /**
4
- * Field descriptor for <SvForm> and the headless `createForm` core. Kept in a
5
- * plain `.ts` module so the core can import the type without pulling in the
6
- * `.svelte` component (which would create a `.svelte.ts` -> `.svelte` import
7
- * cycle Vite's dev import-analysis fails to resolve).
8
- */
9
- export type FormFieldType =
10
- | 'text' | 'email' | 'tel' | 'textarea' | 'number' | 'password'
11
- | 'select' | 'multiselect' | 'checkbox' | 'switch' | 'date' | 'color' | 'rating'
12
- | 'radio' | 'slider' | 'tags' | 'phone' | 'country' | 'mask'
13
- | 'datetime' | 'time' | 'daterange' | 'combobox' | 'file'
14
- | 'array'
15
-
16
- export type FormField = {
17
- name: string
18
- label: string
19
- type?: FormFieldType
20
- required?: boolean
21
- /** Show the field but block edits (still submitted, unlike hidden fields). */
22
- readonly?: boolean
23
- /** Helper text shown under the control (distinct from a validation error). */
24
- help?: string
25
- placeholder?: string
26
- /**
27
- * Options for select/combobox/radio/multiselect. A function makes them CASCADE:
28
- * the list is derived from the current form values (e.g. cities for the picked
29
- * country). Pair with `dependsOn` so the child clears when the parent changes.
30
- */
31
- options?:
32
- | Array<{ value: string | number; label: string; color?: string }>
33
- | ((values: Record<string, any>) => Array<{ value: string | number; label: string; color?: string }>)
34
- /** Field name(s) this one depends on; when a parent changes, this field's value
35
- * is cleared (cascading selects). */
36
- dependsOn?: string | string[]
37
- /** Mask pattern for `type: 'mask'` (`#`=digit, `A`=letter, `*`=alnum). */
38
- mask?: string
39
- /** Numeric bounds for `type: 'number'` / `'slider'`. */
40
- min?: number
41
- max?: number
42
- step?: number
43
- precision?: number
44
- /** Text affixes for `type: 'number'` (e.g. `$` / `%`). */
45
- prefix?: string
46
- suffix?: string
47
- /** Remote option loader for `type: 'combobox'` (debounced typeahead). The
48
- * current form `values` are passed so it can depend on other fields. */
49
- loadOptions?: (query: string, values: Record<string, any>) => Promise<Array<{ value: string | number; label: string }>>
50
- /** File input hints for `type: 'file'`. */
51
- accept?: string
52
- multiple?: boolean
53
- /**
54
- * Derive this field's value from the other form values (e.g. a total). A
55
- * computed field is read-only, recomputes reactively, is not user-validated,
56
- * and its derived value is included in the submitted payload.
57
- */
58
- computed?: (values: Record<string, any>) => any
59
- /** Declarative validation rules (see `rules` - email/pattern/min/compare...). */
60
- rules?: ReadonlyArray<Validator>
61
- /** Return an error message, or null/undefined when valid. */
62
- validate?: (value: any, values: Record<string, any>) => string | null | undefined
63
- /**
64
- * Async validator (e.g. "is this username taken?"). Runs after the sync checks
65
- * pass, debounced (`asyncDebounce`, default 300ms) and stale-guarded so only the
66
- * latest result wins. While it runs, `form.isValidating(name)` is true and the
67
- * field shows a checking indicator. Submit waits for all async validators.
68
- */
69
- asyncValidate?: (value: any, values: Record<string, any>) => Promise<string | null | undefined>
70
- /** Debounce (ms) before `asyncValidate` runs on edit. Default 300. */
71
- asyncDebounce?: number
72
- /** Span full width in the grid. */
73
- full?: boolean
74
- /** Columns to span (generalizes `full`); `2`+ widens the field in a grid. */
75
- span?: number
76
- /**
77
- * Show the field only when this is `true` / returns `true` (default: always).
78
- * A field derived from other values, e.g. `visible: (v) => v.hasAddress`.
79
- * Hidden fields are skipped in validation and excluded from the submitted values.
80
- */
81
- visible?: boolean | ((values: Record<string, any>) => boolean)
82
- /** Disable the field, statically or derived from other values. */
83
- disabled?: boolean | ((values: Record<string, any>) => boolean)
84
- /**
85
- * For `type: 'array'` - the fields of each repeatable item. The value is an
86
- * array of item objects; each item's fields validate against that item (so
87
- * cross-field rules within a row work). `required`/`minItems`/`maxItems` gate
88
- * the array length.
89
- */
90
- itemFields?: ReadonlyArray<FormField>
91
- /** Label for the "add item" button of an array field. Default "+ Add". */
92
- addLabel?: string
93
- /** Min / max item count for an array field. */
94
- minItems?: number
95
- maxItems?: number
96
- }
97
-
98
- /**
99
- * A group of fields rendered as a titled fieldset - and, when `<SvForm stepper>`
100
- * is set, as one step of a wizard. Use in place of a plain `FormField` inside the
101
- * `fields` array; the schema may freely mix flat fields and sections.
102
- */
103
- export type FormSection = {
104
- section: string
105
- description?: string
106
- fields: ReadonlyArray<FormField>
107
- /** Column count for this section's grid (defaults to the form's `columns`). */
108
- columns?: number
109
- }
110
-
111
- /** An entry in a form schema: either a single field or a titled section/step. */
112
- export type FormEntry = FormField | FormSection
113
-
114
- /** Narrow a schema entry to a section (has a `fields` array). */
115
- export function isFormSection(e: FormEntry): e is FormSection {
116
- return Array.isArray((e as FormSection).fields)
117
- }
118
-
119
- /** Flatten a mixed schema (fields + sections) to the flat list of fields. */
120
- export function flattenFields(entries: ReadonlyArray<FormEntry>): FormField[] {
121
- const out: FormField[] = []
122
- for (const e of entries) {
123
- if (isFormSection(e)) out.push(...e.fields)
124
- else out.push(e)
125
- }
126
- return out
127
- }
1
+ import type { Validator } from './validators'
2
+
3
+ /**
4
+ * Field descriptor for <SvForm> and the headless `createForm` core. Kept in a
5
+ * plain `.ts` module so the core can import the type without pulling in the
6
+ * `.svelte` component (which would create a `.svelte.ts` -> `.svelte` import
7
+ * cycle Vite's dev import-analysis fails to resolve).
8
+ */
9
+ export type FormFieldType =
10
+ | 'text' | 'email' | 'tel' | 'textarea' | 'number' | 'password'
11
+ | 'select' | 'multiselect' | 'checkbox' | 'switch' | 'date' | 'color' | 'rating'
12
+ | 'radio' | 'slider' | 'tags' | 'phone' | 'country' | 'mask'
13
+ | 'datetime' | 'time' | 'daterange' | 'combobox' | 'file'
14
+ | 'array'
15
+
16
+ export type FormField = {
17
+ name: string
18
+ label: string
19
+ type?: FormFieldType
20
+ required?: boolean
21
+ /** Show the field but block edits (still submitted, unlike hidden fields). */
22
+ readonly?: boolean
23
+ /** Helper text shown under the control (distinct from a validation error). */
24
+ help?: string
25
+ placeholder?: string
26
+ /**
27
+ * Options for select/combobox/radio/multiselect. A function makes them CASCADE:
28
+ * the list is derived from the current form values (e.g. cities for the picked
29
+ * country). Pair with `dependsOn` so the child clears when the parent changes.
30
+ */
31
+ options?:
32
+ | Array<{ value: string | number; label: string; color?: string }>
33
+ | ((values: Record<string, any>) => Array<{ value: string | number; label: string; color?: string }>)
34
+ /** Field name(s) this one depends on; when a parent changes, this field's value
35
+ * is cleared (cascading selects). */
36
+ dependsOn?: string | string[]
37
+ /** Mask pattern for `type: 'mask'` (`#`=digit, `A`=letter, `*`=alnum). */
38
+ mask?: string
39
+ /** Numeric bounds for `type: 'number'` / `'slider'`. */
40
+ min?: number
41
+ max?: number
42
+ step?: number
43
+ precision?: number
44
+ /** Text affixes for `type: 'number'` (e.g. `$` / `%`). */
45
+ prefix?: string
46
+ suffix?: string
47
+ /** Remote option loader for `type: 'combobox'` (debounced typeahead). The
48
+ * current form `values` are passed so it can depend on other fields. */
49
+ loadOptions?: (query: string, values: Record<string, any>) => Promise<Array<{ value: string | number; label: string }>>
50
+ /** File input hints for `type: 'file'`. */
51
+ accept?: string
52
+ multiple?: boolean
53
+ /**
54
+ * Derive this field's value from the other form values (e.g. a total). A
55
+ * computed field is read-only, recomputes reactively, is not user-validated,
56
+ * and its derived value is included in the submitted payload.
57
+ */
58
+ computed?: (values: Record<string, any>) => any
59
+ /** Declarative validation rules (see `rules` - email/pattern/min/compare...). */
60
+ rules?: ReadonlyArray<Validator>
61
+ /** Return an error message, or null/undefined when valid. */
62
+ validate?: (value: any, values: Record<string, any>) => string | null | undefined
63
+ /**
64
+ * Async validator (e.g. "is this username taken?"). Runs after the sync checks
65
+ * pass, debounced (`asyncDebounce`, default 300ms) and stale-guarded so only the
66
+ * latest result wins. While it runs, `form.isValidating(name)` is true and the
67
+ * field shows a checking indicator. Submit waits for all async validators.
68
+ */
69
+ asyncValidate?: (value: any, values: Record<string, any>) => Promise<string | null | undefined>
70
+ /** Debounce (ms) before `asyncValidate` runs on edit. Default 300. */
71
+ asyncDebounce?: number
72
+ /** Span full width in the grid. */
73
+ full?: boolean
74
+ /** Columns to span (generalizes `full`); `2`+ widens the field in a grid. */
75
+ span?: number
76
+ /**
77
+ * Show the field only when this is `true` / returns `true` (default: always).
78
+ * A field derived from other values, e.g. `visible: (v) => v.hasAddress`.
79
+ * Hidden fields are skipped in validation and excluded from the submitted values.
80
+ */
81
+ visible?: boolean | ((values: Record<string, any>) => boolean)
82
+ /** Disable the field, statically or derived from other values. */
83
+ disabled?: boolean | ((values: Record<string, any>) => boolean)
84
+ /**
85
+ * For `type: 'array'` - the fields of each repeatable item. The value is an
86
+ * array of item objects; each item's fields validate against that item (so
87
+ * cross-field rules within a row work). `required`/`minItems`/`maxItems` gate
88
+ * the array length.
89
+ */
90
+ itemFields?: ReadonlyArray<FormField>
91
+ /** Label for the "add item" button of an array field. Default "+ Add". */
92
+ addLabel?: string
93
+ /** Min / max item count for an array field. */
94
+ minItems?: number
95
+ maxItems?: number
96
+ }
97
+
98
+ /**
99
+ * A group of fields rendered as a titled fieldset - and, when `<SvForm stepper>`
100
+ * is set, as one step of a wizard. Use in place of a plain `FormField` inside the
101
+ * `fields` array; the schema may freely mix flat fields and sections.
102
+ */
103
+ export type FormSection = {
104
+ section: string
105
+ description?: string
106
+ fields: ReadonlyArray<FormField>
107
+ /** Column count for this section's grid (defaults to the form's `columns`). */
108
+ columns?: number
109
+ }
110
+
111
+ /** An entry in a form schema: either a single field or a titled section/step. */
112
+ export type FormEntry = FormField | FormSection
113
+
114
+ /** Narrow a schema entry to a section (has a `fields` array). */
115
+ export function isFormSection(e: FormEntry): e is FormSection {
116
+ return Array.isArray((e as FormSection).fields)
117
+ }
118
+
119
+ /** Flatten a mixed schema (fields + sections) to the flat list of fields. */
120
+ export function flattenFields(entries: ReadonlyArray<FormEntry>): FormField[] {
121
+ const out: FormField[] = []
122
+ for (const e of entries) {
123
+ if (isFormSection(e)) out.push(...e.fields)
124
+ else out.push(e)
125
+ }
126
+ return out
127
+ }
@@ -1,167 +1,167 @@
1
- import { describe, expect, it } from 'vitest'
2
- import { buildAutoGroupColumns, insertGroupFooters, paginateGroupedRows } from './group-display'
3
-
4
- type R = { id: string; depth: number; group?: boolean; total?: number; footer?: boolean }
5
-
6
- const rows: R[] = [
7
- { id: 'gA', depth: 0, group: true, total: 30 },
8
- { id: 'a1', depth: 1 },
9
- { id: 'a2', depth: 1 },
10
- { id: 'gB', depth: 0, group: true, total: 20 },
11
- { id: 'b1', depth: 1 },
12
- ]
13
-
14
- const opts = {
15
- getDepth: (r: R) => r.depth,
16
- isGroup: (r: R) => !!r.group,
17
- makeFooter: (g: R): R => ({ id: `${g.id}__footer`, depth: g.depth, footer: true, total: g.total }),
18
- }
19
-
20
- describe('insertGroupFooters', () => {
21
- it('is a no-op when no footer flags are set', () => {
22
- expect(insertGroupFooters(rows, opts)).toEqual(rows)
23
- })
24
-
25
- it('inserts one footer after each group, preserving order', () => {
26
- const out = insertGroupFooters(rows, { ...opts, includeGroupFooter: true })
27
- expect(out.map((r) => r.id)).toEqual([
28
- 'gA', 'a1', 'a2', 'gA__footer',
29
- 'gB', 'b1', 'gB__footer',
30
- ])
31
- // footers carry the group's aggregate
32
- expect(out.find((r) => r.id === 'gA__footer')!.total).toBe(30)
33
- })
34
-
35
- it('closes nested groups deepest-first', () => {
36
- const nested: R[] = [
37
- { id: 'g0', depth: 0, group: true, total: 100 },
38
- { id: 'g0a', depth: 1, group: true, total: 60 },
39
- { id: 'leaf1', depth: 2 },
40
- { id: 'g0b', depth: 1, group: true, total: 40 },
41
- { id: 'leaf2', depth: 2 },
42
- ]
43
- const out = insertGroupFooters(nested, { ...opts, includeGroupFooter: true })
44
- expect(out.map((r) => r.id)).toEqual([
45
- 'g0', 'g0a', 'leaf1', 'g0a__footer',
46
- 'g0b', 'leaf2', 'g0b__footer', 'g0__footer',
47
- ])
48
- })
49
-
50
- it('appends a grand-total footer at the end', () => {
51
- const out = insertGroupFooters(rows, {
52
- ...opts,
53
- includeGrandTotalFooter: true,
54
- makeGrandTotal: () => ({ id: '__grand', depth: 0, footer: true, total: 50 }),
55
- })
56
- expect(out[out.length - 1]!.id).toBe('__grand')
57
- })
58
- })
59
-
60
- describe('buildAutoGroupColumns', () => {
61
- it('returns nothing for groupRows / no grouping', () => {
62
- expect(buildAutoGroupColumns(['region'], 'groupRows')).toEqual({ autoColumns: [], hiddenSourceIds: new Set() })
63
- expect(buildAutoGroupColumns([], 'singleColumn').autoColumns).toHaveLength(0)
64
- })
65
-
66
- it('singleColumn: one combined auto column, all grouped columns hidden', () => {
67
- const r = buildAutoGroupColumns(['region', 'category'], 'singleColumn')
68
- expect(r.autoColumns).toEqual([{ id: '__autoGroup', field: null, level: 0 }])
69
- expect([...r.hiddenSourceIds].sort()).toEqual(['category', 'region'])
70
- })
71
-
72
- it('multipleColumns: one auto column per grouped field', () => {
73
- const r = buildAutoGroupColumns(['region', 'category'], 'multipleColumns')
74
- expect(r.autoColumns.map((c) => c.id)).toEqual(['__group_region', '__group_category'])
75
- expect(r.autoColumns.map((c) => c.field)).toEqual(['region', 'category'])
76
- })
77
- })
78
-
79
- describe('paginateGroupedRows (#73)', () => {
80
- // Ten groups of two rows each - the shape from the issue report, where
81
- // slicing the flat list by pageSize leaves almost no data on a page.
82
- const many: R[] = []
83
- for (let g = 0; g < 10; g += 1) {
84
- many.push({ id: `g${g}`, depth: 0, group: true })
85
- many.push({ id: `g${g}r0`, depth: 1 })
86
- many.push({ id: `g${g}r1`, depth: 1 })
87
- }
88
- const base = { getDepth: (r: R) => r.depth, isGroup: (r: R) => !!r.group }
89
-
90
- it('counts only data rows against pageSize', () => {
91
- const { rows, dataRowCount } = paginateGroupedRows(many, { ...base, pageIndex: 0, pageSize: 10 })
92
- expect(dataRowCount).toBe(20)
93
- // A naive slice would have yielded 10 rows TOTAL, only ~3 of them data.
94
- expect(rows.filter((r) => !r.group)).toHaveLength(10)
95
- })
96
-
97
- it('reprints the banner each page a group appears on', () => {
98
- const page0 = paginateGroupedRows(many, { ...base, pageIndex: 0, pageSize: 3 }).rows
99
- expect(page0.map((r) => r.id)).toEqual(['g0', 'g0r0', 'g0r1', 'g1', 'g1r0'])
100
- // g1 is reprinted because its second row leads the next page.
101
- const page1 = paginateGroupedRows(many, { ...base, pageIndex: 1, pageSize: 3 }).rows
102
- expect(page1.map((r) => r.id)).toEqual(['g1', 'g1r1', 'g2', 'g2r0', 'g2r1'])
103
- })
104
-
105
- it('emits a banner once for a group spanning many rows on one page', () => {
106
- const wide: R[] = [{ id: 'g', depth: 0, group: true }]
107
- for (let i = 0; i < 5; i += 1) wide.push({ id: `r${i}`, depth: 1 })
108
- const { rows } = paginateGroupedRows(wide, { ...base, pageIndex: 0, pageSize: 5 })
109
- expect(rows.filter((r) => r.group)).toHaveLength(1)
110
- expect(rows).toHaveLength(6)
111
- })
112
-
113
- it('reprints the whole ancestor chain for nested groups', () => {
114
- const nested: R[] = [
115
- { id: 'A', depth: 0, group: true },
116
- { id: 'A1', depth: 1, group: true },
117
- { id: 'x', depth: 2 },
118
- { id: 'y', depth: 2 },
119
- ]
120
- const page1 = paginateGroupedRows(nested, { ...base, pageIndex: 1, pageSize: 1 }).rows
121
- expect(page1.map((r) => r.id)).toEqual(['A', 'A1', 'y'])
122
- })
123
-
124
- it('gives a COLLAPSED group its own page slot', () => {
125
- // All groups collapsed: the flat model is banners only. Treating those as
126
- // zero-cost headers left every page empty - a real bug caught by the DOM test.
127
- const collapsed: R[] = []
128
- for (let g = 0; g < 10; g += 1) collapsed.push({ id: `c${g}`, depth: 0, group: true })
129
- const { rows, dataRowCount } = paginateGroupedRows(collapsed, {
130
- ...base,
131
- isExpanded: () => false,
132
- pageIndex: 0,
133
- pageSize: 4,
134
- })
135
- expect(dataRowCount).toBe(10)
136
- expect(rows.map((r) => r.id)).toEqual(['c0', 'c1', 'c2', 'c3'])
137
- })
138
-
139
- it('mixes an expanded group with a collapsed sibling', () => {
140
- const mixed: R[] = [
141
- { id: 'open', depth: 0, group: true },
142
- { id: 'o1', depth: 1 },
143
- { id: 'o2', depth: 1 },
144
- { id: 'shut', depth: 0, group: true },
145
- ]
146
- const { rows, dataRowCount } = paginateGroupedRows(mixed, {
147
- ...base,
148
- isExpanded: (r: R) => r.id === 'open',
149
- pageIndex: 0,
150
- pageSize: 5,
151
- })
152
- // 2 data rows + 1 collapsed group = 3 units; the open banner is free.
153
- expect(dataRowCount).toBe(3)
154
- expect(rows.map((r) => r.id)).toEqual(['open', 'o1', 'o2', 'shut'])
155
- })
156
-
157
- it('handles an out-of-range page', () => {
158
- expect(paginateGroupedRows(many, { ...base, pageIndex: 99, pageSize: 10 }).rows).toEqual([])
159
- })
160
-
161
- it('leaves ungrouped data untouched', () => {
162
- const flat: R[] = [{ id: 'a', depth: 0 }, { id: 'b', depth: 0 }, { id: 'c', depth: 0 }]
163
- const { rows, dataRowCount } = paginateGroupedRows(flat, { ...base, pageIndex: 1, pageSize: 2 })
164
- expect(dataRowCount).toBe(3)
165
- expect(rows.map((r) => r.id)).toEqual(['c'])
166
- })
167
- })
1
+ import { describe, expect, it } from 'vitest'
2
+ import { buildAutoGroupColumns, insertGroupFooters, paginateGroupedRows } from './group-display'
3
+
4
+ type R = { id: string; depth: number; group?: boolean; total?: number; footer?: boolean }
5
+
6
+ const rows: R[] = [
7
+ { id: 'gA', depth: 0, group: true, total: 30 },
8
+ { id: 'a1', depth: 1 },
9
+ { id: 'a2', depth: 1 },
10
+ { id: 'gB', depth: 0, group: true, total: 20 },
11
+ { id: 'b1', depth: 1 },
12
+ ]
13
+
14
+ const opts = {
15
+ getDepth: (r: R) => r.depth,
16
+ isGroup: (r: R) => !!r.group,
17
+ makeFooter: (g: R): R => ({ id: `${g.id}__footer`, depth: g.depth, footer: true, total: g.total }),
18
+ }
19
+
20
+ describe('insertGroupFooters', () => {
21
+ it('is a no-op when no footer flags are set', () => {
22
+ expect(insertGroupFooters(rows, opts)).toEqual(rows)
23
+ })
24
+
25
+ it('inserts one footer after each group, preserving order', () => {
26
+ const out = insertGroupFooters(rows, { ...opts, includeGroupFooter: true })
27
+ expect(out.map((r) => r.id)).toEqual([
28
+ 'gA', 'a1', 'a2', 'gA__footer',
29
+ 'gB', 'b1', 'gB__footer',
30
+ ])
31
+ // footers carry the group's aggregate
32
+ expect(out.find((r) => r.id === 'gA__footer')!.total).toBe(30)
33
+ })
34
+
35
+ it('closes nested groups deepest-first', () => {
36
+ const nested: R[] = [
37
+ { id: 'g0', depth: 0, group: true, total: 100 },
38
+ { id: 'g0a', depth: 1, group: true, total: 60 },
39
+ { id: 'leaf1', depth: 2 },
40
+ { id: 'g0b', depth: 1, group: true, total: 40 },
41
+ { id: 'leaf2', depth: 2 },
42
+ ]
43
+ const out = insertGroupFooters(nested, { ...opts, includeGroupFooter: true })
44
+ expect(out.map((r) => r.id)).toEqual([
45
+ 'g0', 'g0a', 'leaf1', 'g0a__footer',
46
+ 'g0b', 'leaf2', 'g0b__footer', 'g0__footer',
47
+ ])
48
+ })
49
+
50
+ it('appends a grand-total footer at the end', () => {
51
+ const out = insertGroupFooters(rows, {
52
+ ...opts,
53
+ includeGrandTotalFooter: true,
54
+ makeGrandTotal: () => ({ id: '__grand', depth: 0, footer: true, total: 50 }),
55
+ })
56
+ expect(out[out.length - 1]!.id).toBe('__grand')
57
+ })
58
+ })
59
+
60
+ describe('buildAutoGroupColumns', () => {
61
+ it('returns nothing for groupRows / no grouping', () => {
62
+ expect(buildAutoGroupColumns(['region'], 'groupRows')).toEqual({ autoColumns: [], hiddenSourceIds: new Set() })
63
+ expect(buildAutoGroupColumns([], 'singleColumn').autoColumns).toHaveLength(0)
64
+ })
65
+
66
+ it('singleColumn: one combined auto column, all grouped columns hidden', () => {
67
+ const r = buildAutoGroupColumns(['region', 'category'], 'singleColumn')
68
+ expect(r.autoColumns).toEqual([{ id: '__autoGroup', field: null, level: 0 }])
69
+ expect([...r.hiddenSourceIds].sort()).toEqual(['category', 'region'])
70
+ })
71
+
72
+ it('multipleColumns: one auto column per grouped field', () => {
73
+ const r = buildAutoGroupColumns(['region', 'category'], 'multipleColumns')
74
+ expect(r.autoColumns.map((c) => c.id)).toEqual(['__group_region', '__group_category'])
75
+ expect(r.autoColumns.map((c) => c.field)).toEqual(['region', 'category'])
76
+ })
77
+ })
78
+
79
+ describe('paginateGroupedRows (#73)', () => {
80
+ // Ten groups of two rows each - the shape from the issue report, where
81
+ // slicing the flat list by pageSize leaves almost no data on a page.
82
+ const many: R[] = []
83
+ for (let g = 0; g < 10; g += 1) {
84
+ many.push({ id: `g${g}`, depth: 0, group: true })
85
+ many.push({ id: `g${g}r0`, depth: 1 })
86
+ many.push({ id: `g${g}r1`, depth: 1 })
87
+ }
88
+ const base = { getDepth: (r: R) => r.depth, isGroup: (r: R) => !!r.group }
89
+
90
+ it('counts only data rows against pageSize', () => {
91
+ const { rows, dataRowCount } = paginateGroupedRows(many, { ...base, pageIndex: 0, pageSize: 10 })
92
+ expect(dataRowCount).toBe(20)
93
+ // A naive slice would have yielded 10 rows TOTAL, only ~3 of them data.
94
+ expect(rows.filter((r) => !r.group)).toHaveLength(10)
95
+ })
96
+
97
+ it('reprints the banner each page a group appears on', () => {
98
+ const page0 = paginateGroupedRows(many, { ...base, pageIndex: 0, pageSize: 3 }).rows
99
+ expect(page0.map((r) => r.id)).toEqual(['g0', 'g0r0', 'g0r1', 'g1', 'g1r0'])
100
+ // g1 is reprinted because its second row leads the next page.
101
+ const page1 = paginateGroupedRows(many, { ...base, pageIndex: 1, pageSize: 3 }).rows
102
+ expect(page1.map((r) => r.id)).toEqual(['g1', 'g1r1', 'g2', 'g2r0', 'g2r1'])
103
+ })
104
+
105
+ it('emits a banner once for a group spanning many rows on one page', () => {
106
+ const wide: R[] = [{ id: 'g', depth: 0, group: true }]
107
+ for (let i = 0; i < 5; i += 1) wide.push({ id: `r${i}`, depth: 1 })
108
+ const { rows } = paginateGroupedRows(wide, { ...base, pageIndex: 0, pageSize: 5 })
109
+ expect(rows.filter((r) => r.group)).toHaveLength(1)
110
+ expect(rows).toHaveLength(6)
111
+ })
112
+
113
+ it('reprints the whole ancestor chain for nested groups', () => {
114
+ const nested: R[] = [
115
+ { id: 'A', depth: 0, group: true },
116
+ { id: 'A1', depth: 1, group: true },
117
+ { id: 'x', depth: 2 },
118
+ { id: 'y', depth: 2 },
119
+ ]
120
+ const page1 = paginateGroupedRows(nested, { ...base, pageIndex: 1, pageSize: 1 }).rows
121
+ expect(page1.map((r) => r.id)).toEqual(['A', 'A1', 'y'])
122
+ })
123
+
124
+ it('gives a COLLAPSED group its own page slot', () => {
125
+ // All groups collapsed: the flat model is banners only. Treating those as
126
+ // zero-cost headers left every page empty - a real bug caught by the DOM test.
127
+ const collapsed: R[] = []
128
+ for (let g = 0; g < 10; g += 1) collapsed.push({ id: `c${g}`, depth: 0, group: true })
129
+ const { rows, dataRowCount } = paginateGroupedRows(collapsed, {
130
+ ...base,
131
+ isExpanded: () => false,
132
+ pageIndex: 0,
133
+ pageSize: 4,
134
+ })
135
+ expect(dataRowCount).toBe(10)
136
+ expect(rows.map((r) => r.id)).toEqual(['c0', 'c1', 'c2', 'c3'])
137
+ })
138
+
139
+ it('mixes an expanded group with a collapsed sibling', () => {
140
+ const mixed: R[] = [
141
+ { id: 'open', depth: 0, group: true },
142
+ { id: 'o1', depth: 1 },
143
+ { id: 'o2', depth: 1 },
144
+ { id: 'shut', depth: 0, group: true },
145
+ ]
146
+ const { rows, dataRowCount } = paginateGroupedRows(mixed, {
147
+ ...base,
148
+ isExpanded: (r: R) => r.id === 'open',
149
+ pageIndex: 0,
150
+ pageSize: 5,
151
+ })
152
+ // 2 data rows + 1 collapsed group = 3 units; the open banner is free.
153
+ expect(dataRowCount).toBe(3)
154
+ expect(rows.map((r) => r.id)).toEqual(['open', 'o1', 'o2', 'shut'])
155
+ })
156
+
157
+ it('handles an out-of-range page', () => {
158
+ expect(paginateGroupedRows(many, { ...base, pageIndex: 99, pageSize: 10 }).rows).toEqual([])
159
+ })
160
+
161
+ it('leaves ungrouped data untouched', () => {
162
+ const flat: R[] = [{ id: 'a', depth: 0 }, { id: 'b', depth: 0 }, { id: 'c', depth: 0 }]
163
+ const { rows, dataRowCount } = paginateGroupedRows(flat, { ...base, pageIndex: 1, pageSize: 2 })
164
+ expect(dataRowCount).toBe(3)
165
+ expect(rows.map((r) => r.id)).toEqual(['c'])
166
+ })
167
+ })