@svgrid/grid 2.7.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 (264) 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-C4oLsJyj.js → GridMenus-CYzOvmNQ.js} +3 -3
  56. package/dist/cdn/{GridMenus-yEivjNwl.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/{row-drag-touch-Ddaa-QeB.js → row-drag-touch-CycRR65n.js} +12 -10
  74. package/dist/cdn/{src-COC0vnpg.js → src-C8QjSaq-.js} +53 -55
  75. package/dist/cdn/{src-pYGV2rMR.js → src-D0hO2eYN.js} +52 -54
  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/editing.js +22 -13
  80. package/dist/row-drag-touch.d.ts +5 -1
  81. package/dist/row-drag-touch.js +15 -4
  82. package/dist/row-drag.js +7 -3
  83. package/package.json +11 -11
  84. package/src/FlexRender.svelte +96 -96
  85. package/src/GridFooter.svelte +181 -181
  86. package/src/SvAutoComplete.svelte +169 -169
  87. package/src/SvAvatar.svelte +75 -75
  88. package/src/SvCalendar.svelte +503 -503
  89. package/src/SvCalendar.test.ts +226 -226
  90. package/src/SvCarousel.svelte +141 -141
  91. package/src/SvCheckBox.svelte +102 -102
  92. package/src/SvCircularProgress.svelte +109 -109
  93. package/src/SvColorInput.svelte +181 -181
  94. package/src/SvComboBox.svelte +279 -279
  95. package/src/SvContextMenu.svelte +116 -116
  96. package/src/SvCountryInput.svelte +163 -163
  97. package/src/SvDrawer.svelte +254 -254
  98. package/src/SvDropDownList.svelte +378 -378
  99. package/src/SvDurationInput.svelte +126 -126
  100. package/src/SvField.svelte +293 -293
  101. package/src/SvForm.svelte +437 -437
  102. package/src/SvForm.test.ts +411 -411
  103. package/src/SvGrid.types.ts +2092 -2092
  104. package/src/SvGridCellEditor.svelte +748 -744
  105. package/src/SvGridChart.svelte +1716 -1716
  106. package/src/SvGridChartPanel.svelte +485 -485
  107. package/src/SvGridChartView.svelte +70 -70
  108. package/src/SvGridDropdown.svelte +728 -728
  109. package/src/SvGridSelect.svelte +270 -270
  110. package/src/SvGroupCell.svelte +116 -116
  111. package/src/SvListBox.svelte +334 -334
  112. package/src/SvMaskedInput.svelte +122 -122
  113. package/src/SvMenu.svelte +124 -124
  114. package/src/SvMenu.test.ts +97 -97
  115. package/src/SvMenuList.svelte +146 -146
  116. package/src/SvMultiSelect.svelte +293 -293
  117. package/src/SvNumberInput.svelte +172 -172
  118. package/src/SvOtpInput.svelte +158 -158
  119. package/src/SvPasswordInput.svelte +151 -151
  120. package/src/SvPhoneInput.svelte +133 -133
  121. package/src/SvPopover.svelte +197 -197
  122. package/src/SvProgress.svelte +116 -116
  123. package/src/SvRadioGroup.svelte +107 -107
  124. package/src/SvRating.svelte +112 -112
  125. package/src/SvResult.svelte +73 -73
  126. package/src/SvRichText.svelte +211 -211
  127. package/src/SvRowGroupPanel.svelte +170 -170
  128. package/src/SvScrollArea.svelte +61 -61
  129. package/src/SvSlider.svelte +203 -203
  130. package/src/SvSwitchButton.svelte +108 -108
  131. package/src/SvTagsInput.svelte +115 -115
  132. package/src/SvTextInput.svelte +147 -147
  133. package/src/SvTimePicker.svelte +245 -245
  134. package/src/SvToaster.svelte +159 -159
  135. package/src/SvToaster.test.ts +95 -95
  136. package/src/SvToggleButton.svelte +85 -85
  137. package/src/SvTooltip.svelte +161 -161
  138. package/src/SvTour.svelte +208 -208
  139. package/src/SvTree.svelte +444 -444
  140. package/src/SvTreeSelect.svelte +239 -239
  141. package/src/a11y/dismissable.test.ts +119 -119
  142. package/src/a11y/dismissable.ts +114 -114
  143. package/src/a11y.contract.test.ts +49 -49
  144. package/src/a11y.test.ts +59 -59
  145. package/src/a11y.ts +61 -61
  146. package/src/ai.test.ts +502 -502
  147. package/src/ai.ts +1419 -1419
  148. package/src/build-api.coverage.test.ts +633 -633
  149. package/src/build-api.ts +846 -846
  150. package/src/builtin-editors.grid.test.ts +83 -83
  151. package/src/cell-formatting.ts +171 -171
  152. package/src/cell-render.test.ts +513 -513
  153. package/src/cell-render.ts +496 -496
  154. package/src/cell-values.ts +148 -148
  155. package/src/chart-export.ts +202 -202
  156. package/src/chart-view.svelte.ts +36 -36
  157. package/src/chart.ts +2321 -2321
  158. package/src/collaboration.test.ts +104 -104
  159. package/src/collaboration.ts +167 -167
  160. package/src/column-groups.ts +78 -78
  161. package/src/core.performance.test.ts +30 -30
  162. package/src/core.ts +1865 -1865
  163. package/src/createAutocomplete.svelte.ts +132 -132
  164. package/src/createCombobox.svelte.ts +191 -191
  165. package/src/createCountryInput.svelte.ts +157 -157
  166. package/src/createDropdownList.svelte.ts +168 -168
  167. package/src/createForm.svelte.ts +386 -386
  168. package/src/createGrid.svelte.ts +42 -42
  169. package/src/createGrid.test.ts +10 -10
  170. package/src/createGridState.svelte.ts +17 -17
  171. package/src/createListbox.svelte.ts +250 -250
  172. package/src/createMenu.svelte.ts +224 -224
  173. package/src/createPopoverSelect.svelte.ts +213 -213
  174. package/src/createSlider.svelte.ts +191 -191
  175. package/src/createTooltip.svelte.ts +144 -144
  176. package/src/createTree.svelte.ts +322 -322
  177. package/src/datetime/date-core.ts +206 -206
  178. package/src/datetime/date-restrict.ts +61 -61
  179. package/src/datetime/timezone.ts +135 -135
  180. package/src/dock-manager-model.ts +596 -596
  181. package/src/dock-model.ts +374 -374
  182. package/src/editing.test.ts +974 -974
  183. package/src/editing.ts +618 -609
  184. package/src/editor-contract.ts +171 -171
  185. package/src/editor-registry.grid.test.ts +144 -144
  186. package/src/editor-registry.ts +122 -122
  187. package/src/export-data-api.test.ts +126 -126
  188. package/src/export-format.test.ts +107 -107
  189. package/src/export-format.ts +601 -601
  190. package/src/filter-operators.ts +160 -160
  191. package/src/filtering/excel-filters.ts +325 -325
  192. package/src/flex-render.ts +3 -3
  193. package/src/form-field.ts +127 -127
  194. package/src/group-display.test.ts +167 -167
  195. package/src/group-display.ts +200 -200
  196. package/src/headless.ts +87 -87
  197. package/src/js-scroller.svelte.ts +173 -173
  198. package/src/keyboard-handlers.ts +270 -270
  199. package/src/keyboard.test.ts +59 -59
  200. package/src/keyboard.ts +97 -97
  201. package/src/list-nav.test.ts +49 -49
  202. package/src/list-nav.ts +29 -29
  203. package/src/list-option.test.ts +56 -56
  204. package/src/list-option.ts +179 -179
  205. package/src/menus.ts +597 -597
  206. package/src/merge-objects.ts +48 -48
  207. package/src/overlays.test.ts +90 -90
  208. package/src/positioning.ts +268 -268
  209. package/src/render-component.ts +28 -28
  210. package/src/row-drag-touch.ts +226 -211
  211. package/src/row-drag.test.ts +401 -353
  212. package/src/row-drag.ts +419 -415
  213. package/src/row-resize.test.ts +524 -524
  214. package/src/row-resize.ts +228 -228
  215. package/src/scheduler-ical.ts +181 -181
  216. package/src/scheduler-model.test.ts +562 -562
  217. package/src/scheduler-model.ts +873 -873
  218. package/src/selection.test.ts +885 -885
  219. package/src/server-data-source.test.ts +383 -383
  220. package/src/server-data-source.ts +469 -469
  221. package/src/sparkline.test.ts +68 -68
  222. package/src/sparkline.ts +169 -169
  223. package/src/spreadsheet.test.ts +488 -488
  224. package/src/spreadsheet.ts +312 -312
  225. package/src/static-functions.ts +11 -11
  226. package/src/subscribe.ts +38 -38
  227. package/src/summaries.ts +113 -113
  228. package/src/svgrid-wrapper.types.ts +563 -563
  229. package/src/svgrid.async-editor-options.test.ts +273 -273
  230. package/src/svgrid.auto-row-height.test.ts +204 -204
  231. package/src/svgrid.behavior.test.ts +910 -910
  232. package/src/svgrid.charting.test.ts +534 -534
  233. package/src/svgrid.comments-autocomplete.test.ts +127 -127
  234. package/src/svgrid.context-menu.test.ts +147 -147
  235. package/src/svgrid.features.test.ts +157 -157
  236. package/src/svgrid.filter-depth.test.ts +163 -163
  237. package/src/svgrid.filter-menu-listbox.svelte.test.ts +382 -377
  238. package/src/svgrid.filter-menu-scroll.test.ts +112 -112
  239. package/src/svgrid.grand-total.test.ts +188 -188
  240. package/src/svgrid.group-display-mode.test.ts +171 -171
  241. package/src/svgrid.group-footers.test.ts +121 -121
  242. package/src/svgrid.group-pagination.test.ts +153 -153
  243. package/src/svgrid.new-features.wrapper.test.ts +251 -251
  244. package/src/svgrid.tree-data.test.ts +186 -186
  245. package/src/svgrid.wrapper.test.ts +63 -63
  246. package/src/svgriddropdown.async-panel.svelte.test.ts +195 -195
  247. package/src/test-setup.ts +62 -62
  248. package/src/themes/index.ts +288 -288
  249. package/src/toast-store.svelte.ts +250 -250
  250. package/src/toast-store.test.ts +147 -147
  251. package/src/tree-row-model.test.ts +168 -168
  252. package/src/ui-buttons.test.ts +144 -144
  253. package/src/ui-inputs.test.ts +118 -118
  254. package/src/ui-localization.test.ts +113 -113
  255. package/src/ui-range.test.ts +70 -70
  256. package/src/ui-selection.test.ts +155 -155
  257. package/src/ui-tier1.test.ts +142 -142
  258. package/src/virtual.test.ts +88 -88
  259. package/src/virtualization/column-virtualizer.test.ts +27 -27
  260. package/src/virtualization/column-virtualizer.ts +30 -30
  261. package/src/virtualization/svelte-virtualizer.svelte.ts +26 -26
  262. package/src/virtualization/types.ts +30 -30
  263. package/src/virtualization/virtualizer.test.ts +47 -47
  264. package/src/virtualization/virtualizer.ts +322 -322
@@ -1,85 +1,85 @@
1
- <script lang="ts">
2
- /**
3
- * SvToggleButton - a button with a pressed on/off state (aria-pressed).
4
- * Parity: Smart `smart-toggle-button`. Controlled via `pressed` + `onChange`.
5
- */
6
- import type { Snippet } from 'svelte'
7
- import SvField from './SvField.svelte'
8
- import { nextEditorId, type SvEditorProps } from './editor-contract'
9
- import { createToggle } from './createToggle.svelte'
10
-
11
- type Props = SvEditorProps & {
12
- pressed?: boolean
13
- onChange?: (pressed: boolean) => void
14
- children?: Snippet
15
- }
16
-
17
- let {
18
- pressed = false,
19
- onChange,
20
- disabled = false,
21
- readonly = false,
22
- size = 'md',
23
- ariaLabel,
24
- invalid = false,
25
- required = false,
26
- error,
27
- label,
28
- hint,
29
- dir,
30
- id,
31
- children,
32
- }: Props = $props()
33
-
34
- const autoId = nextEditorId('sv-toggle')
35
- const uid = $derived(id ?? autoId)
36
-
37
- // The styled toggle is just a renderer over the headless core.
38
- const t = createToggle({
39
- pressed: () => pressed,
40
- onChange: (v) => { if (readonly) return; onChange?.(v) },
41
- disabled: () => disabled,
42
- ariaLabel: () => ariaLabel,
43
- id: () => uid,
44
- invalid: () => invalid,
45
- required: () => required,
46
- error: () => error,
47
- hint: () => hint,
48
- })
49
- </script>
50
-
51
- <SvField id={uid} {label} {hint} {error} {required} {dir}>
52
- <button
53
- class="sv-toggle sv-toggle--{size}"
54
- class:is-pressed={pressed}
55
- class:is-invalid={invalid}
56
- class:is-readonly={readonly}
57
- {...t.buttonProps()}
58
- >
59
- {#if children}{@render children()}{/if}
60
- </button>
61
- </SvField>
62
-
63
- <style>
64
- .sv-toggle {
65
- --_accent: var(--sg-accent, #2563eb);
66
- --_border: var(--sg-border, #cbd5e1);
67
- --_radius: var(--sg-radius, 8px);
68
- display: inline-flex; align-items: center; justify-content: center; gap: 6px;
69
- font: inherit; font-weight: 600; line-height: 1;
70
- background: var(--sg-bg, #fff); color: var(--sg-fg, #0f172a);
71
- border: 1px solid var(--_border); border-radius: var(--_radius); cursor: pointer; user-select: none;
72
- transition: background 0.12s, border-color 0.12s, color 0.12s;
73
- }
74
- .sv-toggle--sm { padding: 5px 10px; font-size: 12px; }
75
- .sv-toggle--md { padding: 8px 13px; font-size: 13px; }
76
- .sv-toggle--lg { padding: 11px 17px; font-size: 15px; }
77
- .sv-toggle:hover:not([disabled]):not(.is-pressed) { background: var(--sg-row-hover-bg, #f1f5f9); }
78
- .sv-toggle.is-pressed {
79
- background: var(--_accent); color: var(--sg-on-accent, #fff); border-color: var(--_accent);
80
- }
81
- .sv-toggle[disabled] { opacity: 0.55; cursor: not-allowed; }
82
- .sv-toggle.is-readonly { cursor: default; }
83
- .sv-toggle.is-invalid { border-color: var(--sg-danger, #dc2626); }
84
- .sv-toggle:focus-visible { outline: 2px solid var(--sg-focus-ring, var(--_accent)); outline-offset: 2px; }
85
- </style>
1
+ <script lang="ts">
2
+ /**
3
+ * SvToggleButton - a button with a pressed on/off state (aria-pressed).
4
+ * Parity: Smart `smart-toggle-button`. Controlled via `pressed` + `onChange`.
5
+ */
6
+ import type { Snippet } from 'svelte'
7
+ import SvField from './SvField.svelte'
8
+ import { nextEditorId, type SvEditorProps } from './editor-contract'
9
+ import { createToggle } from './createToggle.svelte'
10
+
11
+ type Props = SvEditorProps & {
12
+ pressed?: boolean
13
+ onChange?: (pressed: boolean) => void
14
+ children?: Snippet
15
+ }
16
+
17
+ let {
18
+ pressed = false,
19
+ onChange,
20
+ disabled = false,
21
+ readonly = false,
22
+ size = 'md',
23
+ ariaLabel,
24
+ invalid = false,
25
+ required = false,
26
+ error,
27
+ label,
28
+ hint,
29
+ dir,
30
+ id,
31
+ children,
32
+ }: Props = $props()
33
+
34
+ const autoId = nextEditorId('sv-toggle')
35
+ const uid = $derived(id ?? autoId)
36
+
37
+ // The styled toggle is just a renderer over the headless core.
38
+ const t = createToggle({
39
+ pressed: () => pressed,
40
+ onChange: (v) => { if (readonly) return; onChange?.(v) },
41
+ disabled: () => disabled,
42
+ ariaLabel: () => ariaLabel,
43
+ id: () => uid,
44
+ invalid: () => invalid,
45
+ required: () => required,
46
+ error: () => error,
47
+ hint: () => hint,
48
+ })
49
+ </script>
50
+
51
+ <SvField id={uid} {label} {hint} {error} {required} {dir}>
52
+ <button
53
+ class="sv-toggle sv-toggle--{size}"
54
+ class:is-pressed={pressed}
55
+ class:is-invalid={invalid}
56
+ class:is-readonly={readonly}
57
+ {...t.buttonProps()}
58
+ >
59
+ {#if children}{@render children()}{/if}
60
+ </button>
61
+ </SvField>
62
+
63
+ <style>
64
+ .sv-toggle {
65
+ --_accent: var(--sg-accent, #2563eb);
66
+ --_border: var(--sg-border, #cbd5e1);
67
+ --_radius: var(--sg-radius, 8px);
68
+ display: inline-flex; align-items: center; justify-content: center; gap: 6px;
69
+ font: inherit; font-weight: 600; line-height: 1;
70
+ background: var(--sg-bg, #fff); color: var(--sg-fg, #0f172a);
71
+ border: 1px solid var(--_border); border-radius: var(--_radius); cursor: pointer; user-select: none;
72
+ transition: background 0.12s, border-color 0.12s, color 0.12s;
73
+ }
74
+ .sv-toggle--sm { padding: 5px 10px; font-size: 12px; }
75
+ .sv-toggle--md { padding: 8px 13px; font-size: 13px; }
76
+ .sv-toggle--lg { padding: 11px 17px; font-size: 15px; }
77
+ .sv-toggle:hover:not([disabled]):not(.is-pressed) { background: var(--sg-row-hover-bg, #f1f5f9); }
78
+ .sv-toggle.is-pressed {
79
+ background: var(--_accent); color: var(--sg-on-accent, #fff); border-color: var(--_accent);
80
+ }
81
+ .sv-toggle[disabled] { opacity: 0.55; cursor: not-allowed; }
82
+ .sv-toggle.is-readonly { cursor: default; }
83
+ .sv-toggle.is-invalid { border-color: var(--sg-danger, #dc2626); }
84
+ .sv-toggle:focus-visible { outline: 2px solid var(--sg-focus-ring, var(--_accent)); outline-offset: 2px; }
85
+ </style>
@@ -1,161 +1,161 @@
1
- <script lang="ts">
2
- /**
3
- * SvTooltip - a small hover/focus tooltip anchored to its child, portalled to
4
- * <body> so it is never clipped. Positioned by the shared engine (full placement
5
- * matrix + flip + shift + arrow), shows after a short delay, hides on leave /
6
- * blur / Escape, and is wired via `aria-describedby` (role="tooltip") onto the
7
- * focusable child itself, so AT users get it announced on focus, not just
8
- * sighted users on hover.
9
- *
10
- * Set `group` on several tooltips so scanning between them skips the re-delay,
11
- * `closeDelay` + `interactive` for a hoverable tip (e.g. one with a link).
12
- *
13
- * ```svelte
14
- * <SvTooltip text="Delete row"><button aria-label="Delete">🗑</button></SvTooltip>
15
- * ```
16
- */
17
- import type { Snippet } from 'svelte'
18
- import { portalToBody, popIn } from './popover'
19
- import { computePosition, autoUpdate, type Placement, type ComputePositionResult } from './positioning'
20
- import { getFocusable } from './a11y/focus-trap'
21
- import { createTooltip } from './createTooltip.svelte'
22
-
23
- type Props = {
24
- text: string
25
- /** Preferred placement; flips when there is no room. Default `top`. */
26
- placement?: Placement
27
- /** Show delay in ms. Default 300. */
28
- delay?: number
29
- /** Hide delay in ms after leave (give it room for an interactive tip). Default 0. */
30
- closeDelay?: number
31
- /** Delay-group id: grouped tooltips open instantly while the group is warm. */
32
- group?: string
33
- /** Let the pointer move onto the tip without closing it (e.g. a tip with a link). */
34
- interactive?: boolean
35
- disabled?: boolean
36
- children?: Snippet
37
- }
38
-
39
- let {
40
- text,
41
- placement = 'top',
42
- delay = 300,
43
- closeDelay = 0,
44
- group,
45
- interactive = false,
46
- disabled = false,
47
- children,
48
- }: Props = $props()
49
-
50
- const ARROW = 8
51
-
52
- let anchorEl = $state<HTMLSpanElement | null>(null)
53
- let tipEl = $state<HTMLDivElement | null>(null)
54
- let pos = $state<ComputePositionResult>({
55
- x: 0, y: 0, placement, side: 'top', align: 'center', maxWidth: 0, maxHeight: 0, arrow: { x: 12 },
56
- })
57
-
58
- // Open state, show/close delay, delay-group and Escape-to-hide live in the
59
- // shared headless core; this component owns only the DOM concerns (positioning
60
- // + describedby merge). Interactive tips get a small closeDelay by default so
61
- // the pointer can travel from anchor to tip.
62
- const tip = createTooltip({
63
- text: () => text,
64
- disabled: () => disabled,
65
- delay: () => delay,
66
- closeDelay: () => (closeDelay || (interactive ? 120 : 0)),
67
- group: () => group,
68
- })
69
- const tid = tip.tipId
70
-
71
- function place() {
72
- if (!anchorEl) return
73
- const r = anchorEl.getBoundingClientRect()
74
- const floating = { width: tipEl?.offsetWidth || 0, height: tipEl?.offsetHeight || 30 }
75
- pos = computePosition(
76
- { x: r.left, y: r.top, width: r.width, height: r.height },
77
- floating,
78
- { placement, offset: 8, padding: 4, arrow: { size: ARROW } },
79
- )
80
- }
81
-
82
- // Reposition while open (measure the tip after it mounts, then keep in sync).
83
- $effect(() => {
84
- if (!tip.open || !anchorEl || !tipEl) return
85
- queueMicrotask(place)
86
- const stop = autoUpdate(anchorEl, tipEl, place)
87
- return () => stop()
88
- })
89
-
90
- // The wrapper span above is never itself Tab-focusable, so putting
91
- // aria-describedby only on it does nothing for keyboard/AT users - they
92
- // focus the real interactive child (e.g. the <button> in the doc example),
93
- // and that's the element whose accessible description actually gets
94
- // announced. Mirror the id onto that child too, merging with (and later
95
- // restoring) any aria-describedby it already carries.
96
- $effect(() => {
97
- if (!tip.open || !anchorEl) return
98
- const child = getFocusable(anchorEl)[0]
99
- if (!child) return
100
- const before = child.getAttribute('aria-describedby')
101
- const ids = new Set((before ?? '').split(/\s+/).filter(Boolean))
102
- ids.add(tid)
103
- child.setAttribute('aria-describedby', [...ids].join(' '))
104
- return () => {
105
- const remaining = (child.getAttribute('aria-describedby') ?? '')
106
- .split(/\s+/)
107
- .filter((id) => id && id !== tid)
108
- if (remaining.length) child.setAttribute('aria-describedby', remaining.join(' '))
109
- else child.removeAttribute('aria-describedby')
110
- }
111
- })
112
- </script>
113
-
114
- <!-- svelte-ignore a11y_no_static_element_interactions -->
115
- <span
116
- bind:this={anchorEl}
117
- class="sv-tip__anchor"
118
- {...tip.anchorProps()}
119
- >
120
- {@render children?.()}
121
- </span>
122
-
123
- {#if tip.open}
124
- <div
125
- bind:this={tipEl}
126
- id={tid}
127
- class="sv-tip sv-tip--{pos.side}"
128
- class:sv-tip--interactive={interactive}
129
- role="tooltip"
130
- use:portalToBody
131
- use:popIn={{ up: pos.side === 'top', duration: 110, scale: 0.9 }}
132
- style:position="fixed"
133
- style:top={`${pos.y}px`}
134
- style:left={`${pos.x}px`}
135
- style:--tip-arrow-x={pos.arrow?.x != null ? `${pos.arrow.x}px` : undefined}
136
- style:--tip-arrow-y={pos.arrow?.y != null ? `${pos.arrow.y}px` : undefined}
137
- onpointerenter={interactive ? tip.keepOpen : undefined}
138
- onpointerleave={interactive ? tip.scheduleHide : undefined}
139
- >{text}<span class="sv-tip__arrow" aria-hidden="true"></span></div>
140
- {/if}
141
-
142
- <style>
143
- .sv-tip__anchor { display: inline-flex; }
144
- :global(.sv-tip) {
145
- z-index: 2147483647; pointer-events: none; position: relative;
146
- max-width: 240px; padding: 5px 9px; font-size: 12px; line-height: 1.4; font-weight: 500;
147
- background: var(--sg-fg, #0f172a); color: var(--sg-bg, #fff);
148
- border-radius: 6px; box-shadow: 0 6px 20px -6px rgba(15, 23, 42, 0.5); white-space: normal;
149
- }
150
- :global(.sv-tip--interactive) { pointer-events: auto; }
151
- :global(.sv-tip__arrow) {
152
- position: absolute; width: 8px; height: 8px;
153
- background: var(--sg-fg, #0f172a); transform: rotate(45deg);
154
- }
155
- /* Arrow sits on the edge facing the anchor. top/bottom use --tip-arrow-x,
156
- left/right use --tip-arrow-y. */
157
- :global(.sv-tip--top .sv-tip__arrow) { bottom: -3px; inset-inline-start: var(--tip-arrow-x, 12px); }
158
- :global(.sv-tip--bottom .sv-tip__arrow) { top: -3px; inset-inline-start: var(--tip-arrow-x, 12px); }
159
- :global(.sv-tip--left .sv-tip__arrow) { right: -3px; top: var(--tip-arrow-y, 12px); }
160
- :global(.sv-tip--right .sv-tip__arrow) { left: -3px; top: var(--tip-arrow-y, 12px); }
161
- </style>
1
+ <script lang="ts">
2
+ /**
3
+ * SvTooltip - a small hover/focus tooltip anchored to its child, portalled to
4
+ * <body> so it is never clipped. Positioned by the shared engine (full placement
5
+ * matrix + flip + shift + arrow), shows after a short delay, hides on leave /
6
+ * blur / Escape, and is wired via `aria-describedby` (role="tooltip") onto the
7
+ * focusable child itself, so AT users get it announced on focus, not just
8
+ * sighted users on hover.
9
+ *
10
+ * Set `group` on several tooltips so scanning between them skips the re-delay,
11
+ * `closeDelay` + `interactive` for a hoverable tip (e.g. one with a link).
12
+ *
13
+ * ```svelte
14
+ * <SvTooltip text="Delete row"><button aria-label="Delete">🗑</button></SvTooltip>
15
+ * ```
16
+ */
17
+ import type { Snippet } from 'svelte'
18
+ import { portalToBody, popIn } from './popover'
19
+ import { computePosition, autoUpdate, type Placement, type ComputePositionResult } from './positioning'
20
+ import { getFocusable } from './a11y/focus-trap'
21
+ import { createTooltip } from './createTooltip.svelte'
22
+
23
+ type Props = {
24
+ text: string
25
+ /** Preferred placement; flips when there is no room. Default `top`. */
26
+ placement?: Placement
27
+ /** Show delay in ms. Default 300. */
28
+ delay?: number
29
+ /** Hide delay in ms after leave (give it room for an interactive tip). Default 0. */
30
+ closeDelay?: number
31
+ /** Delay-group id: grouped tooltips open instantly while the group is warm. */
32
+ group?: string
33
+ /** Let the pointer move onto the tip without closing it (e.g. a tip with a link). */
34
+ interactive?: boolean
35
+ disabled?: boolean
36
+ children?: Snippet
37
+ }
38
+
39
+ let {
40
+ text,
41
+ placement = 'top',
42
+ delay = 300,
43
+ closeDelay = 0,
44
+ group,
45
+ interactive = false,
46
+ disabled = false,
47
+ children,
48
+ }: Props = $props()
49
+
50
+ const ARROW = 8
51
+
52
+ let anchorEl = $state<HTMLSpanElement | null>(null)
53
+ let tipEl = $state<HTMLDivElement | null>(null)
54
+ let pos = $state<ComputePositionResult>({
55
+ x: 0, y: 0, placement, side: 'top', align: 'center', maxWidth: 0, maxHeight: 0, arrow: { x: 12 },
56
+ })
57
+
58
+ // Open state, show/close delay, delay-group and Escape-to-hide live in the
59
+ // shared headless core; this component owns only the DOM concerns (positioning
60
+ // + describedby merge). Interactive tips get a small closeDelay by default so
61
+ // the pointer can travel from anchor to tip.
62
+ const tip = createTooltip({
63
+ text: () => text,
64
+ disabled: () => disabled,
65
+ delay: () => delay,
66
+ closeDelay: () => (closeDelay || (interactive ? 120 : 0)),
67
+ group: () => group,
68
+ })
69
+ const tid = tip.tipId
70
+
71
+ function place() {
72
+ if (!anchorEl) return
73
+ const r = anchorEl.getBoundingClientRect()
74
+ const floating = { width: tipEl?.offsetWidth || 0, height: tipEl?.offsetHeight || 30 }
75
+ pos = computePosition(
76
+ { x: r.left, y: r.top, width: r.width, height: r.height },
77
+ floating,
78
+ { placement, offset: 8, padding: 4, arrow: { size: ARROW } },
79
+ )
80
+ }
81
+
82
+ // Reposition while open (measure the tip after it mounts, then keep in sync).
83
+ $effect(() => {
84
+ if (!tip.open || !anchorEl || !tipEl) return
85
+ queueMicrotask(place)
86
+ const stop = autoUpdate(anchorEl, tipEl, place)
87
+ return () => stop()
88
+ })
89
+
90
+ // The wrapper span above is never itself Tab-focusable, so putting
91
+ // aria-describedby only on it does nothing for keyboard/AT users - they
92
+ // focus the real interactive child (e.g. the <button> in the doc example),
93
+ // and that's the element whose accessible description actually gets
94
+ // announced. Mirror the id onto that child too, merging with (and later
95
+ // restoring) any aria-describedby it already carries.
96
+ $effect(() => {
97
+ if (!tip.open || !anchorEl) return
98
+ const child = getFocusable(anchorEl)[0]
99
+ if (!child) return
100
+ const before = child.getAttribute('aria-describedby')
101
+ const ids = new Set((before ?? '').split(/\s+/).filter(Boolean))
102
+ ids.add(tid)
103
+ child.setAttribute('aria-describedby', [...ids].join(' '))
104
+ return () => {
105
+ const remaining = (child.getAttribute('aria-describedby') ?? '')
106
+ .split(/\s+/)
107
+ .filter((id) => id && id !== tid)
108
+ if (remaining.length) child.setAttribute('aria-describedby', remaining.join(' '))
109
+ else child.removeAttribute('aria-describedby')
110
+ }
111
+ })
112
+ </script>
113
+
114
+ <!-- svelte-ignore a11y_no_static_element_interactions -->
115
+ <span
116
+ bind:this={anchorEl}
117
+ class="sv-tip__anchor"
118
+ {...tip.anchorProps()}
119
+ >
120
+ {@render children?.()}
121
+ </span>
122
+
123
+ {#if tip.open}
124
+ <div
125
+ bind:this={tipEl}
126
+ id={tid}
127
+ class="sv-tip sv-tip--{pos.side}"
128
+ class:sv-tip--interactive={interactive}
129
+ role="tooltip"
130
+ use:portalToBody
131
+ use:popIn={{ up: pos.side === 'top', duration: 110, scale: 0.9 }}
132
+ style:position="fixed"
133
+ style:top={`${pos.y}px`}
134
+ style:left={`${pos.x}px`}
135
+ style:--tip-arrow-x={pos.arrow?.x != null ? `${pos.arrow.x}px` : undefined}
136
+ style:--tip-arrow-y={pos.arrow?.y != null ? `${pos.arrow.y}px` : undefined}
137
+ onpointerenter={interactive ? tip.keepOpen : undefined}
138
+ onpointerleave={interactive ? tip.scheduleHide : undefined}
139
+ >{text}<span class="sv-tip__arrow" aria-hidden="true"></span></div>
140
+ {/if}
141
+
142
+ <style>
143
+ .sv-tip__anchor { display: inline-flex; }
144
+ :global(.sv-tip) {
145
+ z-index: 2147483647; pointer-events: none; position: relative;
146
+ max-width: 240px; padding: 5px 9px; font-size: 12px; line-height: 1.4; font-weight: 500;
147
+ background: var(--sg-fg, #0f172a); color: var(--sg-bg, #fff);
148
+ border-radius: 6px; box-shadow: 0 6px 20px -6px rgba(15, 23, 42, 0.5); white-space: normal;
149
+ }
150
+ :global(.sv-tip--interactive) { pointer-events: auto; }
151
+ :global(.sv-tip__arrow) {
152
+ position: absolute; width: 8px; height: 8px;
153
+ background: var(--sg-fg, #0f172a); transform: rotate(45deg);
154
+ }
155
+ /* Arrow sits on the edge facing the anchor. top/bottom use --tip-arrow-x,
156
+ left/right use --tip-arrow-y. */
157
+ :global(.sv-tip--top .sv-tip__arrow) { bottom: -3px; inset-inline-start: var(--tip-arrow-x, 12px); }
158
+ :global(.sv-tip--bottom .sv-tip__arrow) { top: -3px; inset-inline-start: var(--tip-arrow-x, 12px); }
159
+ :global(.sv-tip--left .sv-tip__arrow) { right: -3px; top: var(--tip-arrow-y, 12px); }
160
+ :global(.sv-tip--right .sv-tip__arrow) { left: -3px; top: var(--tip-arrow-y, 12px); }
161
+ </style>