nextjs-toast-notify

v1.27.0

Published

2 months ago

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 most

Downloads

255

Nextjs Toast Notify

demo 👉 Ver Código en GitHub

Nextjs Toast Notify es el paquete npm que transformará cómo manejas las notificaciones en tus aplicaciones web. Diseñado para ofrecer una experiencia de usuario sin interrupciones, Nextjs Toast Notify permite agregar alertas emergentes (toasts) con una estética moderna y personalizable. Nextjs Toast Notify también destaca por su configuración intuitiva y opciones flexibles, que te permiten adaptar las notificaciones a tus necesidades específicas con facilidad.

¿Para Qué Fue Creado?

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.

¿Qué necesidad resuelve?

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.

Instalación

Puedes instalar el paquete usando npm:

$ npm install nextjs-toast-notify --save
$ yarn add nextjs-toast-notify

Casos de uso:

Integrar Next.js Toast Notify en una aplicación ToDo con React.js

demo 👉 Ver Código en GitHub

Ejemplo Práctico utilizando React.js

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-check"><path d="M20 6 9 17l-5-5"/></svg>',
      sonido: true,
    });
  };

  return <button onClick={handleShowToastCenter}>Top center</button>;
}

export default App;

Integrar Next.js Toast Notify en una aplicación de Next.js

demo 👉 Ver Código en GitHub

Tipos de Notificaciones

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:

Tipos de Toast

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.

Ejemplos de Uso

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;

Mostrar Notificaciones en Diferentes Posiciones

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 izquierda
top-center: Centro superior
top-right: Esquina superior derecha
bottom-left: Esquina inferior izquierda
bottom-center: Centro inferior
bottom-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'
});

Uso a través de CDN

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
          icon: "",
          sonido: true, // Reproducir sonido
        });
      });
    </script>
  </body>
</html>

Ventajas y Características Clave

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, swingInverted, popUp, bottomToTopBounce, bounceInDown).
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.

API

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.

Métodos

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.

Opciones

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
progress:
- Tipo: boolean
- Descripción: Si se debe mostrar una barra de progreso para la notificación.
- Valor por defecto: true
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'
transition:
- Tipo: 'fadeIn' | 'bounceIn' | 'swingInverted' | 'popUp' | 'bottomToTopBounce' | 'bounceInDown'
- Descripción: El efecto de animación de entrada o salida para la notificación.
- Valor por defecto: 'fadeIn'
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.
sonido:
- Tipo: boolean
- Descripción: Reproduce un sonido cuando se muestra la notificación.
- Valor por defecto: false

Únete y Contribuye

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

Desarrollado por

Copyright

License

Licensed under MIT

Agradecimientos

¡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.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Nextjs Toast Notify

¿Para Qué Fue Creado?

¿Qué necesidad resuelve?

Instalación

Casos de uso:

Integrar Next.js Toast Notify en una aplicación ToDo con React.js

Ejemplo Práctico utilizando React.js

Integrar Next.js Toast Notify en una aplicación de Next.js

Tipos de Notificaciones

Tipos de Toast

Ejemplos de Uso

Mostrar Notificaciones en Diferentes Posiciones

Uso a través de CDN

Ventajas y Características Clave

API

Métodos

Opciones

Únete y Contribuye

Desarrollado por

Copyright

License

Agradecimientos