@maltjoy/core-vue 6.3.0 → 6.5.0-beta.0

package/dist/components/JoyDialog/VJoyDialog.vue.d.ts

@@ -4,7 +4,9 @@ import { TJoyDialogSizes } from './JoyDialog.types';
 declare function hide(options?: {
     fireHideEvent?: boolean;
 }): Promise<void>;
-declare function show(): Promise<void>;
+declare function show(options?: {
+    restoreFocusTo?: HTMLElement;
+}): Promise<void>;
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<import("vue").ExtractPropTypes<{
     id: {
         type: StringConstructor;
@@ -73,6 +75,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
     bannerSrc: {
         type: StringConstructor;
     };
+    /** Accessible name for the banner. Leave empty to treat the banner as decorative. */
+    bannerSrcAlt: {
+        type: StringConstructor;
+    };
     /** Based on CSS propetty background-position. https://developer.mozilla.org/en-US/docs/Web/CSS/background-position */
     bannerPosition: {
         type: StringConstructor;
@@ -85,6 +91,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
     hasFooterSlots: import("vue").ComputedRef<boolean>;
     hide: typeof hide;
     isOpen: import("vue").Ref<boolean, boolean>;
+    overlayId: import("vue").ComputedRef<string>;
     show: typeof show;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
     "dialog:open": () => any;
@@ -161,6 +168,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
     bannerSrc: {
         type: StringConstructor;
     };
+    /** Accessible name for the banner. Leave empty to treat the banner as decorative. */
+    bannerSrcAlt: {
+        type: StringConstructor;
+    };
     /** Based on CSS propetty background-position. https://developer.mozilla.org/en-US/docs/Web/CSS/background-position */
     bannerPosition: {
         type: StringConstructor;

package/dist/components/JoyDialogTrigger/VJoyDialogTrigger.vue.d.ts

@@ -31,6 +31,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
             readonly cancelText?: string | undefined;
             readonly confirmText?: string | undefined;
             readonly bannerSrc?: string | undefined;
+            readonly bannerSrcAlt?: string | undefined;
             readonly bannerPosition?: string | undefined;
             readonly "onDialog:open"?: (() => any) | undefined;
             readonly "onDialog:after-open"?: (() => any) | undefined;
@@ -106,6 +107,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
             bannerSrc: {
                 type: StringConstructor;
             };
+            bannerSrcAlt: {
+                type: StringConstructor;
+            };
             bannerPosition: {
                 type: StringConstructor;
             };
@@ -126,7 +130,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
                 fireHideEvent?: boolean | undefined;
             } | undefined) => Promise<void>;
             isOpen: import("vue").Ref<boolean, boolean>;
-            show: () => Promise<void>;
+            overlayId: import("vue").ComputedRef<string>;
+            show: (options?: {
+                restoreFocusTo?: HTMLElement | undefined;
+            } | undefined) => Promise<void>;
         }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
             "dialog:open": () => any;
             "dialog:after-open": () => any;
@@ -231,6 +238,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         bannerSrc: {
             type: StringConstructor;
         };
+        bannerSrcAlt: {
+            type: StringConstructor;
+        };
         bannerPosition: {
             type: StringConstructor;
         };
@@ -245,13 +255,16 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         "onDialog:after-hide"?: (() => any) | undefined;
         "onDialog:before-unmount"?: (() => any) | undefined;
         "onDialog:confirm"?: (() => any) | undefined;
-    }>, "isOpen" | "hide" | "show" | "hasFooterSlots" | ("size" | "closeLabel" | "open" | "preventBodyScroll" | "teleport" | "disableTeleport" | "demoMode" | "patternConfirm" | "patternBrand" | "buttonSize" | "bannerHeight")> & import("vue").ShallowUnwrapRef<{
+    }>, "isOpen" | "hide" | "show" | "hasFooterSlots" | "overlayId" | ("size" | "closeLabel" | "open" | "preventBodyScroll" | "teleport" | "disableTeleport" | "demoMode" | "patternConfirm" | "patternBrand" | "buttonSize" | "bannerHeight")> & import("vue").ShallowUnwrapRef<{
         hasFooterSlots: import("vue").ComputedRef<boolean>;
         hide: (options?: {
             fireHideEvent?: boolean | undefined;
         } | undefined) => Promise<void>;
         isOpen: import("vue").Ref<boolean, boolean>;
-        show: () => Promise<void>;
+        overlayId: import("vue").ComputedRef<string>;
+        show: (options?: {
+            restoreFocusTo?: HTMLElement | undefined;
+        } | undefined) => Promise<void>;
     }> & {} & import("vue").ComponentCustomProperties & {} & {
         $slots: Readonly<{
             'dialog-preheader': () => any;
@@ -306,6 +319,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
             readonly cancelText?: string | undefined;
             readonly confirmText?: string | undefined;
             readonly bannerSrc?: string | undefined;
+            readonly bannerSrcAlt?: string | undefined;
             readonly bannerPosition?: string | undefined;
             readonly "onDialog:open"?: (() => any) | undefined;
             readonly "onDialog:after-open"?: (() => any) | undefined;
@@ -381,6 +395,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
             bannerSrc: {
                 type: StringConstructor;
             };
+            bannerSrcAlt: {
+                type: StringConstructor;
+            };
             bannerPosition: {
                 type: StringConstructor;
             };
@@ -401,7 +418,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
                 fireHideEvent?: boolean | undefined;
             } | undefined) => Promise<void>;
             isOpen: import("vue").Ref<boolean, boolean>;
-            show: () => Promise<void>;
+            overlayId: import("vue").ComputedRef<string>;
+            show: (options?: {
+                restoreFocusTo?: HTMLElement | undefined;
+            } | undefined) => Promise<void>;
         }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
             "dialog:open": () => any;
             "dialog:after-open": () => any;
@@ -506,6 +526,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         bannerSrc: {
             type: StringConstructor;
         };
+        bannerSrcAlt: {
+            type: StringConstructor;
+        };
         bannerPosition: {
             type: StringConstructor;
         };
@@ -520,13 +543,16 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         "onDialog:after-hide"?: (() => any) | undefined;
         "onDialog:before-unmount"?: (() => any) | undefined;
         "onDialog:confirm"?: (() => any) | undefined;
-    }>, "isOpen" | "hide" | "show" | "hasFooterSlots" | ("size" | "closeLabel" | "open" | "preventBodyScroll" | "teleport" | "disableTeleport" | "demoMode" | "patternConfirm" | "patternBrand" | "buttonSize" | "bannerHeight")> & import("vue").ShallowUnwrapRef<{
+    }>, "isOpen" | "hide" | "show" | "hasFooterSlots" | "overlayId" | ("size" | "closeLabel" | "open" | "preventBodyScroll" | "teleport" | "disableTeleport" | "demoMode" | "patternConfirm" | "patternBrand" | "buttonSize" | "bannerHeight")> & import("vue").ShallowUnwrapRef<{
         hasFooterSlots: import("vue").ComputedRef<boolean>;
         hide: (options?: {
             fireHideEvent?: boolean | undefined;
         } | undefined) => Promise<void>;
         isOpen: import("vue").Ref<boolean, boolean>;
-        show: () => Promise<void>;
+        overlayId: import("vue").ComputedRef<string>;
+        show: (options?: {
+            restoreFocusTo?: HTMLElement | undefined;
+        } | undefined) => Promise<void>;
     }> & {} & import("vue").ComponentCustomProperties & {} & {
         $slots: Readonly<{
             'dialog-preheader': () => any;

package/dist/components/JoyDrawer/VJoyDrawer.vue.d.ts

@@ -7,7 +7,9 @@ declare function hide(options?: {
 /**
  * @returns {Promise<void>} -
  */
-declare function show(): Promise<void>;
+declare function show(options?: {
+    restoreFocusTo?: HTMLElement;
+}): Promise<void>;
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<import("vue").ExtractPropTypes<{
     id: {
         type: StringConstructor;
@@ -72,6 +74,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
     hasFooterSlots: import("vue").ComputedRef<boolean>;
     hide: typeof hide;
     isOpen: import("vue").Ref<boolean, boolean>;
+    overlayId: import("vue").ComputedRef<string>;
     show: typeof show;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
     "drawer:open": () => any;

package/dist/components/JoyDrawerTrigger/VJoyDrawerTrigger.vue.d.ts

@@ -110,7 +110,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
                 fireHideEvent?: boolean | undefined;
             } | undefined) => Promise<void>;
             isOpen: import("vue").Ref<boolean, boolean>;
-            show: () => Promise<void>;
+            overlayId: import("vue").ComputedRef<string>;
+            show: (options?: {
+                restoreFocusTo?: HTMLElement | undefined;
+            } | undefined) => Promise<void>;
         }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
             "drawer:open": () => any;
             "drawer:after-open": () => any;
@@ -214,13 +217,16 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         "onDrawer:after-hide"?: (() => any) | undefined;
         "onDrawer:before-unmount"?: (() => any) | undefined;
         "onDrawer:confirm"?: (() => any) | undefined;
-    }>, "isOpen" | "hide" | "show" | "hasFooterSlots" | ("size" | "closeLabel" | "open" | "preventBodyScroll" | "teleport" | "disableTeleport" | "demoMode" | "buttonSize" | "elevated")> & import("vue").ShallowUnwrapRef<{
+    }>, "isOpen" | "hide" | "show" | "hasFooterSlots" | "overlayId" | ("size" | "closeLabel" | "open" | "preventBodyScroll" | "teleport" | "disableTeleport" | "demoMode" | "buttonSize" | "elevated")> & import("vue").ShallowUnwrapRef<{
         hasFooterSlots: import("vue").ComputedRef<boolean>;
         hide: (options?: {
             fireHideEvent?: boolean | undefined;
         } | undefined) => Promise<void>;
         isOpen: import("vue").Ref<boolean, boolean>;
-        show: () => Promise<void>;
+        overlayId: import("vue").ComputedRef<string>;
+        show: (options?: {
+            restoreFocusTo?: HTMLElement | undefined;
+        } | undefined) => Promise<void>;
     }> & {} & import("vue").ComponentCustomProperties & {} & {
         $slots: Readonly<{
             'drawer-preheader': () => any;
@@ -352,7 +358,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
                 fireHideEvent?: boolean | undefined;
             } | undefined) => Promise<void>;
             isOpen: import("vue").Ref<boolean, boolean>;
-            show: () => Promise<void>;
+            overlayId: import("vue").ComputedRef<string>;
+            show: (options?: {
+                restoreFocusTo?: HTMLElement | undefined;
+            } | undefined) => Promise<void>;
         }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
             "drawer:open": () => any;
             "drawer:after-open": () => any;
@@ -456,13 +465,16 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         "onDrawer:after-hide"?: (() => any) | undefined;
         "onDrawer:before-unmount"?: (() => any) | undefined;
         "onDrawer:confirm"?: (() => any) | undefined;
-    }>, "isOpen" | "hide" | "show" | "hasFooterSlots" | ("size" | "closeLabel" | "open" | "preventBodyScroll" | "teleport" | "disableTeleport" | "demoMode" | "buttonSize" | "elevated")> & import("vue").ShallowUnwrapRef<{
+    }>, "isOpen" | "hide" | "show" | "hasFooterSlots" | "overlayId" | ("size" | "closeLabel" | "open" | "preventBodyScroll" | "teleport" | "disableTeleport" | "demoMode" | "buttonSize" | "elevated")> & import("vue").ShallowUnwrapRef<{
         hasFooterSlots: import("vue").ComputedRef<boolean>;
         hide: (options?: {
             fireHideEvent?: boolean | undefined;
         } | undefined) => Promise<void>;
         isOpen: import("vue").Ref<boolean, boolean>;
-        show: () => Promise<void>;
+        overlayId: import("vue").ComputedRef<string>;
+        show: (options?: {
+            restoreFocusTo?: HTMLElement | undefined;
+        } | undefined) => Promise<void>;
     }> & {} & import("vue").ComponentCustomProperties & {} & {
         $slots: Readonly<{
             'drawer-preheader': () => any;

package/dist/components/JoyIndicator/VJoyIndicator.vue.d.ts

@@ -1,5 +1,4 @@
 import { PropType } from 'vue';
-import { TJoyIndicatorsVariants } from '../JoyIndicators/JoyIndicators.types';
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
     /** Value is used for the parent v-model. Mandatory */
     value: {
@@ -12,7 +11,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         default: boolean;
     };
     variant: {
-        type: PropType<TJoyIndicatorsVariants>;
+        type: PropType<"default">;
         default: string;
     };
     /** Indicators are text-less buttons by design. To make them more accessible, you can pass them an aria-label that will describe more their action. */
@@ -31,7 +30,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         default: boolean;
     };
     variant: {
-        type: PropType<TJoyIndicatorsVariants>;
+        type: PropType<"default">;
         default: string;
     };
     /** Indicators are text-less buttons by design. To make them more accessible, you can pass them an aria-label that will describe more their action. */
@@ -40,6 +39,6 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     };
 }>> & Readonly<{}>, {
     selected: boolean;
-    variant: TJoyIndicatorsVariants;
+    variant: "default";
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 export default _default;

package/dist/components/JoyIndicators/JoyIndicators.types.d.ts

@@ -1 +1 @@
-export type TJoyIndicatorsVariants = 'default' | 'light';
+export type TJoyIndicatorsVariants = 'default';

package/dist/components/JoyIndicators/VJoyIndicators.vue.d.ts

@@ -1,10 +1,9 @@
 import { PropType } from 'vue';
 import VJoyIndicator from '../JoyIndicator/VJoyIndicator.vue';
-import { TJoyIndicatorsVariants } from './JoyIndicators.types';
 declare function isSelected(indicator: typeof VJoyIndicator): boolean;
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<import("vue").ExtractPropTypes<{
     variant: {
-        type: PropType<TJoyIndicatorsVariants>;
+        type: PropType<"default">;
     };
     /** Use the component with a v-model to easily handle selected items */
     modelValue: {
@@ -21,7 +20,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
             default: boolean;
         };
         variant: {
-            type: PropType<TJoyIndicatorsVariants>;
+            type: PropType<"default">;
             default: string;
         };
         ariaLabel: {
@@ -37,7 +36,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
             default: boolean;
         };
         variant: {
-            type: PropType<TJoyIndicatorsVariants>;
+            type: PropType<"default">;
             default: string;
         };
         ariaLabel: {
@@ -45,14 +44,14 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
         };
     }>> & Readonly<{}>, {
         selected: boolean;
-        variant: TJoyIndicatorsVariants;
+        variant: "default";
     }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>[]>;
     isSelected: typeof isSelected;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: string | number) => any;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     variant: {
-        type: PropType<TJoyIndicatorsVariants>;
+        type: PropType<"default">;
     };
     /** Use the component with a v-model to easily handle selected items */
     modelValue: {

package/dist/composables/index.d.ts

@@ -2,3 +2,4 @@ import { Ref } from 'vue';
 export declare function useAutoFocus(element: Ref, autofocus: boolean): void;
 export * from './events';
 export * from './helpers';
+export * from './overlay-a11y';

package/dist/composables/overlay-a11y.d.ts

@@ -0,0 +1,21 @@
+import { type MaybeRefOrGetter, type Ref } from 'vue';
+export declare function getFocusableElements(root: HTMLElement): HTMLElement[];
+export declare function trapFocus(event: KeyboardEvent, root: HTMLElement): void;
+export interface OverlayA11yOptions {
+    rootRef: Ref<HTMLElement | undefined>;
+    isOpen: Ref<boolean>;
+    /** When false, skip focus trap and inert. Initial focus, restore and Escape still run. */
+    modal?: MaybeRefOrGetter<boolean>;
+    closeOnEscape?: MaybeRefOrGetter<boolean>;
+    onEscape: () => void;
+    /** Skip all a11y behavior (Storybook `demoMode`). */
+    enabled?: MaybeRefOrGetter<boolean>;
+    /** Used to find the trigger again if the original node was remounted. */
+    overlayId?: MaybeRefOrGetter<string | undefined>;
+}
+export declare function useOverlayA11y(options: OverlayA11yOptions): {
+    setRestoreFocus: (element?: HTMLElement | null) => void;
+};
+/** Test-only helper to avoid stack leakage between specs. */
+export declare function resetOverlayA11yStack(): void;
+export declare function getOverlayA11yStackSize(): number;