@kazee-ds/vue 0.4.0 → 0.5.0

package/dist/types/Toast.vue.d.ts

@@ -0,0 +1,35 @@
+import type { ToastEntry, ToastManager, ToastPlacement } from './toast-model.js';
+type __VLS_Props = {
+    entry: ToastEntry;
+    manager?: ToastManager;
+    placement?: ToastPlacement;
+    closeLabel?: string;
+    dir?: 'ltr' | 'rtl';
+    showProgress?: boolean;
+    swipeThreshold?: number;
+};
+type __VLS_Slots = {
+    default?: (props: {
+        entry: ToastEntry;
+        dismiss: () => void;
+    }) => unknown;
+    indicator?: (props: {
+        entry: ToastEntry;
+    }) => unknown;
+};
+declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    dir: "ltr" | "rtl";
+    closeLabel: string;
+    placement: ToastPlacement;
+    manager: ToastManager;
+    showProgress: boolean;
+    swipeThreshold: number;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/types/ToastProvider.vue.d.ts

@@ -0,0 +1,41 @@
+import { type ToastEntry, type ToastManager, type ToastPlacement } from './toast-model.js';
+type __VLS_Props = {
+    manager?: ToastManager;
+    placement?: ToastPlacement;
+    label?: string;
+    closeLabel?: string;
+    hotkey?: string[];
+    dir?: 'ltr' | 'rtl';
+    showProgress?: boolean;
+    swipeThreshold?: number;
+};
+type __VLS_Slots = {
+    default?: (props: {
+        toast: ToastManager;
+    }) => unknown;
+    toast?: (props: {
+        entry: ToastEntry;
+        dismiss: () => void;
+    }) => unknown;
+    indicator?: (props: {
+        entry: ToastEntry;
+    }) => unknown;
+};
+declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    label: string;
+    dir: "ltr" | "rtl";
+    closeLabel: string;
+    placement: ToastPlacement;
+    manager: ToastManager;
+    showProgress: boolean;
+    swipeThreshold: number;
+    hotkey: string[];
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/types/index.d.ts

@@ -34,6 +34,11 @@ export { default as DataTable } from './DataTable.vue.js';
 export type { DataTableColumn, DataTableRow, TableSort } from './data-table-types.js';
 export type { TabItem } from './types.js';
 export { default as Alert } from './Alert.vue.js';
+export { default as ToastProvider } from './ToastProvider.vue.js';
+export { default as Toast } from './Toast.vue.js';
+export { useToast } from './useToast.js';
+export { createToastManager } from './toast-model.js';
+export type { ToastTone, ToastPlacement, ToastCloseReason, ToastAction, ToastOptions, ToastEntry, ToastManagerOptions, ToastPromiseMessages, ToastManager, } from './toast-model.js';
 export { default as Empty } from './Empty.vue.js';
 export { default as Breadcrumb } from './Breadcrumb.vue.js';
 export { default as Sidebar } from './Sidebar.vue.js';

package/dist/types/toast-model.d.ts

@@ -0,0 +1,64 @@
+export type ToastTone = 'neutral' | 'info' | 'success' | 'warning' | 'danger';
+export type ToastPlacement = 'top-start' | 'top-center' | 'top-end' | 'bottom-start' | 'bottom-center' | 'bottom-end';
+export type ToastCloseReason = 'timeout' | 'dismiss' | 'action' | 'cancel' | 'swipe' | 'clear' | 'unmount';
+export interface ToastAction {
+    label: string;
+    altText: string;
+    onAction: () => void;
+    dismiss?: boolean;
+}
+export interface ToastOptions {
+    id?: string;
+    title: string;
+    description?: string;
+    tone?: ToastTone;
+    duration?: number;
+    isLoading?: boolean;
+    action?: ToastAction;
+    cancel?: ToastAction;
+    onClose?: (reason: ToastCloseReason) => void;
+}
+export interface ToastEntry extends Readonly<ToastOptions> {
+    readonly id: string;
+    readonly tone: ToastTone;
+    readonly duration: number;
+    readonly isLoading: boolean;
+    readonly generation: number;
+    readonly state: 'open' | 'closing';
+    readonly createdAt: number;
+    readonly visibleAt: number | null;
+    readonly remaining: number;
+    readonly paused: boolean;
+}
+export interface ToastManagerOptions {
+    maxVisible?: number;
+    maxPending?: number;
+    duration?: number;
+    exitDuration?: number;
+}
+type ToastMessage = string | ToastOptions;
+export interface ToastPromiseMessages<T> {
+    loading: ToastMessage;
+    success: ToastMessage | ((value: T) => ToastMessage);
+    error: ToastMessage | ((error: unknown) => ToastMessage);
+}
+export interface ToastManager {
+    add(options: ToastOptions): string | null;
+    update(id: string, options: Partial<ToastOptions>): boolean;
+    dismiss(id: string, reason?: ToastCloseReason): void;
+    clear(reason?: ToastCloseReason): void;
+    pause(reason: string): void;
+    resume(reason: string): void;
+    attach(): () => void;
+    dispose(): void;
+    subscribe(listener: () => void): () => void;
+    getSnapshot(): readonly ToastEntry[];
+    getServerSnapshot(): readonly ToastEntry[];
+    promise<T>(promise: Promise<T>, messages: ToastPromiseMessages<T>, options?: Partial<ToastOptions>): {
+        id: string | null;
+        promise: Promise<T>;
+    };
+}
+/** Create per application/provider; no browser globals or timers are used until attached. */
+export declare function createToastManager(options?: ToastManagerOptions): ToastManager;
+export {};

package/dist/types/useToast.d.ts

@@ -0,0 +1,5 @@
+import { type InjectionKey } from 'vue';
+import type { ToastManager } from './toast-model.js';
+export declare const toastManagerKey: InjectionKey<ToastManager>;
+/** Access the nearest provider's manager. Create imperative managers per application. */
+export declare function useToast(): ToastManager;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kazee-ds/vue",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "type": "module",
   "exports": {
     ".": {