maz-ui 3.35.2 → 3.36.0

package/modules/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./chunks/index-BvpGBt8_.cjs");exports.AosHandler=e.AosHandler;exports.IdleTimeout=e.IdleTimeout;exports.ScriptLoader=e.ScriptLoader;exports.Swipe=e.Swipe;exports.ToasterHandler=e.ToasterHandler;exports.UserVisibility=e.UserVisibility;exports.WaitHandler=e.WaitHandler;Object.defineProperty(exports,"aosInstance",{enumerable:!0,get:()=>e.instance$1});exports.capitalize=e.capitalize;exports.countryCodeToUnicodeFlag=e.countryCodeToUnicodeFlag;exports.currency=e.currency;exports.date=e.date;exports.debounce=e.debounce;exports.injectStrict=e.injectStrict;exports.installAos=e.plugin$5;exports.installDirectives=e.installDirectives;exports.installFilters=e.installFilters;exports.installToaster=e.installToaster;exports.installWait=e.plugin$4;exports.isClient=e.isClient;exports.mount=e.mount;exports.number=e.number;exports.sleep=e.sleep;exports.throttle=e.throttle;Object.defineProperty(exports,"toastInstance",{enumerable:!0,get:()=>e.toastInstance});exports.truthyFilter=e.truthyFilter;exports.useAos=e.useAos;exports.useBreakpoints=e.useBreakpoints;exports.useIdleTimeout=e.useIdleTimeout;exports.useInstanceUniqId=e.useInstanceUniqId;exports.useReadingTime=e.useReadingTime;exports.useSwipe=e.useSwipe;exports.useThemeHandler=e.useThemeHandler;exports.useTimer=e.useTimer;exports.useToast=e.useToast;exports.useUserVisibility=e.useUserVisibility;exports.useWait=e.useWait;exports.useWindowSize=e.useWindowSize;exports.vClickOutside=e.directive;exports.vClickOutsideInstall=e.plugin;exports.vClosable=e.directive$1;exports.vClosableInstall=e.plugin$3;exports.vFullscreenImg=e.vFullscreenImg;exports.vFullscreenImgInstall=e.vFullscreenImgInstall;exports.vLazyImg=e.vLazyImg;exports.vLazyImgInstall=e.plugin$1;exports.vZoomImg=e.vZoomImg;exports.vZoomImgInstall=e.plugin$2;exports.waitInstance=e.instance;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./chunks/index-CDU35ONK.cjs");exports.AosHandler=e.AosHandler;exports.IdleTimeout=e.IdleTimeout;exports.ScriptLoader=e.ScriptLoader;exports.Swipe=e.Swipe;exports.ToasterHandler=e.ToasterHandler;exports.UserVisibility=e.UserVisibility;exports.WaitHandler=e.WaitHandler;Object.defineProperty(exports,"aosInstance",{enumerable:!0,get:()=>e.instance$1});exports.capitalize=e.capitalize;exports.countryCodeToUnicodeFlag=e.countryCodeToUnicodeFlag;exports.currency=e.currency;exports.date=e.date;exports.debounce=e.debounce;exports.injectStrict=e.injectStrict;exports.installAos=e.plugin$5;exports.installDirectives=e.installDirectives;exports.installFilters=e.installFilters;exports.installToaster=e.installToaster;exports.installWait=e.plugin$4;exports.isClient=e.isClient;exports.mount=e.mount;exports.number=e.number;exports.sleep=e.sleep;exports.throttle=e.throttle;Object.defineProperty(exports,"toastInstance",{enumerable:!0,get:()=>e.toastInstance});exports.truthyFilter=e.truthyFilter;exports.useAos=e.useAos;exports.useBreakpoints=e.useBreakpoints;exports.useIdleTimeout=e.useIdleTimeout;exports.useInstanceUniqId=e.useInstanceUniqId;exports.useReadingTime=e.useReadingTime;exports.useSwipe=e.useSwipe;exports.useThemeHandler=e.useThemeHandler;exports.useTimer=e.useTimer;exports.useToast=e.useToast;exports.useUserVisibility=e.useUserVisibility;exports.useWait=e.useWait;exports.useWindowSize=e.useWindowSize;exports.vClickOutside=e.directive;exports.vClickOutsideInstall=e.plugin;exports.vClosable=e.directive$1;exports.vClosableInstall=e.plugin$3;exports.vFullscreenImg=e.vFullscreenImg;exports.vFullscreenImgInstall=e.vFullscreenImgInstall;exports.vLazyImg=e.vLazyImg;exports.vLazyImgInstall=e.plugin$1;exports.vZoomImg=e.vZoomImg;exports.vZoomImgInstall=e.plugin$2;exports.waitInstance=e.instance;

package/modules/index.mjs

@@ -1,4 +1,4 @@
-import { D as e, I as t, S as l, b as i, T as n, U as o, W as r, F as u, u as c, c as I, w as d, x as m, d as v, i as T, E as g, f as p, r as y, z as b, B as C, a as F, m as S, y as w, s as z, e as H, A as U, t as W, J as h, P as k, M as A, H as L, V as O, R as V, G as f, O as j, L as q, N as x, K as B, Q as D, g as R, p as Z, o as E, q as G, l as J, n as K, v as M, h as N, j as P, k as Q, C as X } from "./chunks/index-Cd939Pzv.mjs";
+import { D as e, I as t, S as l, b as i, T as n, U as o, W as r, F as u, u as c, c as I, w as d, x as m, d as v, i as T, E as g, f as p, r as y, z as b, B as C, a as F, m as S, y as w, s as z, e as H, A as U, t as W, J as h, P as k, M as A, H as L, V as O, R as V, G as f, O as j, L as q, N as x, K as B, Q as D, g as R, p as Z, o as E, q as G, l as J, n as K, v as M, h as N, j as P, k as Q, C as X } from "./chunks/index-DKgMLGti.mjs";
 export {
   e as AosHandler,
   t as IdleTimeout,

package/nuxt/index.json

@@ -4,5 +4,5 @@
   "compatibility": {
     "nuxt": "^3.0.0"
   },
-  "version": "3.35.2"
+  "version": "3.36.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "maz-ui",
-  "version": "3.35.2",
+  "version": "3.36.0",
   "description": "A standalone components library for Vue.Js 3 & Nuxt.Js 3",
   "author": "Louis Mazel <me@loicmazuel.com>",
   "main": "./modules/index.cjs",

package/types/modules/composables/use-timer.d.ts

@@ -1,11 +1,23 @@
 export interface TimerOptions {
-    timeout: number;
+    /**
+     * The time in milliseconds
+     * @default 1000
+     */
+    timeout?: number;
+    /**
+     * The callback to execute when the timer is finished
+     * @default undefined
+     */
     callback?: () => unknown;
+    /**
+     * The interval to update the remaining time
+     * @default 200
+     */
     remainingTimeUpdate?: number;
 }
 export declare const useTimer: ({ timeout, callback, remainingTimeUpdate }: TimerOptions) => {
     remainingTime: import("vue").Ref<number>;
-    start: () => void;
+    start: (timeout?: number) => void;
     pause: () => void;
     resume: () => void;
     stop: () => void;

package/types/modules/helpers/mount-component.d.ts

@@ -1,5 +1,5 @@
 import { type App, type Component } from 'vue';
-export declare function mount(component: Component, options?: {
+export declare function mount<T extends Component>(component: T, options?: {
     props?: Record<string, unknown>;
     children?: unknown;
     app?: App;

package/types/modules/plugins/toaster/MazToast.vue.d.ts

@@ -1,104 +1,68 @@
-import { type PropType } from 'vue';
+import type { LocalToasterOptions } from './toaster-handler';
 import type { ToasterPosition, ToasterAction, ToasterLink } from './types';
-declare const _default: import("vue").DefineComponent<{
-    position: {
-        type: PropType<ToasterPosition>;
-        default: string;
-    };
-    maxToasts: {
-        type: (BooleanConstructor | NumberConstructor)[];
-        default: boolean;
-    };
-    timeout: {
-        type: NumberConstructor;
-        default: number;
-    };
-    queue: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    noPauseOnHover: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    type: {
-        type: PropType<"success" | "info" | "warning" | "danger" | "theme">;
-        default: string;
-    };
-    message: {
-        type: StringConstructor;
-        required: true;
-    };
-    link: {
-        type: PropType<ToasterLink>;
-        default: undefined;
-    };
-    action: {
-        type: PropType<ToasterAction>;
-        default: undefined;
-    };
-    persistent: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+export type Props = {
+    message: string;
+    position?: ToasterPosition;
+    maxToasts?: number | boolean;
+    timeout?: number | boolean;
+    queue?: boolean;
+    noPauseOnHover?: boolean;
+    type?: LocalToasterOptions['type'];
+    link?: ToasterLink;
+    action?: ToasterAction;
+    persistent?: boolean;
+};
+declare function close(): void;
+declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<Props>, {
+    position: string;
+    maxToasts: boolean;
+    timeout: number;
+    type: string;
+    message: undefined;
+    link: undefined;
+    action: undefined;
+}>, {
+    close: typeof close;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     click: (...args: any[]) => void;
     close: (...args: any[]) => void;
     open: (...args: any[]) => void;
-}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
-    position: {
-        type: PropType<ToasterPosition>;
-        default: string;
-    };
-    maxToasts: {
-        type: (BooleanConstructor | NumberConstructor)[];
-        default: boolean;
-    };
-    timeout: {
-        type: NumberConstructor;
-        default: number;
-    };
-    queue: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    noPauseOnHover: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    type: {
-        type: PropType<"success" | "info" | "warning" | "danger" | "theme">;
-        default: string;
-    };
-    message: {
-        type: StringConstructor;
-        required: true;
-    };
-    link: {
-        type: PropType<ToasterLink>;
-        default: undefined;
-    };
-    action: {
-        type: PropType<ToasterAction>;
-        default: undefined;
-    };
-    persistent: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-}>> & {
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<Props>, {
+    position: string;
+    maxToasts: boolean;
+    timeout: number;
+    type: string;
+    message: undefined;
+    link: undefined;
+    action: undefined;
+}>>> & {
     onClose?: ((...args: any[]) => any) | undefined;
     onClick?: ((...args: any[]) => any) | undefined;
     onOpen?: ((...args: any[]) => any) | undefined;
 }, {
     link: ToasterLink;
-    timeout: number;
+    timeout: number | boolean;
     type: "success" | "info" | "warning" | "danger" | "theme";
+    message: string;
     position: ToasterPosition;
-    persistent: boolean;
-    action: ToasterAction;
     maxToasts: number | boolean;
-    queue: boolean;
-    noPauseOnHover: boolean;
+    action: ToasterAction;
 }, {}>;
 export default _default;
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/types/modules/plugins/toaster/toaster-handler.d.ts

@@ -9,9 +9,24 @@ export declare class ToasterHandler {
     constructor(app: App, globalOptions?: ToasterOptions | undefined);
     private show;
     private getLocalOptions;
-    message(message: string, options?: ToasterOptions): void;
-    success(message: string, options?: ToasterOptions): void;
-    error(message: string, options?: ToasterOptions): void;
-    info(message: string, options?: ToasterOptions): void;
-    warning(message: string, options?: ToasterOptions): void;
+    message(message: string, options?: ToasterOptions): {
+        destroy: () => void;
+        close: () => any;
+    };
+    success(message: string, options?: ToasterOptions): {
+        destroy: () => void;
+        close: () => any;
+    };
+    error(message: string, options?: ToasterOptions): {
+        destroy: () => void;
+        close: () => any;
+    };
+    info(message: string, options?: ToasterOptions): {
+        destroy: () => void;
+        close: () => any;
+    };
+    warning(message: string, options?: ToasterOptions): {
+        destroy: () => void;
+        close: () => any;
+    };
 }

package/types/modules/plugins/toaster/types.d.ts

@@ -1,12 +1,5 @@
 export type ToasterPosition = 'top' | 'top-right' | 'top-left' | 'bottom' | 'bottom-right' | 'bottom-left';
 export type ToasterPositions = ToasterPosition;
-export type ToasterOptions = {
-    position?: ToasterPosition;
-    timeout?: number;
-    persistent?: boolean;
-    action?: ToasterAction;
-    link?: ToasterLink;
-};
 export type ToasterLink = {
     href: string;
     text?: string;
@@ -19,3 +12,40 @@ export type ToasterAction = {
     text: string;
     closeToast?: boolean;
 };
+export type ToasterOptions = {
+    /**
+     * The position of the toast on the screen
+     * @default 'bottom-right'
+     */
+    position?: ToasterPosition;
+    /**
+     * The timeout is in ms, it's the time before the toast is automatically closed
+     * if set to `false`, the toast will not be closed automatically
+     * @default 10000
+     */
+    timeout?: number | boolean;
+    /**
+     * If the toast is persistent, it can't be closed by user interaction (only on timeout or programmatically)
+     * @default false
+     */
+    persistent?: boolean;
+    /**
+     * The link will be displayed as a button in the toast
+     * @default undefined
+     */
+    link?: {
+        href: string;
+        text?: string;
+        target?: string;
+        closeToast?: boolean;
+    };
+    /**
+     * The action will be displayed as a button in the toast
+     * @default undefined
+     */
+    action?: {
+        func: (..._arguments: unknown[]) => unknown;
+        text: string;
+        closeToast?: boolean;
+    };
+};