@svgrid/grid 2.2.27 → 2.2.29

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 (248) hide show
  1. package/README.md +199 -199
  2. package/dist/FlexRender.svelte +96 -96
  3. package/dist/GridFooter.svelte +179 -179
  4. package/dist/GridMenus.svelte +782 -734
  5. package/dist/SvAutoComplete.svelte +165 -165
  6. package/dist/SvCalendar.svelte +503 -503
  7. package/dist/SvCarousel.svelte +141 -141
  8. package/dist/SvCheckBox.svelte +101 -101
  9. package/dist/SvColorInput.svelte +181 -181
  10. package/dist/SvComboBox.svelte +275 -275
  11. package/dist/SvContextMenu.svelte +116 -116
  12. package/dist/SvCountryInput.svelte +160 -160
  13. package/dist/SvDrawer.svelte +254 -250
  14. package/dist/SvDropDownList.svelte +374 -374
  15. package/dist/SvDurationInput.svelte +126 -126
  16. package/dist/SvField.svelte +293 -293
  17. package/dist/SvForm.svelte +437 -437
  18. package/dist/SvGrid.controller.svelte.d.ts +14 -1
  19. package/dist/SvGrid.controller.svelte.js +112 -28
  20. package/dist/SvGrid.css +2704 -2723
  21. package/dist/SvGrid.svelte +3361 -3333
  22. package/dist/SvGrid.types.d.ts +20 -5
  23. package/dist/SvGridChart.svelte +1724 -1724
  24. package/dist/SvGridChartPanel.svelte +485 -485
  25. package/dist/SvGridChartView.svelte +70 -70
  26. package/dist/SvGridDropdown.svelte +696 -696
  27. package/dist/SvGridSelect.svelte +259 -259
  28. package/dist/SvGroupCell.svelte +109 -109
  29. package/dist/SvListBox.svelte +326 -287
  30. package/dist/SvListBox.svelte.d.ts +10 -1
  31. package/dist/SvMaskedInput.svelte +122 -122
  32. package/dist/SvMenu.svelte +124 -124
  33. package/dist/SvMenuList.svelte +146 -146
  34. package/dist/SvMultiSelect.svelte +281 -281
  35. package/dist/SvNumberInput.svelte +168 -168
  36. package/dist/SvOtpInput.svelte +158 -158
  37. package/dist/SvPasswordInput.svelte +151 -151
  38. package/dist/SvPhoneInput.svelte +133 -131
  39. package/dist/SvPopover.svelte +197 -197
  40. package/dist/SvRadioGroup.svelte +107 -107
  41. package/dist/SvRowGroupPanel.svelte +170 -170
  42. package/dist/SvScrollArea.svelte +61 -61
  43. package/dist/SvSlider.svelte +200 -200
  44. package/dist/SvSwitchButton.svelte +107 -107
  45. package/dist/SvTagsInput.svelte +112 -112
  46. package/dist/SvTextInput.svelte +147 -147
  47. package/dist/SvTimePicker.svelte +245 -245
  48. package/dist/SvToaster.svelte +159 -159
  49. package/dist/SvToggleButton.svelte +85 -85
  50. package/dist/SvTooltip.svelte +161 -161
  51. package/dist/SvTour.svelte +204 -204
  52. package/dist/SvTree.svelte +437 -437
  53. package/dist/SvTreeSelect.svelte +233 -233
  54. package/dist/cdn/GridMenus-Da_p7SKS.js +486 -0
  55. package/dist/cdn/GridMenus-Ds3OpzZT.js +490 -0
  56. package/dist/cdn/{SvDateTimePicker-B1sDc9Pz.js → SvDateTimePicker-B8GopjhC.js} +2 -2
  57. package/dist/cdn/{SvDateTimePicker-Bh0FTs1E.js → SvDateTimePicker-DB0aIEk8.js} +2 -2
  58. package/dist/cdn/{SvGridChart-Bgk4hDs8.js → SvGridChart-BcLCYvw9.js} +1 -1
  59. package/dist/cdn/{SvGridChart-BKQsO5fZ.js → SvGridChart-BhnFdLd0.js} +1 -1
  60. package/dist/cdn/{SvGridChartPanel-DkCc2Z7b.js → SvGridChartPanel-Cmx9DHAS.js} +1 -1
  61. package/dist/cdn/{SvGridChartPanel-DSkHIQDd.js → SvGridChartPanel-DvjwxLvK.js} +1 -1
  62. package/dist/cdn/{SvGridChartView-BrbVaELm.js → SvGridChartView-B40DTJSX.js} +1 -1
  63. package/dist/cdn/{SvGridChartView-i9rWvSKg.js → SvGridChartView-PwqI4s02.js} +1 -1
  64. package/dist/cdn/{SvGridDropdown-D08sVmAy.js → SvGridDropdown-DjALc_4f.js} +1 -1
  65. package/dist/cdn/{SvGridDropdown-CGxxopQ4.js → SvGridDropdown-hpnHvOGt.js} +1 -1
  66. package/dist/cdn/{src-cgs1wcUS.js → src-BLJfdyL0.js} +4034 -3889
  67. package/dist/cdn/{src-Cw8d9U8j.js → src-DYDCiC0D.js} +7053 -6908
  68. package/dist/cdn/svgrid.js +9 -9
  69. package/dist/cdn/svgrid.svelte-external.js +9 -9
  70. package/dist/chart-export.js +8 -8
  71. package/dist/column-groups.js +8 -10
  72. package/dist/column-id.d.ts +9 -0
  73. package/dist/column-id.js +25 -0
  74. package/dist/core.js +2 -1
  75. package/dist/createListbox.svelte.d.ts +15 -2
  76. package/dist/createListbox.svelte.js +27 -6
  77. package/dist/editing.d.ts +1 -0
  78. package/dist/editing.js +45 -10
  79. package/dist/filtering/excel-filters.d.ts +30 -10
  80. package/dist/filtering/excel-filters.js +96 -15
  81. package/dist/index.d.ts +2 -2
  82. package/dist/index.js +2 -2
  83. package/dist/menus.d.ts +2 -0
  84. package/dist/menus.js +25 -0
  85. package/dist/row-resize.js +40 -0
  86. package/dist/selection.js +1 -1
  87. package/package.json +10 -10
  88. package/src/FlexRender.svelte +96 -96
  89. package/src/GridFooter.svelte +179 -179
  90. package/src/GridMenus.svelte +782 -734
  91. package/src/SvAutoComplete.svelte +165 -165
  92. package/src/SvCalendar.svelte +503 -503
  93. package/src/SvCalendar.test.ts +226 -226
  94. package/src/SvCarousel.svelte +141 -141
  95. package/src/SvCheckBox.svelte +101 -101
  96. package/src/SvColorInput.svelte +181 -181
  97. package/src/SvComboBox.svelte +275 -275
  98. package/src/SvContextMenu.svelte +116 -116
  99. package/src/SvCountryInput.svelte +160 -160
  100. package/src/SvDrawer.svelte +254 -250
  101. package/src/SvDrawer.test.ts +18 -1
  102. package/src/SvDropDownList.svelte +374 -374
  103. package/src/SvDurationInput.svelte +126 -126
  104. package/src/SvField.svelte +293 -293
  105. package/src/SvForm.svelte +437 -437
  106. package/src/SvForm.test.ts +411 -411
  107. package/src/SvGrid.controller.svelte.ts +3335 -3239
  108. package/src/SvGrid.css +2704 -2723
  109. package/src/SvGrid.svelte +3361 -3333
  110. package/src/SvGrid.types.ts +1628 -1613
  111. package/src/SvGridChart.svelte +1724 -1724
  112. package/src/SvGridChartPanel.svelte +485 -485
  113. package/src/SvGridChartView.svelte +70 -70
  114. package/src/SvGridDropdown.svelte +696 -696
  115. package/src/SvGridSelect.svelte +259 -259
  116. package/src/SvGroupCell.svelte +109 -109
  117. package/src/SvListBox.svelte +326 -287
  118. package/src/SvMaskedInput.svelte +122 -122
  119. package/src/SvMenu.svelte +124 -124
  120. package/src/SvMenu.test.ts +97 -97
  121. package/src/SvMenuList.svelte +146 -146
  122. package/src/SvMultiSelect.svelte +281 -281
  123. package/src/SvNavPane.test.ts +15 -4
  124. package/src/SvNumberInput.svelte +168 -168
  125. package/src/SvOtpInput.svelte +158 -158
  126. package/src/SvPasswordInput.svelte +151 -151
  127. package/src/SvPhoneInput.svelte +133 -131
  128. package/src/SvPopover.svelte +197 -197
  129. package/src/SvRadioGroup.svelte +107 -107
  130. package/src/SvRowGroupPanel.svelte +170 -170
  131. package/src/SvScrollArea.svelte +61 -61
  132. package/src/SvSlider.svelte +200 -200
  133. package/src/SvSwitchButton.svelte +107 -107
  134. package/src/SvTagsInput.svelte +112 -112
  135. package/src/SvTextInput.svelte +147 -147
  136. package/src/SvTimePicker.svelte +245 -245
  137. package/src/SvToaster.svelte +159 -159
  138. package/src/SvToaster.test.ts +95 -95
  139. package/src/SvToggleButton.svelte +85 -85
  140. package/src/SvTooltip.svelte +161 -161
  141. package/src/SvTour.svelte +204 -204
  142. package/src/SvTree.svelte +437 -437
  143. package/src/SvTreeSelect.svelte +233 -233
  144. package/src/a11y/dismissable.test.ts +119 -119
  145. package/src/a11y/dismissable.ts +114 -114
  146. package/src/a11y.contract.test.ts +49 -49
  147. package/src/a11y.test.ts +59 -59
  148. package/src/a11y.ts +61 -61
  149. package/src/ai.test.ts +502 -502
  150. package/src/ai.ts +1391 -1391
  151. package/src/build-api.coverage.test.ts +633 -633
  152. package/src/build-api.ts +895 -895
  153. package/src/builtin-editors.grid.test.ts +85 -85
  154. package/src/cell-formatting.ts +169 -169
  155. package/src/cell-render.ts +469 -469
  156. package/src/chart-export.ts +201 -201
  157. package/src/chart-view.svelte.ts +36 -36
  158. package/src/chart.ts +2296 -2296
  159. package/src/collaboration.test.ts +104 -104
  160. package/src/collaboration.ts +167 -167
  161. package/src/column-groups.test.ts +48 -0
  162. package/src/column-groups.ts +8 -10
  163. package/src/column-id.ts +30 -0
  164. package/src/core.performance.test.ts +30 -30
  165. package/src/core.ts +1112 -1111
  166. package/src/createAutocomplete.svelte.ts +132 -132
  167. package/src/createCombobox.svelte.ts +191 -191
  168. package/src/createCountryInput.svelte.ts +157 -157
  169. package/src/createDropdownList.svelte.ts +168 -168
  170. package/src/createForm.svelte.ts +386 -386
  171. package/src/createGrid.svelte.ts +42 -42
  172. package/src/createGrid.test.ts +10 -10
  173. package/src/createGridState.svelte.ts +17 -17
  174. package/src/createListbox.svelte.ts +39 -7
  175. package/src/createMenu.svelte.ts +225 -225
  176. package/src/createPopoverSelect.svelte.ts +213 -213
  177. package/src/createSlider.svelte.ts +191 -191
  178. package/src/createTooltip.svelte.ts +144 -144
  179. package/src/createTree.svelte.ts +319 -319
  180. package/src/editing.test.ts +949 -859
  181. package/src/editing.ts +709 -675
  182. package/src/editor-contract.ts +157 -157
  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 +598 -598
  186. package/src/filter-operators.ts +157 -157
  187. package/src/filtering/excel-filters.test.ts +44 -1
  188. package/src/filtering/excel-filters.ts +91 -14
  189. package/src/flex-render.ts +3 -3
  190. package/src/form-field.ts +127 -127
  191. package/src/index.ts +715 -713
  192. package/src/js-scroller.svelte.ts +173 -173
  193. package/src/keyboard.test.ts +59 -59
  194. package/src/keyboard.ts +97 -97
  195. package/src/list-nav.test.ts +49 -49
  196. package/src/list-nav.ts +29 -29
  197. package/src/list-option.test.ts +56 -56
  198. package/src/list-option.ts +172 -172
  199. package/src/menus.test.ts +736 -700
  200. package/src/menus.ts +679 -652
  201. package/src/merge-objects.ts +48 -48
  202. package/src/overlays.test.ts +90 -90
  203. package/src/render-component.ts +28 -28
  204. package/src/row-resize.test.ts +100 -0
  205. package/src/row-resize.ts +36 -0
  206. package/src/scheduler-model.test.ts +562 -562
  207. package/src/scheduler-model.ts +872 -872
  208. package/src/selection.test.ts +754 -754
  209. package/src/selection.ts +600 -600
  210. package/src/server-data-source.test.ts +289 -289
  211. package/src/server-data-source.ts +413 -413
  212. package/src/sparkline.test.ts +68 -68
  213. package/src/sparkline.ts +169 -169
  214. package/src/spreadsheet.test.ts +489 -489
  215. package/src/spreadsheet.ts +312 -312
  216. package/src/static-functions.ts +11 -11
  217. package/src/subscribe.ts +38 -38
  218. package/src/svgrid-wrapper.types.ts +524 -524
  219. package/src/svgrid.api-extensions.test.ts +8 -3
  220. package/src/svgrid.behavior.test.ts +706 -706
  221. package/src/svgrid.cell-dom-ids.test.ts +96 -0
  222. package/src/svgrid.charting.test.ts +534 -534
  223. package/src/svgrid.conditional-stat-scope.test.ts +111 -0
  224. package/src/svgrid.features.test.ts +157 -157
  225. package/src/svgrid.filter-menu-listbox.svelte.test.ts +308 -0
  226. package/src/svgrid.filter-menu-scroll.test.ts +3 -1
  227. package/src/svgrid.group-header-ids.test.ts +121 -0
  228. package/src/svgrid.new-features.wrapper.test.ts +251 -251
  229. package/src/svgrid.wrapper.test.ts +40 -40
  230. package/src/test-setup.ts +62 -62
  231. package/src/themes/index.ts +215 -215
  232. package/src/toast-store.svelte.ts +246 -246
  233. package/src/toast-store.test.ts +147 -147
  234. package/src/ui-buttons.test.ts +144 -144
  235. package/src/ui-inputs.test.ts +118 -118
  236. package/src/ui-range.test.ts +70 -70
  237. package/src/ui-selection.test.ts +155 -155
  238. package/src/ui-tier1.test.ts +142 -142
  239. package/src/virtual.test.ts +88 -88
  240. package/src/virtualization/column-virtualizer.test.ts +27 -27
  241. package/src/virtualization/column-virtualizer.ts +30 -30
  242. package/src/virtualization/svelte-virtualizer.svelte.ts +26 -26
  243. package/src/virtualization/types.ts +30 -30
  244. package/src/virtualization/virtualizer.test.ts +47 -47
  245. package/src/virtualization/virtualizer.ts +296 -296
  246. package/themes/ember.css +71 -71
  247. package/dist/cdn/GridMenus-BzxEYNtW.js +0 -421
  248. package/dist/cdn/GridMenus-Dr-nGEXn.js +0 -417
@@ -1,250 +1,254 @@
1
- <script lang="ts">
2
- /**
3
- * SvDrawer - an edge-anchored side sheet (right / left / top / bottom): a
4
- * backdrop, a sliding panel, and the full dialog a11y contract. Built entirely
5
- * on the shared primitives - `createFocusTrap`, `lockScroll` and
6
- * `createDismissableLayer` - so its focus, scroll-lock and Escape/backdrop
7
- * behaviour is identical to SvModal and nested overlays close top-first.
8
- * Portalled to <body>. Controlled via `open`.
9
- *
10
- * ```svelte
11
- * <SvDrawer bind:open side="right" title="Filters">
12
- * <p>Body</p>
13
- * {#snippet footer()}<button onclick={() => open = false}>Apply</button>{/snippet}
14
- * </SvDrawer>
15
- * ```
16
- */
17
- import type { Snippet } from 'svelte'
18
- import { untrack } from 'svelte'
19
- import { portalToBody } from './popover'
20
- import { nextEditorId } from './editor-contract'
21
- import { createOverlay } from './createOverlay.svelte'
22
-
23
- /** Edge the drawer slides from. Kept in sync with the `DrawerSide` export in
24
- * index.ts (a bare type-only module script trips the Svelte/Vite parser). */
25
- type DrawerSide = 'right' | 'left' | 'top' | 'bottom'
26
-
27
- type Props = {
28
- open?: boolean
29
- onClose?: () => void
30
- /** Edge the drawer slides from. Default 'right'. */
31
- side?: DrawerSide
32
- /** Panel size along its axis (width for left/right, height for top/bottom).
33
- * Any CSS length; defaults to a sensible per-axis value. */
34
- size?: string
35
- title?: string
36
- closeOnBackdrop?: boolean
37
- closeOnEsc?: boolean
38
- /** Hide the header close (x) button. */
39
- hideClose?: boolean
40
- /** Render as a mobile bottom-sheet: bottom-anchored, rounded top, a grab
41
- * handle, and swipe-down-to-close. Overrides `side`. */
42
- sheet?: boolean
43
- /** Accessible name when there is no visible `title`. */
44
- ariaLabel?: string
45
- /** Fired after the close (exit) animation has finished and the drawer has
46
- * left the DOM. Use it to clear the data the drawer was showing so the
47
- * content stays put while it slides out. */
48
- onClosed?: () => void
49
- children?: Snippet
50
- footer?: Snippet
51
- }
52
-
53
- let {
54
- open = $bindable(false),
55
- onClose,
56
- side = 'right',
57
- size,
58
- title,
59
- closeOnBackdrop = true,
60
- closeOnEsc = true,
61
- hideClose = false,
62
- sheet = false,
63
- ariaLabel,
64
- onClosed,
65
- children,
66
- footer,
67
- }: Props = $props()
68
-
69
- const titleId = nextEditorId('sv-drawer-title')
70
- let dialogEl = $state<HTMLDivElement | null>(null)
71
-
72
- // A sheet is a bottom drawer with mobile affordances.
73
- const effectiveSide = $derived<DrawerSide>(sheet ? 'bottom' : side)
74
- const horizontal = $derived(effectiveSide === 'left' || effectiveSide === 'right')
75
- const sizeVar = $derived(size ?? (horizontal ? 'min(400px, 92vw)' : 'min(360px, 85vh)'))
76
-
77
- function close() { open = false; onClose?.() }
78
-
79
- // Enter/exit animation via CSS @keyframes (the pattern SvModal uses - keyframes
80
- // play on a `use:portalToBody` element; the Svelte `transition:` directive does
81
- // NOT). `show` keeps the panel mounted; the enter keyframe fires on mount, and
82
- // on close we add `is-leaving` (exit keyframe) and unmount + fire `onClosed`
83
- // after the duration. Honors reduced-motion by dropping the hold to 0ms.
84
- const reduceMotion = typeof matchMedia === 'function' && matchMedia('(prefers-reduced-motion: reduce)').matches
85
- const EXIT_MS = 260
86
- let show = $state(false)
87
- let leaving = $state(false)
88
- let leaveTimer: ReturnType<typeof setTimeout> | undefined
89
- $effect(() => {
90
- if (open) {
91
- clearTimeout(leaveTimer)
92
- leaving = false
93
- show = true
94
- return
95
- }
96
- // Only run the leave sequence if the drawer was actually shown (skips the
97
- // initial closed mount, which must not fire onClosed).
98
- if (untrack(() => show)) {
99
- leaving = true
100
- leaveTimer = setTimeout(() => { show = false; leaving = false; onClosed?.() }, reduceMotion ? 0 : EXIT_MS)
101
- }
102
- })
103
-
104
- // Swipe-down-to-close for the sheet grab handle.
105
- let dragY = $state(0)
106
- let dragging = $state(false)
107
- let dragStartY = 0
108
- function onGrabDown(e: PointerEvent) {
109
- dragging = true
110
- dragStartY = e.clientY
111
- ;(e.currentTarget as HTMLElement).setPointerCapture?.(e.pointerId)
112
- }
113
- function onGrabMove(e: PointerEvent) {
114
- if (!dragging) return
115
- dragY = Math.max(0, e.clientY - dragStartY)
116
- }
117
- function onGrabUp(e: PointerEvent) {
118
- if (!dragging) return
119
- dragging = false
120
- ;(e.currentTarget as HTMLElement).releasePointerCapture?.(e.pointerId)
121
- if (dragY > 80) close()
122
- else dragY = 0
123
- }
124
-
125
- // Focus trap + scroll lock + Escape/backdrop dismissal come from the shared
126
- // headless overlay core - one tested implementation across every dialog-like
127
- // overlay, and nested overlays close top-first. See createOverlay.svelte.ts.
128
- const overlay = createOverlay({
129
- open: () => open,
130
- getDialog: () => dialogEl,
131
- onClose: close,
132
- closeOnEsc: () => closeOnEsc,
133
- closeOnBackdrop: () => closeOnBackdrop,
134
- onOpen: () => { dragY = 0 },
135
- })
136
- </script>
137
-
138
- {#if show}
139
- <div class="sv-drawer__backdrop" class:is-leaving={leaving} use:portalToBody>
140
- <div
141
- bind:this={dialogEl}
142
- class="sv-drawer sv-drawer--{effectiveSide}"
143
- class:is-leaving={leaving}
144
- class:is-sheet={sheet}
145
- class:is-dragging={dragging}
146
- {...overlay.dialogProps({ labelledBy: title ? titleId : undefined, label: !title ? ariaLabel : undefined })}
147
- style:--sv-drawer-size={sizeVar}
148
- style:transform={sheet && dragY ? `translateY(${dragY}px)` : undefined}
149
- >
150
- {#if sheet}
151
- <!-- svelte-ignore a11y_no_static_element_interactions -->
152
- <div
153
- class="sv-drawer__grab"
154
- aria-hidden="true"
155
- onpointerdown={onGrabDown}
156
- onpointermove={onGrabMove}
157
- onpointerup={onGrabUp}
158
- onpointercancel={onGrabUp}
159
- ><span></span></div>
160
- {/if}
161
- {#if title || !hideClose}
162
- <div class="sv-drawer__header">
163
- <h2 class="sv-drawer__title" id={titleId}>{title ?? ''}</h2>
164
- {#if !hideClose}
165
- <button type="button" class="sv-drawer__x" aria-label="Close" onclick={close}>&times;</button>
166
- {/if}
167
- </div>
168
- {/if}
169
- <div class="sv-drawer__body">{@render children?.()}</div>
170
- {#if footer}<div class="sv-drawer__footer">{@render footer()}</div>{/if}
171
- </div>
172
- </div>
173
- {/if}
174
-
175
- <style>
176
- :global(.sv-drawer__backdrop) {
177
- position: fixed; inset: 0; z-index: 2147483000;
178
- background: rgba(15, 23, 42, 0.45); backdrop-filter: blur(1.5px);
179
- animation: sv-drawer-bd-in 0.2s ease backwards;
180
- }
181
- :global(.sv-drawer__backdrop.is-leaving) { animation: sv-drawer-bd-out 0.2s ease forwards; }
182
- @keyframes sv-drawer-bd-in { from { opacity: 0 } to { opacity: 1 } }
183
- @keyframes sv-drawer-bd-out { from { opacity: 1 } to { opacity: 0 } }
184
-
185
- :global(.sv-drawer) {
186
- position: fixed;
187
- display: flex; flex-direction: column;
188
- background: var(--sg-bg, #fff); color: var(--sg-fg, #0f172a);
189
- box-shadow: 0 24px 64px -16px rgba(15, 23, 42, 0.5);
190
- overflow: hidden;
191
- /* Slide in on mount; `backwards` fill shows the off-screen start frame with no
192
- flash, and does NOT hold the end frame - so the sheet drag transform wins. */
193
- animation: sv-drawer-in 0.26s cubic-bezier(0.16, 1, 0.3, 1) backwards;
194
- }
195
- /* Exit keyframe; `forwards` fill holds the off-screen frame until we unmount. */
196
- :global(.sv-drawer.is-leaving) { animation: sv-drawer-out 0.26s cubic-bezier(0.16, 1, 0.3, 1) forwards; }
197
- /* Off-screen vector per edge - the enter/exit keyframes read `--sv-off`. `side`
198
- is a stated physical edge (like SvToaster's position prop), not a text-flow
199
- "start/end" - so it stays physical left/right regardless of page dir. */
200
- :global(.sv-drawer--right), :global(.sv-drawer--left) {
201
- top: 0; bottom: 0; width: var(--sv-drawer-size); max-width: 100vw;
202
- }
203
- :global(.sv-drawer--right) { right: 0; border-left: 1px solid var(--sg-border, #e2e8f0); --sv-off: translateX(100%); }
204
- :global(.sv-drawer--left) { left: 0; border-right: 1px solid var(--sg-border, #e2e8f0); --sv-off: translateX(-100%); }
205
- /* Top / bottom: full width, fixed height, slide along Y. */
206
- :global(.sv-drawer--top), :global(.sv-drawer--bottom) {
207
- left: 0; right: 0; height: var(--sv-drawer-size); max-height: 100vh;
208
- }
209
- :global(.sv-drawer--top) { top: 0; border-bottom: 1px solid var(--sg-border, #e2e8f0); --sv-off: translateY(-100%); }
210
- :global(.sv-drawer--bottom) { bottom: 0; border-top: 1px solid var(--sg-border, #e2e8f0); --sv-off: translateY(100%); }
211
- @keyframes sv-drawer-in { from { transform: var(--sv-off) } to { transform: none } }
212
- @keyframes sv-drawer-out { from { transform: none } to { transform: var(--sv-off) } }
213
-
214
- /* Mobile bottom-sheet: centered, fixed width, rounded top, grab handle. Slides
215
- along Y like a bottom drawer (enter/exit keyframes read --sv-off from --bottom). */
216
- :global(.sv-drawer.is-sheet) {
217
- left: 0; right: 0; margin: 0 auto; top: auto;
218
- width: min(560px, 100vw); height: auto; max-height: 85vh;
219
- border: 1px solid var(--sg-border, #e2e8f0); border-bottom: 0;
220
- border-radius: 16px 16px 0 0;
221
- }
222
- /* No transition while the user is dragging the grab handle - follow the finger. */
223
- :global(.sv-drawer.is-dragging) { transition: none; }
224
- :global(.sv-drawer__grab) {
225
- flex: none; display: grid; place-items: center; padding: 8px 0 2px; cursor: grab; touch-action: none;
226
- }
227
- :global(.sv-drawer__grab span) {
228
- display: block; width: 40px; height: 4px; border-radius: 999px; background: var(--sg-border, #cbd5e1);
229
- }
230
- @media (prefers-reduced-motion: reduce) {
231
- :global(.sv-drawer__backdrop), :global(.sv-drawer__backdrop.is-leaving),
232
- :global(.sv-drawer), :global(.sv-drawer.is-leaving) { animation: none; }
233
- }
234
-
235
- :global(.sv-drawer__header) {
236
- display: flex; align-items: center; gap: 12px; padding: 13px 16px;
237
- border-bottom: 1px solid var(--sg-border, #e2e8f0);
238
- }
239
- :global(.sv-drawer__title) { flex: 1; margin: 0; font-size: 15px; font-weight: 650; }
240
- :global(.sv-drawer__x) {
241
- flex: none; width: 28px; height: 28px; display: grid; place-items: center;
242
- background: none; border: 0; color: var(--sg-muted, #64748b); cursor: pointer; border-radius: 6px; font-size: 20px; line-height: 1;
243
- }
244
- :global(.sv-drawer__x:hover) { background: var(--sg-row-hover-bg, #f1f5f9); color: var(--sg-fg, #0f172a); }
245
- :global(.sv-drawer__body) { padding: 16px; overflow: auto; flex: 1; font-size: 13.5px; line-height: 1.6; }
246
- :global(.sv-drawer__footer) {
247
- display: flex; justify-content: flex-end; gap: 8px; padding: 12px 16px;
248
- border-top: 1px solid var(--sg-border, #e2e8f0);
249
- }
250
- </style>
1
+ <script lang="ts">
2
+ /**
3
+ * SvDrawer - an edge-anchored side sheet (right / left / top / bottom): a
4
+ * backdrop, a sliding panel, and the full dialog a11y contract. Built entirely
5
+ * on the shared primitives - `createFocusTrap`, `lockScroll` and
6
+ * `createDismissableLayer` - so its focus, scroll-lock and Escape/backdrop
7
+ * behaviour is identical to SvModal and nested overlays close top-first.
8
+ * Portalled to <body>. Controlled via `open`.
9
+ *
10
+ * ```svelte
11
+ * <SvDrawer bind:open side="right" title="Filters">
12
+ * <p>Body</p>
13
+ * {#snippet footer()}<button onclick={() => open = false}>Apply</button>{/snippet}
14
+ * </SvDrawer>
15
+ * ```
16
+ */
17
+ import type { Snippet } from 'svelte'
18
+ import { untrack } from 'svelte'
19
+ import { portalToBody } from './popover'
20
+ import { nextEditorId } from './editor-contract'
21
+ import { createOverlay } from './createOverlay.svelte'
22
+
23
+ /** Edge the drawer slides from. Kept in sync with the `DrawerSide` export in
24
+ * index.ts (a bare type-only module script trips the Svelte/Vite parser). */
25
+ type DrawerSide = 'right' | 'left' | 'top' | 'bottom'
26
+
27
+ type Props = {
28
+ open?: boolean
29
+ onClose?: () => void
30
+ /** Edge the drawer slides from. Default 'right'. */
31
+ side?: DrawerSide
32
+ /** Panel size along its axis (width for left/right, height for top/bottom).
33
+ * Any CSS length; defaults to a sensible per-axis value. */
34
+ size?: string
35
+ title?: string
36
+ closeOnBackdrop?: boolean
37
+ closeOnEsc?: boolean
38
+ /** Hide the header close (x) button. */
39
+ hideClose?: boolean
40
+ /** Render as a mobile bottom-sheet: bottom-anchored, rounded top, a grab
41
+ * handle, and swipe-down-to-close. Overrides `side`. */
42
+ sheet?: boolean
43
+ /** Accessible name when there is no visible `title`. */
44
+ ariaLabel?: string
45
+ /** Fired after the close (exit) animation has finished and the drawer has
46
+ * left the DOM. Use it to clear the data the drawer was showing so the
47
+ * content stays put while it slides out. */
48
+ onClosed?: () => void
49
+ children?: Snippet
50
+ footer?: Snippet
51
+ }
52
+
53
+ let {
54
+ open = $bindable(false),
55
+ onClose,
56
+ side = 'right',
57
+ size,
58
+ title,
59
+ closeOnBackdrop = true,
60
+ closeOnEsc = true,
61
+ hideClose = false,
62
+ sheet = false,
63
+ ariaLabel,
64
+ onClosed,
65
+ children,
66
+ footer,
67
+ }: Props = $props()
68
+
69
+ const titleId = nextEditorId('sv-drawer-title')
70
+ let dialogEl = $state<HTMLDivElement | null>(null)
71
+
72
+ // A sheet is a bottom drawer with mobile affordances.
73
+ const effectiveSide = $derived<DrawerSide>(sheet ? 'bottom' : side)
74
+ const horizontal = $derived(effectiveSide === 'left' || effectiveSide === 'right')
75
+ const sizeVar = $derived(size ?? (horizontal ? 'min(400px, 92vw)' : 'min(360px, 85vh)'))
76
+
77
+ function close() { open = false; onClose?.() }
78
+
79
+ // Enter/exit animation via CSS @keyframes (the pattern SvModal uses - keyframes
80
+ // play on a `use:portalToBody` element; the Svelte `transition:` directive does
81
+ // NOT). `show` keeps the panel mounted; the enter keyframe fires on mount, and
82
+ // on close we add `is-leaving` (exit keyframe) and unmount + fire `onClosed`
83
+ // after the duration. Honors reduced-motion by dropping the hold to 0ms.
84
+ const reduceMotion = typeof matchMedia === 'function' && matchMedia('(prefers-reduced-motion: reduce)').matches
85
+ const EXIT_MS = 260
86
+ let show = $state(false)
87
+ let leaving = $state(false)
88
+ let leaveTimer: ReturnType<typeof setTimeout> | undefined
89
+ $effect(() => {
90
+ if (open) {
91
+ clearTimeout(leaveTimer)
92
+ leaving = false
93
+ show = true
94
+ return
95
+ }
96
+ // Only run the leave sequence if the drawer was actually shown (skips the
97
+ // initial closed mount, which must not fire onClosed).
98
+ if (untrack(() => show)) {
99
+ leaving = true
100
+ leaveTimer = setTimeout(() => { show = false; leaving = false; onClosed?.() }, reduceMotion ? 0 : EXIT_MS)
101
+ }
102
+ // `open` is this effect's only dependency, so the cleanup runs on reopen (a
103
+ // no-op after the clearTimeout above) or on destroy - where it matters, so a
104
+ // drawer unmounted mid-exit doesn't leave a timer firing into a dead scope.
105
+ return () => clearTimeout(leaveTimer)
106
+ })
107
+
108
+ // Swipe-down-to-close for the sheet grab handle.
109
+ let dragY = $state(0)
110
+ let dragging = $state(false)
111
+ let dragStartY = 0
112
+ function onGrabDown(e: PointerEvent) {
113
+ dragging = true
114
+ dragStartY = e.clientY
115
+ ;(e.currentTarget as HTMLElement).setPointerCapture?.(e.pointerId)
116
+ }
117
+ function onGrabMove(e: PointerEvent) {
118
+ if (!dragging) return
119
+ dragY = Math.max(0, e.clientY - dragStartY)
120
+ }
121
+ function onGrabUp(e: PointerEvent) {
122
+ if (!dragging) return
123
+ dragging = false
124
+ ;(e.currentTarget as HTMLElement).releasePointerCapture?.(e.pointerId)
125
+ if (dragY > 80) close()
126
+ else dragY = 0
127
+ }
128
+
129
+ // Focus trap + scroll lock + Escape/backdrop dismissal come from the shared
130
+ // headless overlay core - one tested implementation across every dialog-like
131
+ // overlay, and nested overlays close top-first. See createOverlay.svelte.ts.
132
+ const overlay = createOverlay({
133
+ open: () => open,
134
+ getDialog: () => dialogEl,
135
+ onClose: close,
136
+ closeOnEsc: () => closeOnEsc,
137
+ closeOnBackdrop: () => closeOnBackdrop,
138
+ onOpen: () => { dragY = 0 },
139
+ })
140
+ </script>
141
+
142
+ {#if show}
143
+ <div class="sv-drawer__backdrop" class:is-leaving={leaving} use:portalToBody>
144
+ <div
145
+ bind:this={dialogEl}
146
+ class="sv-drawer sv-drawer--{effectiveSide}"
147
+ class:is-leaving={leaving}
148
+ class:is-sheet={sheet}
149
+ class:is-dragging={dragging}
150
+ {...overlay.dialogProps({ labelledBy: title ? titleId : undefined, label: !title ? ariaLabel : undefined })}
151
+ style:--sv-drawer-size={sizeVar}
152
+ style:transform={sheet && dragY ? `translateY(${dragY}px)` : undefined}
153
+ >
154
+ {#if sheet}
155
+ <!-- svelte-ignore a11y_no_static_element_interactions -->
156
+ <div
157
+ class="sv-drawer__grab"
158
+ aria-hidden="true"
159
+ onpointerdown={onGrabDown}
160
+ onpointermove={onGrabMove}
161
+ onpointerup={onGrabUp}
162
+ onpointercancel={onGrabUp}
163
+ ><span></span></div>
164
+ {/if}
165
+ {#if title || !hideClose}
166
+ <div class="sv-drawer__header">
167
+ <h2 class="sv-drawer__title" id={titleId}>{title ?? ''}</h2>
168
+ {#if !hideClose}
169
+ <button type="button" class="sv-drawer__x" aria-label="Close" onclick={close}>&times;</button>
170
+ {/if}
171
+ </div>
172
+ {/if}
173
+ <div class="sv-drawer__body">{@render children?.()}</div>
174
+ {#if footer}<div class="sv-drawer__footer">{@render footer()}</div>{/if}
175
+ </div>
176
+ </div>
177
+ {/if}
178
+
179
+ <style>
180
+ :global(.sv-drawer__backdrop) {
181
+ position: fixed; inset: 0; z-index: 2147483000;
182
+ background: rgba(15, 23, 42, 0.45); backdrop-filter: blur(1.5px);
183
+ animation: sv-drawer-bd-in 0.2s ease backwards;
184
+ }
185
+ :global(.sv-drawer__backdrop.is-leaving) { animation: sv-drawer-bd-out 0.2s ease forwards; }
186
+ @keyframes sv-drawer-bd-in { from { opacity: 0 } to { opacity: 1 } }
187
+ @keyframes sv-drawer-bd-out { from { opacity: 1 } to { opacity: 0 } }
188
+
189
+ :global(.sv-drawer) {
190
+ position: fixed;
191
+ display: flex; flex-direction: column;
192
+ background: var(--sg-bg, #fff); color: var(--sg-fg, #0f172a);
193
+ box-shadow: 0 24px 64px -16px rgba(15, 23, 42, 0.5);
194
+ overflow: hidden;
195
+ /* Slide in on mount; `backwards` fill shows the off-screen start frame with no
196
+ flash, and does NOT hold the end frame - so the sheet drag transform wins. */
197
+ animation: sv-drawer-in 0.26s cubic-bezier(0.16, 1, 0.3, 1) backwards;
198
+ }
199
+ /* Exit keyframe; `forwards` fill holds the off-screen frame until we unmount. */
200
+ :global(.sv-drawer.is-leaving) { animation: sv-drawer-out 0.26s cubic-bezier(0.16, 1, 0.3, 1) forwards; }
201
+ /* Off-screen vector per edge - the enter/exit keyframes read `--sv-off`. `side`
202
+ is a stated physical edge (like SvToaster's position prop), not a text-flow
203
+ "start/end" - so it stays physical left/right regardless of page dir. */
204
+ :global(.sv-drawer--right), :global(.sv-drawer--left) {
205
+ top: 0; bottom: 0; width: var(--sv-drawer-size); max-width: 100vw;
206
+ }
207
+ :global(.sv-drawer--right) { right: 0; border-left: 1px solid var(--sg-border, #e2e8f0); --sv-off: translateX(100%); }
208
+ :global(.sv-drawer--left) { left: 0; border-right: 1px solid var(--sg-border, #e2e8f0); --sv-off: translateX(-100%); }
209
+ /* Top / bottom: full width, fixed height, slide along Y. */
210
+ :global(.sv-drawer--top), :global(.sv-drawer--bottom) {
211
+ left: 0; right: 0; height: var(--sv-drawer-size); max-height: 100vh;
212
+ }
213
+ :global(.sv-drawer--top) { top: 0; border-bottom: 1px solid var(--sg-border, #e2e8f0); --sv-off: translateY(-100%); }
214
+ :global(.sv-drawer--bottom) { bottom: 0; border-top: 1px solid var(--sg-border, #e2e8f0); --sv-off: translateY(100%); }
215
+ @keyframes sv-drawer-in { from { transform: var(--sv-off) } to { transform: none } }
216
+ @keyframes sv-drawer-out { from { transform: none } to { transform: var(--sv-off) } }
217
+
218
+ /* Mobile bottom-sheet: centered, fixed width, rounded top, grab handle. Slides
219
+ along Y like a bottom drawer (enter/exit keyframes read --sv-off from --bottom). */
220
+ :global(.sv-drawer.is-sheet) {
221
+ left: 0; right: 0; margin: 0 auto; top: auto;
222
+ width: min(560px, 100vw); height: auto; max-height: 85vh;
223
+ border: 1px solid var(--sg-border, #e2e8f0); border-bottom: 0;
224
+ border-radius: 16px 16px 0 0;
225
+ }
226
+ /* No transition while the user is dragging the grab handle - follow the finger. */
227
+ :global(.sv-drawer.is-dragging) { transition: none; }
228
+ :global(.sv-drawer__grab) {
229
+ flex: none; display: grid; place-items: center; padding: 8px 0 2px; cursor: grab; touch-action: none;
230
+ }
231
+ :global(.sv-drawer__grab span) {
232
+ display: block; width: 40px; height: 4px; border-radius: 999px; background: var(--sg-border, #cbd5e1);
233
+ }
234
+ @media (prefers-reduced-motion: reduce) {
235
+ :global(.sv-drawer__backdrop), :global(.sv-drawer__backdrop.is-leaving),
236
+ :global(.sv-drawer), :global(.sv-drawer.is-leaving) { animation: none; }
237
+ }
238
+
239
+ :global(.sv-drawer__header) {
240
+ display: flex; align-items: center; gap: 12px; padding: 13px 16px;
241
+ border-bottom: 1px solid var(--sg-border, #e2e8f0);
242
+ }
243
+ :global(.sv-drawer__title) { flex: 1; margin: 0; font-size: 15px; font-weight: 650; }
244
+ :global(.sv-drawer__x) {
245
+ flex: none; width: 28px; height: 28px; display: grid; place-items: center;
246
+ background: none; border: 0; color: var(--sg-muted, #64748b); cursor: pointer; border-radius: 6px; font-size: 20px; line-height: 1;
247
+ }
248
+ :global(.sv-drawer__x:hover) { background: var(--sg-row-hover-bg, #f1f5f9); color: var(--sg-fg, #0f172a); }
249
+ :global(.sv-drawer__body) { padding: 16px; overflow: auto; flex: 1; font-size: 13.5px; line-height: 1.6; }
250
+ :global(.sv-drawer__footer) {
251
+ display: flex; justify-content: flex-end; gap: 8px; padding: 12px 16px;
252
+ border-top: 1px solid var(--sg-border, #e2e8f0);
253
+ }
254
+ </style>
@@ -3,7 +3,7 @@
3
3
  * scroll lock, and Escape / backdrop dismissal - all inherited from the shared
4
4
  * a11y primitives.
5
5
  */
6
- import { describe, expect, it } from 'vitest'
6
+ import { afterEach, describe, expect, it, vi } from 'vitest'
7
7
  import { mount, unmount, flushSync } from 'svelte'
8
8
  import SvDrawer from './SvDrawer.svelte'
9
9
 
@@ -17,6 +17,16 @@ function mountDrawer(props: Record<string, unknown>) {
17
17
 
18
18
  const dialog = () => document.body.querySelector<HTMLElement>('.sv-drawer')
19
19
 
20
+ // Closing plays a 260ms exit keyframe (`is-leaving`) before the panel unmounts,
21
+ // so dismissal assertions have to let that timer run. Fake timers keep it instant.
22
+ const EXIT_MS = 260
23
+ function runExitAnimation() {
24
+ vi.advanceTimersByTime(EXIT_MS)
25
+ flushSync()
26
+ }
27
+
28
+ afterEach(() => { vi.useRealTimers() })
29
+
20
30
  describe('SvDrawer', () => {
21
31
  it('renders nothing when closed', () => {
22
32
  const { destroy } = mountDrawer({ open: false })
@@ -57,12 +67,15 @@ describe('SvDrawer', () => {
57
67
  })
58
68
 
59
69
  it('closes on Escape and fires onClose', () => {
70
+ vi.useFakeTimers()
60
71
  let closed = 0
61
72
  const { destroy } = mountDrawer({ open: true, onClose: () => closed++ })
62
73
  try {
63
74
  document.dispatchEvent(new KeyboardEvent('keydown', { key: 'Escape', bubbles: true }))
64
75
  flushSync()
65
76
  expect(closed).toBe(1)
77
+ expect(dialog()!.classList.contains('is-leaving')).toBe(true) // exit keyframe first
78
+ runExitAnimation()
66
79
  expect(dialog()).toBeNull()
67
80
  } finally { destroy() }
68
81
  })
@@ -77,11 +90,13 @@ describe('SvDrawer', () => {
77
90
  })
78
91
 
79
92
  it('dismisses on outside (backdrop) pointerdown', () => {
93
+ vi.useFakeTimers()
80
94
  const { destroy } = mountDrawer({ open: true })
81
95
  try {
82
96
  const backdrop = document.body.querySelector<HTMLElement>('.sv-drawer__backdrop')!
83
97
  backdrop.dispatchEvent(new MouseEvent('pointerdown', { bubbles: true }))
84
98
  flushSync()
99
+ runExitAnimation()
85
100
  expect(dialog()).toBeNull()
86
101
  } finally { destroy() }
87
102
  })
@@ -98,6 +113,7 @@ describe('SvDrawer', () => {
98
113
  })
99
114
 
100
115
  it('swiping the grab handle down past the threshold closes the sheet', () => {
116
+ vi.useFakeTimers()
101
117
  let closed = 0
102
118
  const { destroy } = mountDrawer({ open: true, sheet: true, onClose: () => closed++ })
103
119
  try {
@@ -107,6 +123,7 @@ describe('SvDrawer', () => {
107
123
  grab.dispatchEvent(new MouseEvent('pointerup', { bubbles: true, clientY: 220 }))
108
124
  flushSync()
109
125
  expect(closed).toBe(1)
126
+ runExitAnimation()
110
127
  expect(dialog()).toBeNull()
111
128
  } finally { destroy() }
112
129
  })