@svgrid/grid 2.1.22 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (295) hide show
  1. package/README.md +9 -2
  2. package/dist/DockNodeView.svelte +306 -0
  3. package/dist/DockNodeView.svelte.d.ts +7 -0
  4. package/dist/DockPopoutHost.svelte +17 -0
  5. package/dist/DockPopoutHost.svelte.d.ts +14 -0
  6. package/dist/FlexRender.svelte +96 -96
  7. package/dist/GridFooter.svelte +178 -178
  8. package/dist/GridMenus.svelte +83 -3
  9. package/dist/SvAutoComplete.svelte +5 -3
  10. package/dist/SvCarousel.svelte +141 -163
  11. package/dist/SvColorInput.svelte +187 -186
  12. package/dist/SvColorInput.svelte.d.ts +1 -1
  13. package/dist/SvComboBox.svelte +7 -3
  14. package/dist/SvCommand.svelte +28 -85
  15. package/dist/SvContextMenu.svelte +116 -116
  16. package/dist/SvCountryInput.svelte +1 -1
  17. package/dist/SvDateRangeInput.svelte +1 -1
  18. package/dist/SvDateTimePicker.svelte +9 -3
  19. package/dist/SvDateTimePicker.svelte.d.ts +3 -0
  20. package/dist/SvDockLayout.svelte +244 -0
  21. package/dist/SvDockLayout.svelte.d.ts +77 -0
  22. package/dist/SvDockManager.svelte +922 -0
  23. package/dist/SvDockManager.svelte.d.ts +106 -0
  24. package/dist/SvDrawer.svelte +250 -228
  25. package/dist/SvDrawer.svelte.d.ts +4 -0
  26. package/dist/SvDropDownList.svelte +85 -13
  27. package/dist/SvDropDownList.svelte.d.ts +3 -0
  28. package/dist/SvField.svelte +21 -4
  29. package/dist/SvField.svelte.d.ts +1 -0
  30. package/dist/SvForm.svelte +201 -91
  31. package/dist/SvForm.svelte.d.ts +15 -22
  32. package/dist/SvGrid.controller.svelte.d.ts +32 -1
  33. package/dist/SvGrid.controller.svelte.js +156 -27
  34. package/dist/SvGrid.css +193 -5
  35. package/dist/SvGrid.svelte +3131 -2786
  36. package/dist/SvGrid.types.d.ts +452 -1
  37. package/dist/SvGridBoard.svelte +2339 -2339
  38. package/dist/SvGridChart.svelte +1724 -1724
  39. package/dist/SvGridChartPanel.svelte +485 -485
  40. package/dist/SvGridDropdown.svelte +689 -682
  41. package/dist/SvGridSelect.svelte +1 -0
  42. package/dist/SvGroupCell.svelte +109 -109
  43. package/dist/SvListBox.svelte +36 -14
  44. package/dist/SvMaskedInput.svelte +4 -3
  45. package/dist/SvMaskedInput.svelte.d.ts +1 -1
  46. package/dist/SvMenu.svelte +124 -124
  47. package/dist/SvMenuList.svelte +117 -165
  48. package/dist/SvMenuList.svelte.d.ts +2 -13
  49. package/dist/SvModal.svelte +12 -29
  50. package/dist/SvMultiSelect.svelte +1 -0
  51. package/dist/SvNumberInput.svelte +131 -130
  52. package/dist/SvNumberInput.svelte.d.ts +1 -1
  53. package/dist/SvOtpInput.svelte +158 -158
  54. package/dist/SvPagination.svelte +18 -18
  55. package/dist/SvPasswordInput.svelte +3 -2
  56. package/dist/SvPasswordInput.svelte.d.ts +1 -1
  57. package/dist/SvPhoneInput.svelte +3 -2
  58. package/dist/SvPhoneInput.svelte.d.ts +1 -1
  59. package/dist/SvPopover.svelte +139 -139
  60. package/dist/SvRowGroupPanel.svelte +170 -170
  61. package/dist/SvScrollArea.svelte +61 -61
  62. package/dist/SvStepper.svelte +6 -9
  63. package/dist/SvTagsInput.svelte +3 -2
  64. package/dist/SvTagsInput.svelte.d.ts +1 -1
  65. package/dist/SvTooltip.svelte +127 -138
  66. package/dist/SvTour.svelte +204 -176
  67. package/dist/SvTree.svelte +377 -377
  68. package/dist/SvTreeSelect.svelte +230 -229
  69. package/dist/build-api.js +76 -54
  70. package/dist/cdn/svgrid.js +10913 -6450
  71. package/dist/cdn/svgrid.svelte-external.js +9628 -5481
  72. package/dist/chart-export.js +8 -8
  73. package/dist/columns.js +6 -0
  74. package/dist/conditional-formatting.d.ts +67 -3
  75. package/dist/conditional-formatting.js +124 -17
  76. package/dist/createCarousel.svelte.d.ts +72 -0
  77. package/dist/createCarousel.svelte.js +80 -0
  78. package/dist/createCommand.svelte.d.ts +62 -0
  79. package/dist/createCommand.svelte.js +109 -0
  80. package/dist/createForm.svelte.d.ts +62 -0
  81. package/dist/createForm.svelte.js +374 -0
  82. package/dist/createMenu.svelte.d.ts +88 -0
  83. package/dist/createMenu.svelte.js +153 -0
  84. package/dist/createOverlay.svelte.d.ts +38 -0
  85. package/dist/createOverlay.svelte.js +68 -0
  86. package/dist/createPagination.d.ts +74 -0
  87. package/dist/createPagination.js +71 -0
  88. package/dist/createPopoverSelect.svelte.js +6 -12
  89. package/dist/createStepper.d.ts +44 -0
  90. package/dist/createStepper.js +26 -0
  91. package/dist/createTooltip.svelte.d.ts +32 -0
  92. package/dist/createTooltip.svelte.js +61 -0
  93. package/dist/datetime/timezone.d.ts +36 -0
  94. package/dist/datetime/timezone.js +110 -0
  95. package/dist/dock-context.d.ts +52 -0
  96. package/dist/dock-context.js +1 -0
  97. package/dist/dock-manager-model.d.ts +136 -0
  98. package/dist/dock-manager-model.js +514 -0
  99. package/dist/dock-model.d.ts +105 -0
  100. package/dist/dock-model.js +288 -0
  101. package/dist/dock-popout.d.ts +30 -0
  102. package/dist/dock-popout.js +81 -0
  103. package/dist/editor-contract.d.ts +2 -0
  104. package/dist/filter-operators.d.ts +6 -0
  105. package/dist/filter-operators.js +35 -2
  106. package/dist/filtering/excel-filters.d.ts +18 -1
  107. package/dist/filtering/excel-filters.js +56 -0
  108. package/dist/form-field.d.ts +73 -0
  109. package/dist/form-field.js +15 -0
  110. package/dist/index.d.ts +25 -5
  111. package/dist/index.js +40 -4
  112. package/dist/list-nav.d.ts +18 -0
  113. package/dist/list-nav.js +30 -0
  114. package/dist/list-option.d.ts +2 -0
  115. package/dist/menu-item.d.ts +20 -0
  116. package/dist/menu-item.js +1 -0
  117. package/dist/menus.d.ts +5 -0
  118. package/dist/menus.js +68 -16
  119. package/dist/panel-resize.d.ts +25 -0
  120. package/dist/panel-resize.js +40 -0
  121. package/dist/popover.d.ts +29 -3
  122. package/dist/popover.js +22 -6
  123. package/dist/recurrence.d.ts +33 -7
  124. package/dist/recurrence.js +151 -13
  125. package/dist/row-drag.d.ts +8 -0
  126. package/dist/row-drag.js +11 -0
  127. package/dist/scheduler-ical.d.ts +30 -0
  128. package/dist/scheduler-ical.js +180 -0
  129. package/dist/scheduler-model.d.ts +269 -0
  130. package/dist/scheduler-model.js +602 -0
  131. package/dist/scheduler-view.svelte.d.ts +22 -0
  132. package/dist/scheduler-view.svelte.js +13 -0
  133. package/dist/spreadsheet.js +20 -12
  134. package/dist/ui-app.types.d.ts +3 -0
  135. package/package.json +14 -10
  136. package/src/DockNodeView.svelte +306 -0
  137. package/src/DockPopoutHost.svelte +17 -0
  138. package/src/FlexRender.svelte +96 -96
  139. package/src/GridFooter.svelte +178 -178
  140. package/src/GridMenus.svelte +83 -3
  141. package/src/SvAutoComplete.svelte +5 -3
  142. package/src/SvCarousel.svelte +141 -163
  143. package/src/SvCarousel.test.ts +68 -0
  144. package/src/SvColorInput.svelte +187 -186
  145. package/src/SvComboBox.svelte +7 -3
  146. package/src/SvCommand.svelte +28 -85
  147. package/src/SvCommand.test.ts +78 -0
  148. package/src/SvContextMenu.svelte +116 -116
  149. package/src/SvCountryInput.svelte +1 -1
  150. package/src/SvDateRangeInput.svelte +1 -1
  151. package/src/SvDateTimePicker.svelte +9 -3
  152. package/src/SvDockLayout.svelte +244 -0
  153. package/src/SvDockManager.svelte +922 -0
  154. package/src/SvDrawer.svelte +250 -228
  155. package/src/SvDropDownList.svelte +85 -13
  156. package/src/SvField.svelte +21 -4
  157. package/src/SvForm.svelte +201 -91
  158. package/src/SvForm.test.ts +299 -0
  159. package/src/SvGrid.controller.svelte.ts +3158 -3034
  160. package/src/SvGrid.css +193 -5
  161. package/src/SvGrid.svelte +3131 -2786
  162. package/src/SvGrid.types.ts +1489 -1027
  163. package/src/SvGridBoard.svelte +2339 -2339
  164. package/src/SvGridChart.svelte +1724 -1724
  165. package/src/SvGridChartPanel.svelte +485 -485
  166. package/src/SvGridDropdown.svelte +689 -682
  167. package/src/SvGridSelect.svelte +1 -0
  168. package/src/SvGroupCell.svelte +109 -109
  169. package/src/SvListBox.svelte +36 -14
  170. package/src/SvMaskedInput.svelte +4 -3
  171. package/src/SvMenu.svelte +124 -124
  172. package/src/SvMenu.test.ts +97 -73
  173. package/src/SvMenuList.svelte +117 -165
  174. package/src/SvModal.svelte +12 -29
  175. package/src/SvModal.test.ts +82 -0
  176. package/src/SvMultiSelect.svelte +1 -0
  177. package/src/SvNumberInput.svelte +131 -130
  178. package/src/SvOtpInput.svelte +158 -158
  179. package/src/SvPagination.svelte +18 -18
  180. package/src/SvPasswordInput.svelte +3 -2
  181. package/src/SvPhoneInput.svelte +3 -2
  182. package/src/SvPopover.svelte +139 -139
  183. package/src/SvRowGroupPanel.svelte +170 -170
  184. package/src/SvScrollArea.svelte +61 -61
  185. package/src/SvStepper.svelte +6 -9
  186. package/src/SvTagsInput.svelte +3 -2
  187. package/src/SvTooltip.svelte +127 -138
  188. package/src/SvTooltip.test.ts +73 -0
  189. package/src/SvTour.svelte +204 -176
  190. package/src/SvTree.svelte +377 -377
  191. package/src/SvTreeSelect.svelte +230 -229
  192. package/src/a11y.contract.test.ts +49 -49
  193. package/src/a11y.test.ts +59 -59
  194. package/src/a11y.ts +61 -61
  195. package/src/build-api.ts +870 -847
  196. package/src/cell-formatting.ts +169 -169
  197. package/src/cell-render.ts +469 -469
  198. package/src/chart-export.ts +201 -201
  199. package/src/chart.ts +2296 -2296
  200. package/src/collaboration.test.ts +104 -104
  201. package/src/collaboration.ts +167 -167
  202. package/src/columns.ts +5 -0
  203. package/src/conditional-formatting.test.ts +104 -0
  204. package/src/conditional-formatting.ts +176 -19
  205. package/src/core.performance.test.ts +30 -30
  206. package/src/core.ts +1111 -1111
  207. package/src/createAutocomplete.svelte.ts +132 -132
  208. package/src/createCarousel.svelte.ts +104 -0
  209. package/src/createCombobox.svelte.ts +179 -179
  210. package/src/createCommand.svelte.ts +125 -0
  211. package/src/createCountryInput.svelte.ts +157 -157
  212. package/src/createDropdownList.svelte.ts +162 -162
  213. package/src/createForm.svelte.ts +333 -0
  214. package/src/createGrid.svelte.ts +42 -42
  215. package/src/createGrid.test.ts +10 -10
  216. package/src/createGridState.svelte.ts +17 -17
  217. package/src/createMenu.svelte.ts +202 -0
  218. package/src/createOverlay.svelte.ts +101 -0
  219. package/src/createPagination.test.ts +65 -0
  220. package/src/createPagination.ts +84 -0
  221. package/src/createPopoverSelect.svelte.ts +206 -210
  222. package/src/createStepper.test.ts +62 -0
  223. package/src/createStepper.ts +61 -0
  224. package/src/createTooltip.svelte.ts +86 -0
  225. package/src/createTree.svelte.ts +319 -319
  226. package/src/datetime/timezone.test.ts +69 -0
  227. package/src/datetime/timezone.ts +134 -0
  228. package/src/dock-context.ts +47 -0
  229. package/src/dock-manager-model.test.ts +275 -0
  230. package/src/dock-manager-model.ts +593 -0
  231. package/src/dock-model.test.ts +163 -0
  232. package/src/dock-model.ts +368 -0
  233. package/src/dock-popout.ts +94 -0
  234. package/src/editing.test.ts +859 -859
  235. package/src/editing.ts +675 -675
  236. package/src/editor-contract.ts +2 -0
  237. package/src/export-data-api.test.ts +126 -126
  238. package/src/export-format.test.ts +107 -107
  239. package/src/export-format.ts +598 -598
  240. package/src/filter-operators.test.ts +59 -0
  241. package/src/filter-operators.ts +35 -2
  242. package/src/filtering/excel-filters.test.ts +86 -1
  243. package/src/filtering/excel-filters.ts +65 -0
  244. package/src/flex-render.ts +3 -3
  245. package/src/form-field.ts +87 -0
  246. package/src/index.ts +623 -469
  247. package/src/keyboard.test.ts +59 -59
  248. package/src/keyboard.ts +97 -97
  249. package/src/list-nav.test.ts +49 -0
  250. package/src/list-nav.ts +29 -0
  251. package/src/list-option.ts +2 -0
  252. package/src/menu-item.ts +21 -0
  253. package/src/menus.test.ts +48 -0
  254. package/src/menus.ts +639 -582
  255. package/src/merge-objects.ts +48 -48
  256. package/src/overlays.test.ts +90 -90
  257. package/src/panel-resize.ts +52 -0
  258. package/src/popover.bounds.test.ts +93 -0
  259. package/src/popover.ts +51 -7
  260. package/src/recurrence.test.ts +88 -1
  261. package/src/recurrence.ts +166 -15
  262. package/src/render-component.ts +28 -28
  263. package/src/row-drag.ts +10 -0
  264. package/src/scheduler-ical.test.ts +68 -0
  265. package/src/scheduler-ical.ts +180 -0
  266. package/src/scheduler-model.test.ts +546 -0
  267. package/src/scheduler-model.ts +853 -0
  268. package/src/scheduler-view.svelte.ts +33 -0
  269. package/src/selection.test.ts +754 -754
  270. package/src/selection.ts +600 -600
  271. package/src/server-data-source.test.ts +289 -289
  272. package/src/server-data-source.ts +413 -413
  273. package/src/sparkline.test.ts +68 -68
  274. package/src/sparkline.ts +169 -169
  275. package/src/spreadsheet.test.ts +489 -489
  276. package/src/spreadsheet.ts +312 -304
  277. package/src/static-functions.ts +11 -11
  278. package/src/subscribe.ts +38 -38
  279. package/src/svgrid-wrapper.types.ts +501 -501
  280. package/src/svgrid.behavior.test.ts +706 -706
  281. package/src/svgrid.charting.test.ts +527 -527
  282. package/src/svgrid.effect-driven-filter.svelte.test.ts +116 -0
  283. package/src/svgrid.features.test.ts +157 -157
  284. package/src/svgrid.new-features.wrapper.test.ts +251 -251
  285. package/src/svgrid.wrapper.test.ts +40 -40
  286. package/src/test-setup.ts +62 -62
  287. package/src/themes/index.ts +159 -159
  288. package/src/ui-app.types.ts +3 -0
  289. package/src/virtual.test.ts +6 -4
  290. package/src/virtualization/column-virtualizer.test.ts +27 -27
  291. package/src/virtualization/column-virtualizer.ts +30 -30
  292. package/src/virtualization/svelte-virtualizer.svelte.ts +26 -26
  293. package/src/virtualization/types.ts +30 -30
  294. package/src/virtualization/virtualizer.test.ts +47 -47
  295. package/src/virtualization/virtualizer.ts +296 -296
@@ -0,0 +1,106 @@
1
+ /**
2
+ * SvDockManager - a full docking manager built on <SvDockLayout>. It adds the
3
+ * three "pro" features a tiled layout alone does not have:
4
+ *
5
+ * - Floating / pop-out windows: drag a tab out of the dock (or hit the float
6
+ * button) to pop it into a movable, resizable window; drag it back to redock.
7
+ * - Tab reordering: drag a tab along its own strip to reorder it.
8
+ * - Pinning / auto-hide: collapse a panel to an edge strip; a fly-out reveals
9
+ * it on hover, and "pin" docks it back.
10
+ *
11
+ * The docked area is an <SvDockLayout> in "manager mode" (it delegates every
12
+ * gesture here); floating windows are each a small <SvDockLayout> too. The
13
+ * whole workspace is the serializable `DockManagerState` from `dock-manager-model`.
14
+ *
15
+ * Build the initial workspace with the base `dockGroup`/`dockTabs`/`dockPane`
16
+ * helpers:
17
+ *
18
+ * let workspace = $state({
19
+ * main: dockGroup('row', [dockTabs([dockPane('a','A')]), dockTabs([dockPane('b','B')])]),
20
+ * floating: [], autoHide: [],
21
+ * })
22
+ * <SvDockManager bind:workspace>{#snippet pane(p)} ... {/snippet}</SvDockManager>
23
+ */
24
+ import { type Snippet } from 'svelte';
25
+ import type { DockPane } from './dock-model';
26
+ import { type DockManagerState, type DockSide } from './dock-manager-model';
27
+ /** Imperative handle exposed via `onReady`. */
28
+ export type DockManagerApi = {
29
+ getState: () => DockManagerState;
30
+ setState: (s: DockManagerState) => void;
31
+ float: (paneId: string) => void;
32
+ popout: (paneId: string) => void;
33
+ autoHide: (paneId: string) => void;
34
+ maximize: (tabsId: string) => void;
35
+ close: (paneId: string) => void;
36
+ focus: (paneId: string) => void;
37
+ };
38
+ /** Granular lifecycle events (in addition to `onChange`). */
39
+ export type DockEvent = {
40
+ type: 'activePane';
41
+ paneId: string;
42
+ tabsId: string;
43
+ } | {
44
+ type: 'close';
45
+ paneId: string;
46
+ } | {
47
+ type: 'float';
48
+ paneId: string;
49
+ } | {
50
+ type: 'popout';
51
+ paneId: string;
52
+ } | {
53
+ type: 'autoHide';
54
+ paneId: string;
55
+ side: DockSide;
56
+ } | {
57
+ type: 'pin';
58
+ paneId: string;
59
+ } | {
60
+ type: 'maximize';
61
+ tabsId: string;
62
+ maximized: boolean;
63
+ } | {
64
+ type: 'window';
65
+ windowId: string;
66
+ action: 'minimize' | 'maximize' | 'close' | 'autoHide';
67
+ } | {
68
+ type: 'focus';
69
+ paneId: string;
70
+ };
71
+ type Props = {
72
+ /** The whole workspace: tiled `main` + `floating` windows + `autoHide` edges. Bindable. */
73
+ workspace: DockManagerState;
74
+ /** Renders each pane's content, keyed off the `DockPane`. */
75
+ pane: Snippet<[DockPane]>;
76
+ /** Notified after any change. */
77
+ onChange?: (workspace: DockManagerState) => void;
78
+ /** Granular lifecycle events (activePane / close / float / popout / ...). */
79
+ onEvent?: (event: DockEvent) => void;
80
+ /** Minimum pane size in px along a split. Default 80. */
81
+ minSize?: number;
82
+ /** Allow dragging tabs to reorder them within a strip. Default `true`. */
83
+ reorderEnabled?: boolean;
84
+ /** Which side of each panel its tab strip sits on. Default `'top'`. */
85
+ headerPosition?: 'top' | 'bottom' | 'left' | 'right';
86
+ /** Keep inactive tabs mounted (hidden) so their content state persists.
87
+ * Default `false` (only the active tab renders). */
88
+ keepAlive?: boolean;
89
+ /** Hide the tab button on a single-pane leaf (no redundant title bar; the panel
90
+ * actions still show). Applies to the docked area, floating windows, and fly-outs. */
91
+ hideSingleTab?: boolean;
92
+ /** Offer the "pop out to a new browser window" panel action. Default `false` -
93
+ * most apps only need in-app floating windows, so the OS pop-out stays hidden
94
+ * unless you opt in. The `popout()` API still works regardless. */
95
+ allowPopout?: boolean;
96
+ /** Locked / split mode: a fixed set of resizable panes. Tabs can't be dragged
97
+ * (no reorder / float / dock) and the panel action buttons are hidden - only
98
+ * splitter resize + tab switching remain. Turns the manager into a plain
99
+ * split-view workspace. Default `false`. */
100
+ locked?: boolean;
101
+ /** Receive the imperative API once, on mount. */
102
+ onReady?: (api: DockManagerApi) => void;
103
+ };
104
+ declare const SvDockManager: import("svelte").Component<Props, {}, "workspace">;
105
+ type SvDockManager = ReturnType<typeof SvDockManager>;
106
+ export default SvDockManager;
@@ -1,228 +1,250 @@
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 { portalToBody } from './popover'
19
- import { nextEditorId } from './editor-contract'
20
- import { createFocusTrap } from './a11y/focus-trap'
21
- import { lockScroll } from './a11y/scroll-lock'
22
- import { createDismissableLayer } from './a11y/dismissable'
23
-
24
- /** Edge the drawer slides from. Kept in sync with the `DrawerSide` export in
25
- * index.ts (a bare type-only module script trips the Svelte/Vite parser). */
26
- type DrawerSide = 'right' | 'left' | 'top' | 'bottom'
27
-
28
- type Props = {
29
- open?: boolean
30
- onClose?: () => void
31
- /** Edge the drawer slides from. Default 'right'. */
32
- side?: DrawerSide
33
- /** Panel size along its axis (width for left/right, height for top/bottom).
34
- * Any CSS length; defaults to a sensible per-axis value. */
35
- size?: string
36
- title?: string
37
- closeOnBackdrop?: boolean
38
- closeOnEsc?: boolean
39
- /** Hide the header close (x) button. */
40
- hideClose?: boolean
41
- /** Render as a mobile bottom-sheet: bottom-anchored, rounded top, a grab
42
- * handle, and swipe-down-to-close. Overrides `side`. */
43
- sheet?: boolean
44
- /** Accessible name when there is no visible `title`. */
45
- ariaLabel?: string
46
- children?: Snippet
47
- footer?: Snippet
48
- }
49
-
50
- let {
51
- open = $bindable(false),
52
- onClose,
53
- side = 'right',
54
- size,
55
- title,
56
- closeOnBackdrop = true,
57
- closeOnEsc = true,
58
- hideClose = false,
59
- sheet = false,
60
- ariaLabel,
61
- children,
62
- footer,
63
- }: Props = $props()
64
-
65
- const titleId = nextEditorId('sv-drawer-title')
66
- let dialogEl = $state<HTMLDivElement | null>(null)
67
-
68
- // A sheet is a bottom drawer with mobile affordances.
69
- const effectiveSide = $derived<DrawerSide>(sheet ? 'bottom' : side)
70
- const horizontal = $derived(effectiveSide === 'left' || effectiveSide === 'right')
71
- const sizeVar = $derived(size ?? (horizontal ? 'min(400px, 92vw)' : 'min(360px, 85vh)'))
72
-
73
- function close() { open = false; onClose?.() }
74
-
75
- // Swipe-down-to-close for the sheet grab handle.
76
- let dragY = $state(0)
77
- let dragging = $state(false)
78
- let dragStartY = 0
79
- function onGrabDown(e: PointerEvent) {
80
- dragging = true
81
- dragStartY = e.clientY
82
- ;(e.currentTarget as HTMLElement).setPointerCapture?.(e.pointerId)
83
- }
84
- function onGrabMove(e: PointerEvent) {
85
- if (!dragging) return
86
- dragY = Math.max(0, e.clientY - dragStartY)
87
- }
88
- function onGrabUp(e: PointerEvent) {
89
- if (!dragging) return
90
- dragging = false
91
- ;(e.currentTarget as HTMLElement).releasePointerCapture?.(e.pointerId)
92
- if (dragY > 80) close()
93
- else dragY = 0
94
- }
95
-
96
- // Focus trap + scroll lock + Escape/backdrop dismissal, all from the shared
97
- // primitives - one tested implementation across every dialog-like overlay.
98
- $effect(() => {
99
- if (!open || !dialogEl) return
100
- dragY = 0
101
- const trap = createFocusTrap(dialogEl)
102
- trap.activate()
103
- const unlockScroll = lockScroll()
104
- const layer = createDismissableLayer({
105
- element: () => dialogEl,
106
- onDismiss: (reason) => {
107
- if (reason === 'escape' ? closeOnEsc : closeOnBackdrop) close()
108
- },
109
- })
110
- layer.activate()
111
- return () => {
112
- layer.release()
113
- unlockScroll()
114
- trap.release()
115
- }
116
- })
117
- </script>
118
-
119
- {#if open}
120
- <div class="sv-drawer__backdrop" use:portalToBody>
121
- <div
122
- bind:this={dialogEl}
123
- class="sv-drawer sv-drawer--{effectiveSide}"
124
- class:is-sheet={sheet}
125
- class:is-dragging={dragging}
126
- role="dialog"
127
- aria-modal="true"
128
- aria-label={!title ? ariaLabel : undefined}
129
- aria-labelledby={title ? titleId : undefined}
130
- tabindex="-1"
131
- style:--sv-drawer-size={sizeVar}
132
- style:transform={sheet && dragY ? `translateY(${dragY}px)` : undefined}
133
- >
134
- {#if sheet}
135
- <!-- svelte-ignore a11y_no_static_element_interactions -->
136
- <div
137
- class="sv-drawer__grab"
138
- aria-hidden="true"
139
- onpointerdown={onGrabDown}
140
- onpointermove={onGrabMove}
141
- onpointerup={onGrabUp}
142
- onpointercancel={onGrabUp}
143
- ><span></span></div>
144
- {/if}
145
- {#if title || !hideClose}
146
- <div class="sv-drawer__header">
147
- <h2 class="sv-drawer__title" id={titleId}>{title ?? ''}</h2>
148
- {#if !hideClose}
149
- <button type="button" class="sv-drawer__x" aria-label="Close" onclick={close}>&times;</button>
150
- {/if}
151
- </div>
152
- {/if}
153
- <div class="sv-drawer__body">{@render children?.()}</div>
154
- {#if footer}<div class="sv-drawer__footer">{@render footer()}</div>{/if}
155
- </div>
156
- </div>
157
- {/if}
158
-
159
- <style>
160
- :global(.sv-drawer__backdrop) {
161
- position: fixed; inset: 0; z-index: 2147483000;
162
- background: rgba(15, 23, 42, 0.45); backdrop-filter: blur(1.5px);
163
- animation: sv-drawer-fade 0.16s ease both;
164
- }
165
- @keyframes sv-drawer-fade { from { opacity: 0 } to { opacity: 1 } }
166
-
167
- :global(.sv-drawer) {
168
- position: fixed;
169
- display: flex; flex-direction: column;
170
- background: var(--sg-bg, #fff); color: var(--sg-fg, #0f172a);
171
- box-shadow: 0 24px 64px -16px rgba(15, 23, 42, 0.5);
172
- overflow: hidden;
173
- }
174
- /* Left / right: full height, fixed width, slide along X. `side` is a stated
175
- physical edge (like SvToaster's position prop), not a text-flow-relative
176
- "start/end" - so it stays physical left/right regardless of page dir. */
177
- :global(.sv-drawer--right), :global(.sv-drawer--left) {
178
- top: 0; bottom: 0; width: var(--sv-drawer-size); max-width: 100vw;
179
- }
180
- :global(.sv-drawer--right) { right: 0; border-left: 1px solid var(--sg-border, #e2e8f0); animation: sv-drawer-in-right 0.22s cubic-bezier(0.16, 1, 0.3, 1) both; }
181
- :global(.sv-drawer--left) { left: 0; border-right: 1px solid var(--sg-border, #e2e8f0); animation: sv-drawer-in-left 0.22s cubic-bezier(0.16, 1, 0.3, 1) both; }
182
- /* Top / bottom: full width, fixed height, slide along Y. */
183
- :global(.sv-drawer--top), :global(.sv-drawer--bottom) {
184
- left: 0; right: 0; height: var(--sv-drawer-size); max-height: 100vh;
185
- }
186
- :global(.sv-drawer--top) { top: 0; border-bottom: 1px solid var(--sg-border, #e2e8f0); animation: sv-drawer-in-top 0.22s cubic-bezier(0.16, 1, 0.3, 1) both; }
187
- :global(.sv-drawer--bottom) { bottom: 0; border-top: 1px solid var(--sg-border, #e2e8f0); animation: sv-drawer-in-bottom 0.22s cubic-bezier(0.16, 1, 0.3, 1) both; }
188
-
189
- /* Mobile bottom-sheet: centered, fixed width, rounded top, grab handle. */
190
- :global(.sv-drawer.is-sheet) {
191
- left: 0; right: 0; margin: 0 auto; top: auto;
192
- width: min(560px, 100vw); height: auto; max-height: 85vh;
193
- border: 1px solid var(--sg-border, #e2e8f0); border-bottom: 0;
194
- border-radius: 16px 16px 0 0;
195
- transition: transform 0.22s cubic-bezier(0.16, 1, 0.3, 1);
196
- }
197
- :global(.sv-drawer.is-sheet.is-dragging) { transition: none; }
198
- :global(.sv-drawer__grab) {
199
- flex: none; display: grid; place-items: center; padding: 8px 0 2px; cursor: grab; touch-action: none;
200
- }
201
- :global(.sv-drawer__grab span) {
202
- display: block; width: 40px; height: 4px; border-radius: 999px; background: var(--sg-border, #cbd5e1);
203
- }
204
-
205
- @keyframes sv-drawer-in-right { from { transform: translateX(100%) } to { transform: translateX(0) } }
206
- @keyframes sv-drawer-in-left { from { transform: translateX(-100%) } to { transform: translateX(0) } }
207
- @keyframes sv-drawer-in-top { from { transform: translateY(-100%) } to { transform: translateY(0) } }
208
- @keyframes sv-drawer-in-bottom { from { transform: translateY(100%) } to { transform: translateY(0) } }
209
- @media (prefers-reduced-motion: reduce) {
210
- :global(.sv-drawer__backdrop), :global(.sv-drawer) { animation: none }
211
- }
212
-
213
- :global(.sv-drawer__header) {
214
- display: flex; align-items: center; gap: 12px; padding: 13px 16px;
215
- border-bottom: 1px solid var(--sg-border, #e2e8f0);
216
- }
217
- :global(.sv-drawer__title) { flex: 1; margin: 0; font-size: 15px; font-weight: 650; }
218
- :global(.sv-drawer__x) {
219
- flex: none; width: 28px; height: 28px; display: grid; place-items: center;
220
- background: none; border: 0; color: var(--sg-muted, #64748b); cursor: pointer; border-radius: 6px; font-size: 20px; line-height: 1;
221
- }
222
- :global(.sv-drawer__x:hover) { background: var(--sg-row-hover-bg, #f1f5f9); color: var(--sg-fg, #0f172a); }
223
- :global(.sv-drawer__body) { padding: 16px; overflow: auto; flex: 1; font-size: 13.5px; line-height: 1.6; }
224
- :global(.sv-drawer__footer) {
225
- display: flex; justify-content: flex-end; gap: 8px; padding: 12px 16px;
226
- border-top: 1px solid var(--sg-border, #e2e8f0);
227
- }
228
- </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
+ })
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>
@@ -35,6 +35,10 @@ type Props = {
35
35
  sheet?: boolean;
36
36
  /** Accessible name when there is no visible `title`. */
37
37
  ariaLabel?: string;
38
+ /** Fired after the close (exit) animation has finished and the drawer has
39
+ * left the DOM. Use it to clear the data the drawer was showing so the
40
+ * content stays put while it slides out. */
41
+ onClosed?: () => void;
38
42
  children?: Snippet;
39
43
  footer?: Snippet;
40
44
  };