nextjs-toast-notify
Version:
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
349 lines (260 loc) • 14.1 kB
Markdown
# Nextjs Toast Notify
[](https://www.npmjs.com/package/nextjs-toast-notify)
[](https://github.com/urian121/nextjs-toast-notify)
[](https://www.npmjs.com/package/nextjs-toast-notify)
👉 [Ver Código en GitHub](https://github.com/urian121/nextjs-toast-notify-con-reactjs)
**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?
**Nextjs Toast Notify** 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?
**Nextjs Toast Notify** 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:
### 🔥Cómo Integrar Nextjs Toast Notify en una App ToDo con React.js 🚀
👉 [Ver Código en GitHub](https://github.com/urian121/Create-ToDo-List-App-with-ReactJS)
## Ejemplo Práctico utilizando React.js
```jsx
import { showToast } from "nextjs-toast-notify";
function App() {
const handleShowToast = () => {
showToast.success("¡La operación se realizó con éxito!", {
duration: 5000,
progress: true,
position: "bottom-center",
transition: "bounceIn",
icon: '<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.75" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-check"><path d="M20 6 9 17l-5-5"/></svg>',
sound: true,
});
};
return <button onClick={handleShowToast}>Top center</button>;
}
export default App;
```
### 🔥Integrar Next.js Toast Notify en una aplicación de Next.js 🚀
👉 [Ver Código en GitHub](https://github.com/urian121/sistema-like-dislikes-con-nextjs-y-nextjs-toast-notify)
# Tipos de Notificaciones
**Nextjs Toast Notify** permite mostrar diferentes tipos de notificaciones según el contexto de la aplicación. Para definir el tipo de notificación, solo debes especificarlo al invocar **toast**.
### Tipos de Toast
- **✅`showToast.success`**: Muestra un toast de éxito.
- **❌`showToast.error`**: Muestra un toast de error.
- **⚠️`showToast.warning`**: Muestra un toast de advertencia.
- **⬆️`showToast.info`**: Muestra un toast de información.
### Ejemplos de Uso
```jsx
import { showToast } from "nextjs-toast-notify";
function App() {
const handleShowSuccessToast = () => {
showToast.success("¡Operación exitosa!"); // 'showToast.success' | 'showToast.error' | 'showToast.info' | 'showToast.warning'
};
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:
```jsx
import { showToast } from "nextjs-toast-notify";
function App() {
const handleToastPosition = () => {
showToast.success("¡Operación exitosa!", {
position: "top-right", // 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right'
});
};
return <button onClick={handleToastPosition}>Toast arriba derecha</button>;
}
export default App;
```
## Uso a través de CDN
También puedes incluir `Nextjs Toast Notify` directamente en tu proyecto utilizando un enlace CDN. Sigue estos pasos:
```html
<!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>
</head>
<body>
<button id="show-toast">Mostrar Toast</button>
<script type="module">
import { showToast } from "https://unpkg.com/nextjs-toast-notify@1.36.0/dist/nextjs-toast-notify.js";
document.getElementById("show-toast").addEventListener("click", () => {
showToast.success("Hola a todos los Devs!", {
duration: 5000, // 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: "",
sound: true, // Reproducir sonido
});
});
</script>
</body>
</html>
```
## API de Nextjs Toast Notify
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.
### Opciones de Personalización
Puedes personalizar las notificaciones mediante las opciones que se pasan como el segundo parámetro en cada uno de los métodos. Aquí están las opciones disponibles:
- **`duration`**:
- **Tipo**: `number`
- **Descripción**: Define la duración de la notificación en milisegundos.
- **Valor por defecto**: `8000`
- **Ejemplo**:
```jsx
import { showToast } from "nextjs-toast-notify";
function App() {
const handleShowToast = () => {
showToast.success("¡Toast de con una duración de 5 segundos!", {
duration: 5000, // Duración en milisegundos
});
};
return <button onClick={handleShowToast}>Mostrar Toast</button>;
}
export default App;
```
- **`progress`**:
- **Tipo**: `boolean`
- **Descripción**: Si se debe mostrar una barra de progreso para la notificación.
- **Valor por defecto**: `true`
- **Ejemplo**:
```jsx
import { showToast } from "nextjs-toast-notify";
function App() {
const handleShowToast = () => {
showToast.info("¡Toast de información!", {
progress: false, // Desactiva la barra de progreso
});
};
return <button onClick={handleShowToast}>Mostrar Toast</button>;
}
export default App;
```
- **`position`**:
- **Tipo**: `'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right'`
- **Descripción**: Define la posición de la notificación en la pantalla.
- **Valor por defecto**: `'top-right'`
- **Ejemplo**:
```jsx
import { showToast } from "nextjs-toast-notify";
function App() {
const handleToastPosition = () => {
showToast.success("¡Toast centrada correctamente!", {
position: "top-center", // 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right'
});
};
return <button onClick={handleToastPosition}>Toast centrada</button>;
}
export default App;
```
- **`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'`
- **Ejemplo**:
```jsx
import { showToast } from "nextjs-toast-notify";
function App() {
const handleToastAnimationPopUp = () => {
showToast.error("!Toast con animación popUp!", {
transition: 'popUp'
}); // Animación tipo popUp
};
return <button onClick={handleToastAnimationPopUp}>Toast Rebote</button>;
}
export default App;
```
- **`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.
- **Ejemplo**:
```jsx
function App() {
const handleToastIcon = () => {
showToast.success("¡Toast con ícono!", {
icon: '🎉', // Opcional: puede ser un ícono, emoji o SVG personalizado
});
};
return <button onClick={handleToastIcon}>Toast con ícono</button>;
}
```
- **`sound`**:
- **Tipo**: `boolean`
- **Descripción**: Activa o desactiva un sonido cuando se muestra la notificación.
- **Valor por defecto**: `false`
- **Ejemplo**:
```jsx
import { showToast } from "nextjs-toast-notify";
function App() {
const handleToastSound = () => {
showToast.info("¡Toast con sonido activo!", {
sound: true, // Opcional: habilita el sonido (true o false)
});
};
return <button onClick={handleToastSound}>Toast con sonido</button>;
}
export default App;
```
### Ejemplo Completo
```jsx
import { showToast } from "nextjs-toast-notify";
function App() {
const mostrarNotificacion = () => {
showToast.success("¡Operación exitosa!", {
duration: 4000, // Duración del toast en milisegundos (4 segundos)
position: "top-center",// Posición en pantalla del toast
transition: "bounceIn",// Animación de entrada
icon: "🚀", // Ícono personalizado (puede ser emoji, svg o HTML)
progress: false, // Mostrar o no la barra de progreso
sound: true, // Reproducir sonido al mostrar el toast
});
};
return <button onClick={mostrarNotificacion}>Mostrar Notificación</button>;
}
export default App;
```
La notificación tiene una **duración de 4 segundos**, está **centrada en la parte superior**, con un efecto de **animación de rebote**, un **ícono personalizado**, **sin barra de progreso** y con **sonido activado**.
## 🌟 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.
- **Cierre Automático**: Permite definir la duración de la alerta, tras la cual se cerrará automáticamente.
- **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.
### Ú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
- [Urian Viera](https://github.com/urian123)
- [Portafolio](https://www.urianviera.com)
- [Canal de Youtube](https://www.youtube.com/WebDeveloperUrianViera)
- [¡Donar a través de PayPal!](https://www.paypal.com/donate/?hosted_button_id=4SV78MQJJH3VE)
- [Email](mailto:urian1213viera@gmail.com)
## Copyright
© 2024 Urian Viera. Todos los derechos reservados.
## License
Licensed under MIT
[](https://github.com/urian121/nextjs-toast-notify)
## 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.