Nextjs Toast Notify es un paquete npm imprescindible para agregar notificaciones emergentes (toasts) a tus aplicaciones web con Next.js. Ideal para proporcionar retroalimentación visual clara y efectiva sin interrumpir la experiencia del usuario, este paquete te permite mostrar mensajes de alerta, éxito, error y mucho más de manera personalizable y elegante. Con una configuración intuitiva y opciones flexibles, Nextjs Toast Notify te ofrece la herramienta perfecta para mantener a tus usuarios informados y mejorar la interacción con tu aplicación.
Este paquete fue creado para simplificar la implementación de notificaciones en aplicaciones web, permitiendo a los desarrolladores agregar mensajes informativos, de éxito, advertencia o error de forma rápida y sencilla. Nextjs Toast Notify es altamente personalizable y compatible con diferentes posiciones en la pantalla, así como con varios efectos de animación para mejorar la experiencia del usuario.
Este paquete responde a la necesidad de mejorar la manera en que los desarrolladores muestran mensajes de notificación al usuario en aplicaciones web, sin interrumpir la interacción actual. En muchas aplicaciones web, es crucial tener una forma efectiva de informar al usuario sobre eventos importantes, resultados de acciones o errores. Nextjs Toast Notify proporcionan una manera elegante y no invasiva de cumplir con esta función.
Puedes instalar el paquete usando npm:
$ npm install nextjs-toast-notify --save
$ yarn add nextjs-toast-notify
import { toast } from "nextjs-toast-notify";
import "nextjs-toast-notify/dist/nextjs-toast-notify.css";
function App() {
const handleShowToastCenter = () => {
toast.success("¡La operación se realizó con éxito!", {
duration: 4000,
progress: true,
position: "bottom-center",
transition: "bounceIn",
icon: '<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-apple"><path d="M12 20.94c1.5 0 2.75 1.06 4 1.06 3 0 6-8 6-12.22A4.91 4.91 0 0 0 17 5c-2.22 0-4 1.44-5 2-1-.56-2.78-2-5-2a4.9 4.9 0 0 0-5 4.78C2 14 5 22 8 22c1.25 0 2.5-1.06 4-1.06Z"/><path d="M10 2c1 .5 2 2 2 5"/></svg>',
sonido: true,
});
};
return <button onClick={handleShowToastCenter}>Top center</button>;
}
export default App;
Para mostrar notificaciones de un tipo específico, solo necesitas especificar el tipo de toast. A continuación se describen los tipos de toasts disponibles y cómo configurarlos:
toast.success
: Muestra un toast de éxito.toast.error
: Muestra un toast de error.toast.warning
: Muestra un toast de advertencia.toast.info
: Muestra un toast de información.
import { toast } from "nextjs-toast-notify";
import "nextjs-toast-notify/dist/nextjs-toast-notify.css";
function App() {
const handleShowSuccessToast = () => {
toast.success("¡La operación se realizó con éxito!", {});
};
return <button onClick={handleShowSuccessToast}>Toast Success</button>;
}
export default App;
Para mostrar notificaciones en diferentes posiciones de la pantalla, solo necesitas especificar la opción position
con uno de los siguientes valores:
top-left
: Esquina superior izquierdatop-center
: Centro superiortop-right
: Esquina superior derechabottom-left
: Esquina inferior izquierdabottom-center
: Centro inferiorbottom-right
: Esquina inferior derecha
Aquí tienes un ejemplo de cómo configurarlo:
toast.success("¡Operación exitosa!", {
position: "top-right", // 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right'
});
También puedes incluir Nextjs Toast Notify
directamente en tu proyecto utilizando un enlace CDN. Sigue estos pasos:
<!DOCTYPE html>
<html lang="es">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Nextjs Toast Notify con CDN</title>
<!-- Incluir el CSS del paquete -->
<link
rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/[email protected]/dist/nextjs-toast-notify.css"
/>
</head>
<body>
<button id="show-toast">Show Toast</button>
<script type="module">
import { toast } from "https://unpkg.com/[email protected]/dist/index.js";
document.getElementById("show-toast").addEventListener("click", () => {
toast.success("Hola a todos los Devs!", {
duration: 3000, // Duración de la notificación en ms
position: "top-right", // Posición de la notificación
transition: "bounceIn", // Tipo de transición para la entrada
sonido: true, // Reproducir sonido
});
});
</script>
</body>
</html>
- Fácil Integración: Simple de agregar y utilizar en cualquier proyecto web.
- Altamente Configurable: Personaliza la duración, la posición, el progreso y el tipo de notificación.
- Integración rápida: Instalación simple a través de npm o yarn, listo para usar en minutos.
- Efectos de Animación: Soporta diferentes efectos de animación para las notificaciones de entrada y salida.
- Control del Progreso: Incluye una barra de progreso opcional para mostrar la duración restante de la notificación.
- Posiciones de Notificación: Soporta múltiples posiciones en la pantalla:
top-left
,top-center
,top-right
,bottom-left
,bottom-center
,bottom-right
. - Tipos de Notificación: Cuatro tipos de notificación predefinidos:
success
,error
,warning
,info
. - Animaciones: Soporte para animaciones de entrada y salida configurables (
fadeIn
,bounceIn
,bottomToTopBounce
). - Barra de Progreso: Opcional para mostrar el progreso de la notificación.
- Cierre Manual: Permite al usuario cerrar las notificaciones mediante un botón de cierre.
- Configuración por Defecto: Las animaciones y el comportamiento de la notificación se pueden personalizar a través de las opciones de configuración.
- Actualizaciones regulares: Mantenido activamente con mejoras y actualizaciones periódicas.
- Licencia abierta: Publicado bajo licencia MIT, permitiendo su uso en proyectos comerciales y personales sin restricciones.
- Documentación clara y detallada: Incluye ejemplos prácticos y documentación completa para facilitar la implementación y configuración.
La API de Nextjs Toast Notify te permite mostrar notificaciones emergentes con una amplia gama de configuraciones. A continuación, se detalla cómo utilizar los métodos disponibles y qué opciones puedes configurar.
Nextjs Toast Notify expone métodos estáticos para los diferentes tipos de notificaciones:
-
toast.success(message: string, options?: ToastOptions): void
Muestra una notificación de éxito. -
toast.error(message: string, options?: ToastOptions): void
Muestra una notificación de error. -
toast.warning(message: string, options?: ToastOptions): void
Muestra una notificación de advertencia. -
toast.info(message: string, options?: ToastOptions): void
Muestra una notificación informativa.
Las opciones para personalizar las notificaciones se pueden pasar como el segundo parámetro a cada uno de los métodos anteriores. Las opciones disponibles son:
-
duration
:- Tipo:
number
- Descripción: Define la duración de la notificación en milisegundos.
- Valor por defecto:
5000
- Tipo:
-
progress
:- Tipo:
boolean
- Descripción: Si se debe mostrar una barra de progreso para la notificación.
- Valor por defecto:
true
- Tipo:
-
position
:- Tipo:
'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right'
- Descripción: La posición de la notificación en la pantalla.
- Valor por defecto:
'top-right'
- Tipo:
-
transition
:- Tipo:
'fadeIn' | 'bounceIn' | 'bottomToTopBounce'
- Descripción: El efecto de animación de entrada o salida para la notificación.
- Valor por defecto:
'fadeIn'
- Tipo:
-
icon
:- Tipo:
string
- Descripción: Icono personalizado para la notificación (opcional). Si no se proporciona, se usa un ícono predeterminado basado en el tipo de notificación.
- Tipo:
-
sonido
:- Tipo:
boolean
- Descripción: Reproduce un sonido cuando se muestra la notificación.
- Valor por defecto:
false
- Tipo:
Si encuentras algún problema o tienes una idea para mejorar el paquete, por favor abre un issue o envía un pull request en GitHub: https://github.com/urian121/nextjs-toast-notify
© 2024 Urian Viera. Todos los derechos reservados.
Licensed under MIT
¡Gracias a todos los Devs 👨💻 que han utilizado y contribuido al desarrollo de Nextjs Toast Notify! Su apoyo y retroalimentación son fundamentales para mejorar continuamente este paquete.