nextjs-toast-notify/dist/index.d.ts

Es un paquete npm moderno, intuitivo, flexible, liviano e imprescindible para agregar notificaciones emergentes (toasts) a tus aplicaciones web con Next.js.

/**
 * Opciones para configurar una notificación de toast.
 * Todas las propiedades aparecerán en el autocompletado del IDE.
 */
interface ToastOptions {
    /**
     * Duración en milisegundos que se mostrará la notificación.
     * Si es null, usa el valor por defecto pero no se cierra automáticamente.
     * @default 8000
     * @example 4000
     */
    duration?: number | null;
    /**
     * Muestra una barra de progreso.
     * @default true
     * @example true
     */
    progress?: boolean;
    /**
     * Posición de la notificación en la pantalla.
     * @default "top-right"
     * @example "top-center"
     */
    position?: "top-left" | "top-center" | "top-right" | "bottom-left" | "bottom-center" | "bottom-right";
    /**
     * Tipo de transición para la entrada de la notificación.
     * @default "fadeIn"
     * @example "slideInUp"
     */
    transition?: "fadeIn" | "swingInverted" | "bounceIn" | "popUp" | "topBounce" | "bounceInDown" | "slideInUp";
    /**
     * Icono personalizado para la notificación (HTML string).
     * Si no se proporciona, se usa el icono por defecto del tipo.
     * @example '<svg>...</svg>'
     */
    icon?: string;
    /**
     * Reproduce un sonido cuando se muestra la notificación.
     * @default false
     * @example true
     */
    sound?: boolean;
}

declare const showToast: {
    success: (message: string, options?: ToastOptions) => void;
    error: (message: string, options?: ToastOptions) => void;
    warning: (message: string, options?: ToastOptions) => void;
    info: (message: string, options?: ToastOptions) => void;
};

export { showToast };
export type { ToastOptions };