customizable-toast-notification 3.18.2 → 3.20.0

package/dist/index.d.ts

@@ -58,9 +58,12 @@ type ToastGlobalConfig$1 = {
     swipeToDismiss: boolean;
     sound: boolean;
     soundPreset?: "modern" | "retro" | "futuristic" | "subtle" | "bell" | string;
+    icon?: boolean;
     pauseOnHover?: boolean;
     syncTabs: boolean;
     aiPrioritization: boolean;
+    shadowDom?: boolean;
+    trapFocus?: boolean;
     debug?: boolean;
     priorityScorer?: ((context: {
         type: string;
@@ -73,6 +76,60 @@ type ToastGlobalConfig$1 = {
     onMetrics?: ((metrics: ToastMetrics$1) => void) | null;
 };
 
+/**
+ * Returns a read-only snapshot copy of the notification history ring buffer.
+ * @returns {ToastHistoryEntry[]}
+ */
+declare function getToastHistory(): ToastHistoryEntry$1[];
+/**
+ * Clears all entries from the notification history ring buffer.
+ */
+declare function clearToastHistory(): void;
+/**
+ * Sets the maximum capacity of the history ring buffer.
+ * @param {number} capacity - Maximum number of items to retain (minimum 1)
+ */
+declare function setHistoryCapacity(capacity: number): void;
+/**
+ * Resets the history buffer back to empty and restores default capacity.
+ */
+declare function resetToastHistory(): void;
+type ToastType$1 = "info" | "success" | "error" | "warning";
+type ToastHistoryEntry$1 = {
+    /**
+     * - Unique toast key or identifier
+     */
+    id: string;
+    /**
+     * - Notification text message
+     */
+    message: string;
+    /**
+     * - Notification status type
+     */
+    type: ToastType$1;
+    /**
+     * - Toast placement coordinates
+     */
+    position: string;
+    /**
+     * - Unix timestamp (ms) when created
+     */
+    timestamp: number;
+    /**
+     * - Unix timestamp (ms) when dismissed
+     */
+    dismissedAt?: number;
+    /**
+     * - Current lifecycle status
+     */
+    status: "active" | "dismissed" | "dropped";
+    /**
+     * - Snapshot of configured options
+     */
+    options?: Record<string, unknown>;
+};
+
 /**
  * Returns a real-time snapshot of toast manager telemetry metrics.
  * @returns {import('../utils/config.js').ToastMetrics}
@@ -559,6 +616,63 @@ type SpringConfig$1 = {
 };
 type SpringPreset$1 = "default" | "gentle" | "wobbly" | "stiff" | "bouncy" | string;
 
+/**
+ * Sets the active global locale for toast notifications.
+ * @param {string} locale - Locale code (e.g. 'en', 'hi', 'es', 'fr', 'de', 'ar', 'ja')
+ * @returns {string} The active locale code
+ */
+declare function setLocale(locale: string): string;
+/**
+ * Returns the currently active global locale code.
+ * @returns {string} Current locale code
+ */
+declare function getLocale(): string;
+/**
+ * Returns a list of all currently supported locale codes.
+ * @returns {string[]} Array of locale codes
+ */
+declare function getAvailableLocales(): string[];
+/**
+ * Registers or overrides localized messages for a given locale code.
+ * @param {string} locale - Locale code (e.g. 'it', 'pt', 'zh')
+ * @param {LocaleMessages} messages - Dictionary of localized messages
+ */
+declare function registerLocale(locale: string, messages: LocaleMessages): void;
+/**
+ * Resets the active locale back to 'en' and clears any registered custom locales.
+ */
+declare function resetLocale(): void;
+type LocaleMessages = {
+    /**
+     * - Default success message
+     */
+    success?: string;
+    /**
+     * - Default error message
+     */
+    error?: string;
+    /**
+     * - Default warning message
+     */
+    warning?: string;
+    /**
+     * - Default information message
+     */
+    info?: string;
+    /**
+     * - Default loading message
+     */
+    loading?: string;
+    /**
+     * - Default Undo action label
+     */
+    undo?: string;
+    /**
+     * - Default Close button aria-label
+     */
+    close?: string;
+};
+
 type SoundPreset = "modern" | "retro" | "futuristic" | "subtle" | "bell" | string;
 type ToastType = "info" | "success" | "error" | "warning";
 type ToastPosition = "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center" | "left-center" | "right-center" | "top-full-width" | "bottom-full-width" | "center";
@@ -659,11 +773,63 @@ type ToastOptions = {
     soundPreset?: SoundPreset;
     icon?: boolean | string | HTMLElement | ((options: ToastOptions) => boolean | string | HTMLElement | null | undefined);
     swipeToDismiss?: boolean;
-    progress?: number | "indeterminate";
+    progress?: number | string | "indeterminate";
+    progressNormalized?: boolean;
     syncTabs?: boolean;
+    syncDismiss?: boolean;
     aiPrioritization?: boolean;
     priority?: number;
     usePool?: boolean;
+    /**
+     * - Optional thread/tag identifier for replacement/updating
+     */
+    tag?: string;
+    /**
+     * - Optional group identifier for grouping related toasts
+     */
+    groupId?: string;
+    /**
+     * - Whether to trap keyboard Tab focus within the toast
+     */
+    trapFocus?: boolean;
+    /**
+     * - Whether to isolate the container in an attached Shadow DOM root
+     */
+    shadowDom?: boolean;
+};
+type ToastHistoryEntry = {
+    /**
+     * - Unique toast key or identifier
+     */
+    id: string;
+    /**
+     * - Notification text message
+     */
+    message: string;
+    /**
+     * - Notification status type
+     */
+    type: ToastType;
+    /**
+     * - Toast placement coordinates
+     */
+    position: string;
+    /**
+     * - Unix timestamp (ms) when created
+     */
+    timestamp: number;
+    /**
+     * - Unix timestamp (ms) when dismissed
+     */
+    dismissedAt?: number;
+    /**
+     * - Current lifecycle status
+     */
+    status: "active" | "dismissed" | "dropped";
+    /**
+     * - Snapshot of configured options
+     */
+    options?: Record<string, unknown>;
 };
 type ReducedMotionMode = "auto" | "always" | "never";
 type ToastTheme = "light" | "dark" | "high-contrast" | "compact" | "spacious" | "glass";
@@ -705,6 +871,8 @@ type ToastGlobalConfig = {
     soundPreset?: SoundPreset;
     syncTabs?: boolean;
     aiPrioritization?: boolean;
+    shadowDom?: boolean;
+    trapFocus?: boolean;
     debug?: boolean;
     priorityScorer?: ((context: {
         type: string;
@@ -785,6 +953,8 @@ declare namespace createToastWithPriority {
     export { dismissToast as dismiss };
     export { noopAll as dismissAll };
     export { noopAll as clear };
+    export { getToastHistory as getHistory };
+    export { clearToastHistory as clearHistory };
 }
 /**
  * Displays a success toast notification.
@@ -859,5 +1029,5 @@ declare const version: string;
  */
 declare function toastPromise<T>(promiseOrFn: Promise<T> | (() => Promise<T> | T), messages?: ToastPromiseMessages, options?: ToastOptions): Promise<T>;
 
-export { calculateSpringSettlingDuration, calculateToastPriority, calculateVelocity, categorizeToast, clear, createGestureDetector, createToastWithPriority as createToast, custom, createToastWithPriority as default, detectPinch, dismissToast as dismiss, dismissAll, error, generateSpringLinearEasing, generateToastId, getAudioAnalyser, getAudioContext, getConfig, getSoundPresets, getSpringPresets, getSpringTransition, getToastBroadcaster, getToastMetrics, getToastPool, info, isAudioEnabled, isFlick, loading, noopAll as noop, playTone, registerSoundPreset, registerSpringPreset, resetAudioContext, resetConfig, resetContainerRegistry, resetSoundPresets, resetSpringPresets, resetToastBroadcaster, resetToastIdCounter, resetToastManager, resetToastPool, resolveSpringConfig, setAudioEnabled, setConfig, setDefaultColors, setDefaultMessages, shouldReduceMotion, solveSpring, success, toastPromise, updateToastByKey, version, warning };
-export type { CTAOptions, ReducedMotionMode, SoundPreset, SpringConfig, SpringPreset, ToastGlobalConfig, ToastHandle, ToastLoaderOptions, ToastMetrics, ToastMountTarget, ToastOptions, ToastPosition, ToastPromiseMessages, ToastTheme, ToastType, UndoOptions };
+export { calculateSpringSettlingDuration, calculateToastPriority, calculateVelocity, categorizeToast, clear, clearToastHistory, createGestureDetector, createToastWithPriority as createToast, custom, createToastWithPriority as default, detectPinch, dismissToast as dismiss, dismissAll, error, generateSpringLinearEasing, generateToastId, getAudioAnalyser, getAudioContext, getAvailableLocales, getConfig, getLocale, getSoundPresets, getSpringPresets, getSpringTransition, getToastBroadcaster, getToastHistory, getToastMetrics, getToastPool, info, isAudioEnabled, isFlick, loading, noopAll as noop, playTone, registerLocale, registerSoundPreset, registerSpringPreset, resetAudioContext, resetConfig, resetContainerRegistry, resetLocale, resetSoundPresets, resetSpringPresets, resetToastBroadcaster, resetToastHistory, resetToastIdCounter, resetToastManager, resetToastPool, resolveSpringConfig, setAudioEnabled, setConfig, setDefaultColors, setDefaultMessages, setHistoryCapacity, setLocale, shouldReduceMotion, solveSpring, success, toastPromise, updateToastByKey, version, warning };
+export type { CTAOptions, ReducedMotionMode, SoundPreset, SpringConfig, SpringPreset, ToastGlobalConfig, ToastHandle, ToastHistoryEntry, ToastLoaderOptions, ToastMetrics, ToastMountTarget, ToastOptions, ToastPosition, ToastPromiseMessages, ToastTheme, ToastType, UndoOptions };