@hydrateless/svelte 0.8.0 → 0.10.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.
- package/README.md +173 -38
- package/dist/components/Accordion.svelte +29 -17
- package/dist/components/Accordion.svelte.d.ts +3 -0
- package/dist/components/AccordionItem.svelte +21 -12
- package/dist/components/AccordionItem.svelte.d.ts +6 -4
- package/dist/components/Alert.svelte +4 -0
- package/dist/components/Alert.svelte.d.ts +4 -0
- package/dist/components/Avatar.svelte +5 -0
- package/dist/components/Avatar.svelte.d.ts +5 -0
- package/dist/components/AvatarGroup.svelte +1 -0
- package/dist/components/AvatarGroup.svelte.d.ts +1 -0
- package/dist/components/Badge.svelte +4 -0
- package/dist/components/Badge.svelte.d.ts +4 -0
- package/dist/components/Breadcrumb.svelte +1 -0
- package/dist/components/Breadcrumb.svelte.d.ts +1 -0
- package/dist/components/BreadcrumbItem.svelte +3 -0
- package/dist/components/BreadcrumbItem.svelte.d.ts +3 -0
- package/dist/components/Button.svelte +7 -0
- package/dist/components/Button.svelte.d.ts +7 -0
- package/dist/components/Card.svelte +2 -0
- package/dist/components/Card.svelte.d.ts +2 -0
- package/dist/components/CardBody.svelte +1 -0
- package/dist/components/CardBody.svelte.d.ts +1 -0
- package/dist/components/CardDescription.svelte +1 -0
- package/dist/components/CardDescription.svelte.d.ts +1 -0
- package/dist/components/CardFooter.svelte +1 -0
- package/dist/components/CardFooter.svelte.d.ts +1 -0
- package/dist/components/CardHeader.svelte +1 -0
- package/dist/components/CardHeader.svelte.d.ts +1 -0
- package/dist/components/CardTitle.svelte +1 -0
- package/dist/components/CardTitle.svelte.d.ts +1 -0
- package/dist/components/Checkbox.svelte +24 -2
- package/dist/components/Checkbox.svelte.d.ts +2 -0
- package/dist/components/Combobox.svelte +37 -26
- package/dist/components/Combobox.svelte.d.ts +12 -3
- package/dist/components/ComboboxInput.svelte +21 -2
- package/dist/components/ComboboxInput.svelte.d.ts +1 -0
- package/dist/components/ComboboxList.svelte +4 -1
- package/dist/components/ComboboxList.svelte.d.ts +1 -0
- package/dist/components/ComboboxOption.svelte +6 -2
- package/dist/components/ComboboxOption.svelte.d.ts +4 -0
- package/dist/components/Command.svelte +36 -9
- package/dist/components/Command.svelte.d.ts +12 -5
- package/dist/components/CommandEmpty.svelte +1 -0
- package/dist/components/CommandEmpty.svelte.d.ts +1 -0
- package/dist/components/CommandGroup.svelte +1 -0
- package/dist/components/CommandGroup.svelte.d.ts +1 -0
- package/dist/components/CommandItem.svelte +2 -0
- package/dist/components/CommandItem.svelte.d.ts +2 -0
- package/dist/components/CommandList.svelte +1 -0
- package/dist/components/CommandList.svelte.d.ts +1 -0
- package/dist/components/Disclosure.svelte +29 -19
- package/dist/components/Disclosure.svelte.d.ts +6 -1
- package/dist/components/Drawer.svelte +26 -20
- package/dist/components/Drawer.svelte.d.ts +6 -1
- package/dist/components/DrawerBody.svelte +1 -0
- package/dist/components/DrawerBody.svelte.d.ts +1 -0
- package/dist/components/DrawerFooter.svelte +1 -0
- package/dist/components/DrawerFooter.svelte.d.ts +1 -0
- package/dist/components/DrawerHeader.svelte +1 -0
- package/dist/components/DrawerHeader.svelte.d.ts +1 -0
- package/dist/components/Dropdown.svelte +48 -24
- package/dist/components/Dropdown.svelte.d.ts +13 -2
- package/dist/components/DropdownGroup.svelte +19 -0
- package/dist/components/DropdownGroup.svelte.d.ts +11 -0
- package/dist/components/DropdownItem.svelte +28 -4
- package/dist/components/DropdownItem.svelte.d.ts +11 -2
- package/dist/components/DropdownMenu.svelte +14 -2
- package/dist/components/DropdownMenu.svelte.d.ts +1 -0
- package/dist/components/DropdownSeparator.svelte +3 -2
- package/dist/components/DropdownTrigger.svelte +14 -2
- package/dist/components/DropdownTrigger.svelte.d.ts +1 -0
- package/dist/components/Field.svelte +42 -3
- package/dist/components/Field.svelte.d.ts +16 -0
- package/dist/components/FieldError.svelte +4 -3
- package/dist/components/FieldError.svelte.d.ts +1 -0
- package/dist/components/FieldHelp.svelte +4 -3
- package/dist/components/FieldHelp.svelte.d.ts +1 -0
- package/dist/components/FieldLabel.svelte +4 -3
- package/dist/components/FieldLabel.svelte.d.ts +1 -0
- package/dist/components/Fieldset.svelte +2 -0
- package/dist/components/Fieldset.svelte.d.ts +2 -0
- package/dist/components/Input.svelte +22 -6
- package/dist/components/Input.svelte.d.ts +3 -0
- package/dist/components/Kbd.svelte +1 -0
- package/dist/components/Kbd.svelte.d.ts +1 -0
- package/dist/components/Menu.svelte +36 -23
- package/dist/components/Menu.svelte.d.ts +18 -5
- package/dist/components/MenuItem.svelte +46 -18
- package/dist/components/MenuItem.svelte.d.ts +10 -7
- package/dist/components/MenuSubmenu.svelte +30 -0
- package/dist/components/MenuSubmenu.svelte.d.ts +17 -0
- package/dist/components/Modal.svelte +17 -18
- package/dist/components/Modal.svelte.d.ts +4 -0
- package/dist/components/ModalBody.svelte +1 -0
- package/dist/components/ModalBody.svelte.d.ts +1 -0
- package/dist/components/ModalFooter.svelte +1 -0
- package/dist/components/ModalFooter.svelte.d.ts +1 -0
- package/dist/components/ModalHeader.svelte +1 -0
- package/dist/components/ModalHeader.svelte.d.ts +1 -0
- package/dist/components/Pagination.svelte +5 -0
- package/dist/components/Pagination.svelte.d.ts +5 -0
- package/dist/components/Popover.svelte +37 -20
- package/dist/components/Popover.svelte.d.ts +12 -2
- package/dist/components/Progress.svelte +4 -0
- package/dist/components/Progress.svelte.d.ts +4 -0
- package/dist/components/Radio.svelte +2 -0
- package/dist/components/Radio.svelte.d.ts +2 -0
- package/dist/components/RadioGroup.svelte +34 -4
- package/dist/components/RadioGroup.svelte.d.ts +10 -1
- package/dist/components/SegmentedControl.svelte +25 -10
- package/dist/components/SegmentedControl.svelte.d.ts +11 -3
- package/dist/components/Select.svelte +16 -5
- package/dist/components/Select.svelte.d.ts +4 -0
- package/dist/components/Separator.svelte +2 -0
- package/dist/components/Separator.svelte.d.ts +2 -0
- package/dist/components/Skeleton.svelte +6 -3
- package/dist/components/Skeleton.svelte.d.ts +4 -1
- package/dist/components/SkipLink.svelte +1 -0
- package/dist/components/SkipLink.svelte.d.ts +1 -0
- package/dist/components/Slider.svelte +23 -2
- package/dist/components/Slider.svelte.d.ts +1 -0
- package/dist/components/Spinner.svelte +2 -0
- package/dist/components/Spinner.svelte.d.ts +2 -0
- package/dist/components/Switch.svelte +25 -2
- package/dist/components/Switch.svelte.d.ts +2 -0
- package/dist/components/Tab.svelte +20 -3
- package/dist/components/Tab.svelte.d.ts +2 -1
- package/dist/components/TabList.svelte +1 -0
- package/dist/components/TabList.svelte.d.ts +1 -0
- package/dist/components/TabPanel.svelte +12 -2
- package/dist/components/TabPanel.svelte.d.ts +2 -1
- package/dist/components/Table.svelte +30 -0
- package/dist/components/Table.svelte.d.ts +17 -0
- package/dist/components/Tabs.svelte +38 -19
- package/dist/components/Tabs.svelte.d.ts +6 -1
- package/dist/components/Textarea.svelte +26 -6
- package/dist/components/Textarea.svelte.d.ts +5 -0
- package/dist/components/ToastRegion.svelte +18 -2
- package/dist/components/ToastRegion.svelte.d.ts +8 -1
- package/dist/components/Toc.svelte +19 -8
- package/dist/components/Toc.svelte.d.ts +6 -0
- package/dist/components/Tooltip.svelte +79 -22
- package/dist/components/Tooltip.svelte.d.ts +31 -9
- package/dist/context.d.ts +99 -8
- package/dist/context.js +60 -11
- package/dist/index.d.ts +8 -4
- package/dist/index.js +6 -4
- package/dist/registry.svelte.d.ts +29 -0
- package/dist/registry.svelte.js +44 -0
- package/dist/toast.d.ts +12 -7
- package/dist/toast.js +23 -11
- package/dist/useEnhancer.svelte.d.ts +40 -0
- package/dist/useEnhancer.svelte.js +58 -0
- package/package.json +4 -4
- package/dist/actions.d.ts +0 -25
- package/dist/actions.js +0 -31
package/dist/context.js
CHANGED
|
@@ -1,31 +1,80 @@
|
|
|
1
1
|
import { getContext, setContext } from 'svelte';
|
|
2
2
|
const FIELD_KEY = Symbol('hl-field');
|
|
3
|
-
/** Publish {@link FieldContext}
|
|
3
|
+
/** Publish a {@link FieldContext}; called by `<Field>` only. @internal */
|
|
4
4
|
export function setFieldContext(ctx) {
|
|
5
5
|
setContext(FIELD_KEY, ctx);
|
|
6
6
|
}
|
|
7
|
-
/** Read the nearest {@link FieldContext}, or `undefined` outside a Field. */
|
|
7
|
+
/** Read the nearest {@link FieldContext}, or `undefined` outside a Field. @internal */
|
|
8
8
|
export function getFieldContext() {
|
|
9
9
|
return getContext(FIELD_KEY);
|
|
10
10
|
}
|
|
11
|
-
/**
|
|
12
|
-
|
|
11
|
+
/**
|
|
12
|
+
* Wire a custom control into the enclosing `<Field>`. Returns `null` outside a
|
|
13
|
+
* Field, so controls can call it unconditionally. Must be called during
|
|
14
|
+
* component initialization, like any context read. The returned object's
|
|
15
|
+
* properties are getters, so they stay reactive in the template:
|
|
16
|
+
*
|
|
17
|
+
* ```svelte
|
|
18
|
+
* <script lang="ts">
|
|
19
|
+
* const field = useField();
|
|
20
|
+
* </script>
|
|
21
|
+
*
|
|
22
|
+
* <input id={field?.id} aria-describedby={field?.describedBy} aria-invalid={field?.invalid || undefined} />
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
export function useField() {
|
|
13
26
|
const ctx = getFieldContext();
|
|
14
27
|
if (!ctx)
|
|
15
|
-
return
|
|
16
|
-
const describedBy = [ctx.helpId, ctx.invalid ? ctx.errorId : null].filter(Boolean).join(' ');
|
|
28
|
+
return null;
|
|
17
29
|
return {
|
|
18
|
-
id
|
|
19
|
-
|
|
20
|
-
|
|
30
|
+
get id() {
|
|
31
|
+
return ctx.id;
|
|
32
|
+
},
|
|
33
|
+
get describedBy() {
|
|
34
|
+
const ids = [ctx.helpId, ctx.invalid ? ctx.errorId : null].filter(Boolean).join(' ');
|
|
35
|
+
return ids || undefined;
|
|
36
|
+
},
|
|
37
|
+
get invalid() {
|
|
38
|
+
return ctx.invalid;
|
|
39
|
+
},
|
|
40
|
+
get required() {
|
|
41
|
+
return ctx.required;
|
|
42
|
+
},
|
|
21
43
|
};
|
|
22
44
|
}
|
|
23
45
|
const RADIO_GROUP_KEY = Symbol('hl-radio-group');
|
|
24
|
-
/** Publish {@link RadioGroupContext}
|
|
46
|
+
/** Publish a {@link RadioGroupContext}; called by `<RadioGroup>` only. @internal */
|
|
25
47
|
export function setRadioGroupContext(ctx) {
|
|
26
48
|
setContext(RADIO_GROUP_KEY, ctx);
|
|
27
49
|
}
|
|
28
|
-
/** Read the nearest {@link RadioGroupContext}, or `undefined` outside a group. */
|
|
50
|
+
/** Read the nearest {@link RadioGroupContext}, or `undefined` outside a group. @internal */
|
|
29
51
|
export function getRadioGroupContext() {
|
|
30
52
|
return getContext(RADIO_GROUP_KEY);
|
|
31
53
|
}
|
|
54
|
+
const DROPDOWN_KEY = Symbol('hl-dropdown');
|
|
55
|
+
/** Publish a {@link DropdownContext}; called by `<Dropdown>` only. @internal */
|
|
56
|
+
export function setDropdownContext(ctx) {
|
|
57
|
+
setContext(DROPDOWN_KEY, ctx);
|
|
58
|
+
}
|
|
59
|
+
/** Read the nearest {@link DropdownContext}, or `undefined` outside a Dropdown. @internal */
|
|
60
|
+
export function getDropdownContext() {
|
|
61
|
+
return getContext(DROPDOWN_KEY);
|
|
62
|
+
}
|
|
63
|
+
const TABS_KEY = Symbol('hl-tabs');
|
|
64
|
+
/** Publish a {@link TabsContext}; called by `<Tabs>` only. @internal */
|
|
65
|
+
export function setTabsContext(ctx) {
|
|
66
|
+
setContext(TABS_KEY, ctx);
|
|
67
|
+
}
|
|
68
|
+
/** Read the nearest {@link TabsContext}, or `undefined` outside Tabs. @internal */
|
|
69
|
+
export function getTabsContext() {
|
|
70
|
+
return getContext(TABS_KEY);
|
|
71
|
+
}
|
|
72
|
+
const ACCORDION_KEY = Symbol('hl-accordion');
|
|
73
|
+
/** Publish an {@link AccordionContext}; called by `<Accordion>` only. @internal */
|
|
74
|
+
export function setAccordionContext(ctx) {
|
|
75
|
+
setContext(ACCORDION_KEY, ctx);
|
|
76
|
+
}
|
|
77
|
+
/** Read the nearest {@link AccordionContext}, or `undefined` outside an Accordion. @internal */
|
|
78
|
+
export function getAccordionContext() {
|
|
79
|
+
return getContext(ACCORDION_KEY);
|
|
80
|
+
}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
export {
|
|
1
|
+
export { useEnhancer } from './useEnhancer.svelte.js';
|
|
2
|
+
export type { UseEnhancer } from './useEnhancer.svelte.js';
|
|
3
|
+
export { useField } from './context.js';
|
|
4
|
+
export type { FieldBindings, TooltipTriggerProps } from './context.js';
|
|
2
5
|
export { useToast } from './toast.js';
|
|
3
|
-
export { fieldBindings } from './context.js';
|
|
4
|
-
export type { FieldContext, RadioGroupContext } from './context.js';
|
|
5
6
|
export { default as Accordion } from './components/Accordion.svelte';
|
|
6
7
|
export { default as AccordionItem } from './components/AccordionItem.svelte';
|
|
7
8
|
export { default as Disclosure } from './components/Disclosure.svelte';
|
|
@@ -13,9 +14,11 @@ export { default as Dropdown } from './components/Dropdown.svelte';
|
|
|
13
14
|
export { default as DropdownTrigger } from './components/DropdownTrigger.svelte';
|
|
14
15
|
export { default as DropdownMenu } from './components/DropdownMenu.svelte';
|
|
15
16
|
export { default as DropdownItem } from './components/DropdownItem.svelte';
|
|
17
|
+
export { default as DropdownGroup } from './components/DropdownGroup.svelte';
|
|
16
18
|
export { default as DropdownSeparator } from './components/DropdownSeparator.svelte';
|
|
17
19
|
export { default as Menu } from './components/Menu.svelte';
|
|
18
20
|
export { default as MenuItem } from './components/MenuItem.svelte';
|
|
21
|
+
export { default as MenuSubmenu } from './components/MenuSubmenu.svelte';
|
|
19
22
|
export { default as Modal } from './components/Modal.svelte';
|
|
20
23
|
export { default as ModalHeader } from './components/ModalHeader.svelte';
|
|
21
24
|
export { default as ModalBody } from './components/ModalBody.svelte';
|
|
@@ -69,7 +72,8 @@ export { default as Avatar } from './components/Avatar.svelte';
|
|
|
69
72
|
export { default as AvatarGroup } from './components/AvatarGroup.svelte';
|
|
70
73
|
export { default as Kbd } from './components/Kbd.svelte';
|
|
71
74
|
export { default as Separator } from './components/Separator.svelte';
|
|
75
|
+
export { default as Table } from './components/Table.svelte';
|
|
72
76
|
export { default as Pagination } from './components/Pagination.svelte';
|
|
73
77
|
export { default as Toc } from './components/Toc.svelte';
|
|
74
78
|
export { default as SkipLink } from './components/SkipLink.svelte';
|
|
75
|
-
export type { AccordionApi, CommandApi, ComboboxApi, DisclosureApi, Disposer, DrawerApi, DropdownApi, EnhancerHandle, MenuApi, ModalApi, PopoverApi, TabsApi, ToastApi, TocApi, TooltipApi, } from '@hydrateless/enhancers';
|
|
79
|
+
export type { AccordionApi, CommandApi, ComboboxApi, DisclosureApi, Disposer, DrawerApi, DropdownApi, EnhancerHandle, MenuApi, ModalApi, PopoverApi, TabsApi, ToastApi, ToastIntent, ToastOptions, TocApi, TooltipApi, } from '@hydrateless/enhancers';
|
package/dist/index.js
CHANGED
|
@@ -1,8 +1,7 @@
|
|
|
1
|
-
//
|
|
2
|
-
export {
|
|
1
|
+
// Low-level layer: the one escape hatch, field wiring, and toasts
|
|
2
|
+
export { useEnhancer } from './useEnhancer.svelte.js';
|
|
3
|
+
export { useField } from './context.js';
|
|
3
4
|
export { useToast } from './toast.js';
|
|
4
|
-
// Field/radio context helpers
|
|
5
|
-
export { fieldBindings } from './context.js';
|
|
6
5
|
// Disclosure
|
|
7
6
|
export { default as Accordion } from './components/Accordion.svelte';
|
|
8
7
|
export { default as AccordionItem } from './components/AccordionItem.svelte';
|
|
@@ -17,10 +16,12 @@ export { default as Dropdown } from './components/Dropdown.svelte';
|
|
|
17
16
|
export { default as DropdownTrigger } from './components/DropdownTrigger.svelte';
|
|
18
17
|
export { default as DropdownMenu } from './components/DropdownMenu.svelte';
|
|
19
18
|
export { default as DropdownItem } from './components/DropdownItem.svelte';
|
|
19
|
+
export { default as DropdownGroup } from './components/DropdownGroup.svelte';
|
|
20
20
|
export { default as DropdownSeparator } from './components/DropdownSeparator.svelte';
|
|
21
21
|
// Menu
|
|
22
22
|
export { default as Menu } from './components/Menu.svelte';
|
|
23
23
|
export { default as MenuItem } from './components/MenuItem.svelte';
|
|
24
|
+
export { default as MenuSubmenu } from './components/MenuSubmenu.svelte';
|
|
24
25
|
// Overlays
|
|
25
26
|
export { default as Modal } from './components/Modal.svelte';
|
|
26
27
|
export { default as ModalHeader } from './components/ModalHeader.svelte';
|
|
@@ -82,6 +83,7 @@ export { default as Avatar } from './components/Avatar.svelte';
|
|
|
82
83
|
export { default as AvatarGroup } from './components/AvatarGroup.svelte';
|
|
83
84
|
export { default as Kbd } from './components/Kbd.svelte';
|
|
84
85
|
export { default as Separator } from './components/Separator.svelte';
|
|
86
|
+
export { default as Table } from './components/Table.svelte';
|
|
85
87
|
// Navigation
|
|
86
88
|
export { default as Pagination } from './components/Pagination.svelte';
|
|
87
89
|
export { default as Toc } from './components/Toc.svelte';
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/** A live position in a parent's item list plus its disposer. @internal */
|
|
2
|
+
export interface Registration {
|
|
3
|
+
/** Current index in document order; shifts as siblings mount or unmount. */
|
|
4
|
+
readonly index: number;
|
|
5
|
+
/**
|
|
6
|
+
* Report the rendered element (from `bind:this`, inside an `$effect`) so
|
|
7
|
+
* items inserted out of registration order, such as a prepend, sort into
|
|
8
|
+
* their real document position.
|
|
9
|
+
*/
|
|
10
|
+
attach(node: Element | null): void;
|
|
11
|
+
/** Free the slot (call from `onDestroy`). */
|
|
12
|
+
unregister(): void;
|
|
13
|
+
}
|
|
14
|
+
/** A parent-side list of registered children. @internal */
|
|
15
|
+
export interface Registry<T = void> {
|
|
16
|
+
/** Register a child; `value` is any per-child getter the parent needs. */
|
|
17
|
+
register(value: T): Registration;
|
|
18
|
+
/** Registered children's values in document order. */
|
|
19
|
+
readonly entries: T[];
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Tracks children so their indexes stay dense and in document order while an
|
|
23
|
+
* `{#each}` inserts or removes them after mount. Registration happens during
|
|
24
|
+
* child init (so server output is right), and the write is untracked to keep
|
|
25
|
+
* it out of the parent's render. Shared by the accordion and tabs, whose
|
|
26
|
+
* enhancers fall back to the same positional indexes.
|
|
27
|
+
* @internal
|
|
28
|
+
*/
|
|
29
|
+
export declare function createRegistry<T = void>(): Registry<T>;
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import { untrack } from 'svelte';
|
|
2
|
+
const DOCUMENT_POSITION_FOLLOWING = 4;
|
|
3
|
+
/** Orders mounted entries by document position; unmounted ones keep their place. */
|
|
4
|
+
function byDocumentOrder(a, b) {
|
|
5
|
+
if (!a.node || !b.node || a.node === b.node)
|
|
6
|
+
return 0;
|
|
7
|
+
return a.node.compareDocumentPosition(b.node) & DOCUMENT_POSITION_FOLLOWING ? -1 : 1;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Tracks children so their indexes stay dense and in document order while an
|
|
11
|
+
* `{#each}` inserts or removes them after mount. Registration happens during
|
|
12
|
+
* child init (so server output is right), and the write is untracked to keep
|
|
13
|
+
* it out of the parent's render. Shared by the accordion and tabs, whose
|
|
14
|
+
* enhancers fall back to the same positional indexes.
|
|
15
|
+
* @internal
|
|
16
|
+
*/
|
|
17
|
+
export function createRegistry() {
|
|
18
|
+
let items = $state.raw([]);
|
|
19
|
+
return {
|
|
20
|
+
get entries() {
|
|
21
|
+
return items.map((item) => item.value);
|
|
22
|
+
},
|
|
23
|
+
register(value) {
|
|
24
|
+
const entry = { value, node: null };
|
|
25
|
+
untrack(() => {
|
|
26
|
+
items = [...items, entry];
|
|
27
|
+
});
|
|
28
|
+
return {
|
|
29
|
+
get index() {
|
|
30
|
+
return items.indexOf(entry);
|
|
31
|
+
},
|
|
32
|
+
attach(node) {
|
|
33
|
+
if (entry.node === node)
|
|
34
|
+
return;
|
|
35
|
+
entry.node = node;
|
|
36
|
+
items = [...items].sort(byDocumentOrder);
|
|
37
|
+
},
|
|
38
|
+
unregister() {
|
|
39
|
+
items = items.filter((item) => item !== entry);
|
|
40
|
+
},
|
|
41
|
+
};
|
|
42
|
+
},
|
|
43
|
+
};
|
|
44
|
+
}
|
package/dist/toast.d.ts
CHANGED
|
@@ -1,14 +1,19 @@
|
|
|
1
1
|
import { type EnhanceToastOptions, type ToastApi } from '@hydrateless/enhancers';
|
|
2
2
|
/**
|
|
3
|
-
* Imperative toast API
|
|
4
|
-
*
|
|
5
|
-
*
|
|
3
|
+
* Imperative toast API. Toasts render into the page's `[data-hl-toast-region]`
|
|
4
|
+
* (mount a `<ToastRegion>` to control where it lives); when none exists, one
|
|
5
|
+
* is appended to `<body>` on the first `show`. Safe to call during component
|
|
6
|
+
* initialization and on the server, since nothing touches the DOM until
|
|
7
|
+
* `show`/`dismiss` run.
|
|
6
8
|
*
|
|
7
|
-
* ```
|
|
8
|
-
*
|
|
9
|
+
* ```svelte
|
|
10
|
+
* <script lang="ts">
|
|
11
|
+
* import { useToast } from '@hydrateless/svelte';
|
|
9
12
|
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
13
|
+
* const toast = useToast();
|
|
14
|
+
* </script>
|
|
15
|
+
*
|
|
16
|
+
* <button onclick={() => toast.show('Saved', { intent: 'success' })}>Save</button>
|
|
12
17
|
* ```
|
|
13
18
|
*/
|
|
14
19
|
export declare function useToast(options?: EnhanceToastOptions): ToastApi;
|
package/dist/toast.js
CHANGED
|
@@ -1,26 +1,38 @@
|
|
|
1
1
|
import { enhanceToast } from '@hydrateless/enhancers';
|
|
2
|
-
let shared = null;
|
|
3
2
|
/**
|
|
4
|
-
* Imperative toast API
|
|
5
|
-
*
|
|
6
|
-
*
|
|
3
|
+
* Imperative toast API. Toasts render into the page's `[data-hl-toast-region]`
|
|
4
|
+
* (mount a `<ToastRegion>` to control where it lives); when none exists, one
|
|
5
|
+
* is appended to `<body>` on the first `show`. Safe to call during component
|
|
6
|
+
* initialization and on the server, since nothing touches the DOM until
|
|
7
|
+
* `show`/`dismiss` run.
|
|
7
8
|
*
|
|
8
|
-
* ```
|
|
9
|
-
*
|
|
9
|
+
* ```svelte
|
|
10
|
+
* <script lang="ts">
|
|
11
|
+
* import { useToast } from '@hydrateless/svelte';
|
|
10
12
|
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
+
* const toast = useToast();
|
|
14
|
+
* </script>
|
|
15
|
+
*
|
|
16
|
+
* <button onclick={() => toast.show('Saved', { intent: 'success' })}>Save</button>
|
|
13
17
|
* ```
|
|
14
18
|
*/
|
|
15
19
|
export function useToast(options) {
|
|
20
|
+
// Resolved per call rather than cached: `enhanceToast` hands back the live
|
|
21
|
+
// API of an already-enhanced region, so this follows a `<ToastRegion>` that
|
|
22
|
+
// mounts or unmounts after `useToast()` was called.
|
|
23
|
+
const resolve = () => enhanceToast(undefined, options).api;
|
|
16
24
|
return {
|
|
17
25
|
show(message, opts) {
|
|
18
|
-
|
|
19
|
-
|
|
26
|
+
const api = resolve();
|
|
27
|
+
if (!api)
|
|
28
|
+
throw new Error('useToast().show() needs a document to render into');
|
|
20
29
|
return api.show(message, opts);
|
|
21
30
|
},
|
|
22
31
|
dismiss(toast) {
|
|
23
|
-
|
|
32
|
+
resolve()?.dismiss(toast);
|
|
33
|
+
},
|
|
34
|
+
dismissAll() {
|
|
35
|
+
resolve()?.dismissAll();
|
|
24
36
|
},
|
|
25
37
|
};
|
|
26
38
|
}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import type { Attachment } from 'svelte/attachments';
|
|
2
|
+
import type { EnhancerHandle } from '@hydrateless/enhancers';
|
|
3
|
+
/** What {@link useEnhancer} returns: an attachment for the root plus the live API. */
|
|
4
|
+
export interface UseEnhancer<Api> {
|
|
5
|
+
/**
|
|
6
|
+
* Attach to the element the enhancer should treat as its container:
|
|
7
|
+
* `<div {@attach enhancer.attach}>`. Runs the enhancer when the element
|
|
8
|
+
* mounts and destroys it when the element is removed or the options change.
|
|
9
|
+
*/
|
|
10
|
+
readonly attach: Attachment<HTMLElement>;
|
|
11
|
+
/** The enhanced root's imperative API, or `null` while nothing is attached. */
|
|
12
|
+
readonly api: Api | null;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Bind any Hydrateless enhancer to an element for its lifetime. This is the
|
|
16
|
+
* one low-level escape hatch the Svelte package offers, and every component in
|
|
17
|
+
* it is built on the same call, so custom wrappers behave exactly like the
|
|
18
|
+
* shipped ones.
|
|
19
|
+
*
|
|
20
|
+
* `getOptions` is read inside the attachment, so any reactive state it touches
|
|
21
|
+
* re-runs the enhancer (destroy, then enhance again with the fresh options).
|
|
22
|
+
* Wrap values that should only seed the initial state, such as a bound
|
|
23
|
+
* `value` passed as `defaultValue`, in `untrack` to keep them from retriggering
|
|
24
|
+
* it. Callbacks are invoked later, outside the attachment, so reading props
|
|
25
|
+
* inside them doesn't track. Options left `undefined` are dropped so the
|
|
26
|
+
* enhancer's own defaults apply.
|
|
27
|
+
*
|
|
28
|
+
* ```svelte
|
|
29
|
+
* <script lang="ts">
|
|
30
|
+
* import { enhanceTabs } from '@hydrateless/enhancers';
|
|
31
|
+
* import { useEnhancer } from '@hydrateless/svelte';
|
|
32
|
+
*
|
|
33
|
+
* const tabs = useEnhancer(enhanceTabs, () => ({ activation: 'automatic' }));
|
|
34
|
+
* // tabs.api?.setValue('two');
|
|
35
|
+
* </script>
|
|
36
|
+
*
|
|
37
|
+
* <div data-hl-tabs {@attach tabs.attach}>...</div>
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
40
|
+
export declare function useEnhancer<Options extends object, Api>(enhancer: (container: HTMLElement, options?: Partial<Options>) => EnhancerHandle<Api>, getOptions?: () => Partial<Options>): UseEnhancer<Api>;
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Drop `undefined` entries so an omitted component prop falls through to the
|
|
3
|
+
* enhancer's default instead of overriding it with `undefined` when the two
|
|
4
|
+
* option objects are merged.
|
|
5
|
+
*/
|
|
6
|
+
function defined(options) {
|
|
7
|
+
const out = {};
|
|
8
|
+
for (const key of Object.keys(options)) {
|
|
9
|
+
if (options[key] !== undefined)
|
|
10
|
+
out[key] = options[key];
|
|
11
|
+
}
|
|
12
|
+
return out;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Bind any Hydrateless enhancer to an element for its lifetime. This is the
|
|
16
|
+
* one low-level escape hatch the Svelte package offers, and every component in
|
|
17
|
+
* it is built on the same call, so custom wrappers behave exactly like the
|
|
18
|
+
* shipped ones.
|
|
19
|
+
*
|
|
20
|
+
* `getOptions` is read inside the attachment, so any reactive state it touches
|
|
21
|
+
* re-runs the enhancer (destroy, then enhance again with the fresh options).
|
|
22
|
+
* Wrap values that should only seed the initial state, such as a bound
|
|
23
|
+
* `value` passed as `defaultValue`, in `untrack` to keep them from retriggering
|
|
24
|
+
* it. Callbacks are invoked later, outside the attachment, so reading props
|
|
25
|
+
* inside them doesn't track. Options left `undefined` are dropped so the
|
|
26
|
+
* enhancer's own defaults apply.
|
|
27
|
+
*
|
|
28
|
+
* ```svelte
|
|
29
|
+
* <script lang="ts">
|
|
30
|
+
* import { enhanceTabs } from '@hydrateless/enhancers';
|
|
31
|
+
* import { useEnhancer } from '@hydrateless/svelte';
|
|
32
|
+
*
|
|
33
|
+
* const tabs = useEnhancer(enhanceTabs, () => ({ activation: 'automatic' }));
|
|
34
|
+
* // tabs.api?.setValue('two');
|
|
35
|
+
* </script>
|
|
36
|
+
*
|
|
37
|
+
* <div data-hl-tabs {@attach tabs.attach}>...</div>
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
40
|
+
export function useEnhancer(enhancer, getOptions = () => ({})) {
|
|
41
|
+
// `$state.raw` because the API object is opaque; proxying it would break
|
|
42
|
+
// getters that close over the enhancer's private state.
|
|
43
|
+
let api = $state.raw(null);
|
|
44
|
+
const attach = (node) => {
|
|
45
|
+
const handle = enhancer(node, defined(getOptions()));
|
|
46
|
+
api = handle.api;
|
|
47
|
+
return () => {
|
|
48
|
+
handle.destroy();
|
|
49
|
+
api = null;
|
|
50
|
+
};
|
|
51
|
+
};
|
|
52
|
+
return {
|
|
53
|
+
attach,
|
|
54
|
+
get api() {
|
|
55
|
+
return api;
|
|
56
|
+
},
|
|
57
|
+
};
|
|
58
|
+
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hydrateless/svelte",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "Svelte 5 bindings for Hydrateless:
|
|
3
|
+
"version": "0.10.0",
|
|
4
|
+
"description": "Svelte 5 bindings for Hydrateless: rune-based components, a useEnhancer attachment, field wiring, and toasts.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -32,10 +32,10 @@
|
|
|
32
32
|
"test": "vitest run"
|
|
33
33
|
},
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"@hydrateless/enhancers": "^0.
|
|
35
|
+
"@hydrateless/enhancers": "^0.10.0"
|
|
36
36
|
},
|
|
37
37
|
"peerDependencies": {
|
|
38
|
-
"svelte": ">=5"
|
|
38
|
+
"svelte": ">=5.29"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
41
|
"@sveltejs/package": "^2.3.0",
|
package/dist/actions.d.ts
DELETED
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
import type { Action } from 'svelte/action';
|
|
2
|
-
/** `use:accordion`: single-open behavior on a `[data-hl-accordion]` element. */
|
|
3
|
-
export declare const accordion: Action<HTMLElement, undefined, Record<never, any>>;
|
|
4
|
-
/** `use:disclosure`: groups `[data-hl-disclosure]` elements within the node. */
|
|
5
|
-
export declare const disclosure: Action<HTMLElement, undefined, Record<never, any>>;
|
|
6
|
-
/** `use:tabs`: ARIA + keyboard navigation on a `[data-hl-tabs]` element. */
|
|
7
|
-
export declare const tabs: Action<HTMLElement, undefined, Record<never, any>>;
|
|
8
|
-
/** `use:dropdown`: menu pattern on a `[data-hl-dropdown]` element. */
|
|
9
|
-
export declare const dropdown: Action<HTMLElement, undefined, Record<never, any>>;
|
|
10
|
-
/** `use:modal`: wires modal openers/closers + focus trap within the node. */
|
|
11
|
-
export declare const modal: Action<HTMLElement, undefined, Record<never, any>>;
|
|
12
|
-
/** `use:drawer`: wires drawer openers/closers within the node. */
|
|
13
|
-
export declare const drawer: Action<HTMLElement, undefined, Record<never, any>>;
|
|
14
|
-
/** `use:popover`: wires popover openers/closers within the node. */
|
|
15
|
-
export declare const popover: Action<HTMLElement, undefined, Record<never, any>>;
|
|
16
|
-
/** `use:tooltip`: wires `[data-hl-tooltip]` triggers within the node. */
|
|
17
|
-
export declare const tooltip: Action<HTMLElement, undefined, Record<never, any>>;
|
|
18
|
-
/** `use:toc`: builds a table of contents from the surrounding document. */
|
|
19
|
-
export declare const toc: Action<HTMLElement, undefined, Record<never, any>>;
|
|
20
|
-
/** `use:menu`: menubar/navigation pattern on a `[data-hl-menu]` element. */
|
|
21
|
-
export declare const menu: Action<HTMLElement, undefined, Record<never, any>>;
|
|
22
|
-
/** `use:combobox`: editable combobox on a `[data-hl-combobox]` element. */
|
|
23
|
-
export declare const combobox: Action<HTMLElement, undefined, Record<never, any>>;
|
|
24
|
-
/** `use:command`: command palette on a `[data-hl-command]` element. */
|
|
25
|
-
export declare const command: Action<HTMLElement, undefined, Record<never, any>>;
|
package/dist/actions.js
DELETED
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
import { enhanceAccordion, enhanceCombobox, enhanceCommand, enhanceDisclosure, enhanceDropdown, enhanceDrawer, enhanceMenu, enhanceModal, enhancePopover, enhanceTabs, enhanceToc, enhanceTooltip, } from '@hydrateless/enhancers';
|
|
2
|
-
function actionFor(enhance) {
|
|
3
|
-
return (node) => {
|
|
4
|
-
const { destroy } = enhance(node);
|
|
5
|
-
return { destroy };
|
|
6
|
-
};
|
|
7
|
-
}
|
|
8
|
-
/** `use:accordion`: single-open behavior on a `[data-hl-accordion]` element. */
|
|
9
|
-
export const accordion = actionFor((node) => enhanceAccordion(node));
|
|
10
|
-
/** `use:disclosure`: groups `[data-hl-disclosure]` elements within the node. */
|
|
11
|
-
export const disclosure = actionFor((node) => enhanceDisclosure(node));
|
|
12
|
-
/** `use:tabs`: ARIA + keyboard navigation on a `[data-hl-tabs]` element. */
|
|
13
|
-
export const tabs = actionFor((node) => enhanceTabs(node));
|
|
14
|
-
/** `use:dropdown`: menu pattern on a `[data-hl-dropdown]` element. */
|
|
15
|
-
export const dropdown = actionFor((node) => enhanceDropdown(node));
|
|
16
|
-
/** `use:modal`: wires modal openers/closers + focus trap within the node. */
|
|
17
|
-
export const modal = actionFor((node) => enhanceModal(node));
|
|
18
|
-
/** `use:drawer`: wires drawer openers/closers within the node. */
|
|
19
|
-
export const drawer = actionFor((node) => enhanceDrawer(node));
|
|
20
|
-
/** `use:popover`: wires popover openers/closers within the node. */
|
|
21
|
-
export const popover = actionFor((node) => enhancePopover(node));
|
|
22
|
-
/** `use:tooltip`: wires `[data-hl-tooltip]` triggers within the node. */
|
|
23
|
-
export const tooltip = actionFor((node) => enhanceTooltip(node));
|
|
24
|
-
/** `use:toc`: builds a table of contents from the surrounding document. */
|
|
25
|
-
export const toc = actionFor((node) => enhanceToc(node.ownerDocument));
|
|
26
|
-
/** `use:menu`: menubar/navigation pattern on a `[data-hl-menu]` element. */
|
|
27
|
-
export const menu = actionFor((node) => enhanceMenu(node));
|
|
28
|
-
/** `use:combobox`: editable combobox on a `[data-hl-combobox]` element. */
|
|
29
|
-
export const combobox = actionFor((node) => enhanceCombobox(node));
|
|
30
|
-
/** `use:command`: command palette on a `[data-hl-command]` element. */
|
|
31
|
-
export const command = actionFor((node) => enhanceCommand(node));
|