Notificación ​

Muestra un mensaje de notificación global en una esquina de la página.

Uso básico ​

Element Plus ha registrado el método$notify y recibe un objeto como parámetro. En el caso más sencillo, puede establecer el campo de title y el campo de message para el título y el cuerpo de la notificación. De forma predeterminada, la notificación se cierra automáticamente después de 4500ms, pero configurando duration se puede controlar su duración. Específicamente, si está configurado en 0, no se cerrará automáticamente. Tenga en cuenta que duration recibe un Number en milisegundos.

Tipos de notificaciones ​

We provide five types: primary, success, warning, info and error.

Element Plus provides five notification types: primary, success, warning, info and error. Se definen por el campo type y se ignorarán otros valores. También se han registrado métodos para estos tipos que se pueden invocar directamente como en el ejemplo open3 y open4 sin pasar un campo type. primary has been added in 2.9.11.

Posición personalizada ​

La notificación puede surgir de cualquier rincón que uno desee.

El atributo position define desde qué esquina se desliza la notificación. Puede ser top-right, top-left, bottom-right o bottom-left. Predeterminado: top-right.

Con desplazamiento ​

Personalice el desplazamiento de notificación desde el borde de la pantalla.

Configure el atributo offset para personalizar el desplazamiento de la notificación desde el borde de la pantalla. Tenga en cuenta que cada instancia de la notificación del mismo momento debe tener el mismo desplazamiento.

Usando cadenas HTML ​

message soporta cadenas HTML.

Establezca el valor de dangerouslyUseHTMLString a true y el message será tratado como una cadena HTML.

WARNING

Aunque la propiedad message soporta cadenas HTML, realizar arbitrariamente render dinámico de HTML en nuestro sitio web puede ser muy peligroso, ya que puede conducir fácilmente a ataques XSS. Entonces cuando dangerouslyUseHTMLString esta activada, asegúrese que el contenido de message sea de confianza, y nunca asignar message a contenido generado por el usuario.

Message using functions 2.9.0 ​

message can be VNode.

After 2.9.0, message supports a function whose return value is a VNode.

With progress bar 2.14.4 ​

Display a progress bar indicating the remaining time before the notification auto-closes.

Set progress to true to enable the progress bar. The progress bar will show a countdown matching the duration. Pass an object to progress to customize it with the options of Progress, e.g. color, which overrides the type-based status color. When pauseOnHover is true (default), hovering over the notification will pause both the timer and the progress bar.

Ocultar boton de cerrar ​

Es posible ocultar el botón de cerrar

Configure el atributo showClose como false para que el usuario no pueda cerrar la notificación.

Métodos Globales ​

Element Plus ha añadido un método global $notify para app.config.globalProperties. Así que en una instancia de vue se puede llamar Notification como lo hacemos en esta página.

Importación local ​

javascript
import { ElNotification } from 'element-plus'
import { CloseBold } from '@element-plus/icons-vue'

ElNotification({
  title: 'Title',
  message: 'This is a message',
  closeIcon: CloseBold,
})

En este caso, debe llamar a ElNotification(options). También se han registrado métodos para diferentes tipos, e.j. ElNotification.success(options). Puede llamar al método ElNotification.closeAll() para cerrar manualmente todas las instancias. In 2.10.5 you can manually update the offsets of all instances in a specific direction by calling ElNotification.updateOffsets(position).

Herencia de contexto de aplicación > 2.0.4 ​

Ahora la notificación acepta un context como segundo parámetro del constructor de mensajes que le permite inyectar el contexto de la aplicación actual a la notificación, lo que le permite heredar todas las propiedades de la aplicación.

Puede usarlo así:

TIP

Si has registrado globalmente el componente ElNotification automáticamente heredará el contexto de la aplicación.

ts
import { getCurrentInstance } from 'vue'
import { ElNotification } from 'element-plus'

// in your setup method
const { appContext } = getCurrentInstance()!
ElNotification({}, appContext)

API ​

Opciones ​

NombreDescripciónTipoPor defecto
titletitlestring''
messagetexto explicativostring / VNode / Function''
dangerouslyUseHTMLStringsi message es tratado como una cadena HTMLbooleanfalse
typetipo de notificaciónenum''
iconcomponente de icono personalizado. Será anulado por typestring / Component—
customClassnombre de clase personalizado para la notificaciónstring''
durationduración antes de cerrar. Si no se quiere que se cierre automáticamente, este valor debe estar a 0number4500
positionposición personalizadaenumtop-right
showClosesi se muestra el botón de cerrarbooleantrue
onClosefunción que se ejecuta cuando la notificación se cierraFunction—
onClickfunción que se ejecuta cuando se hace clic en la notificaciónFunction—
offsetdesplazamiento desde el borde superior de la pantalla. Cada instancia de notificación del mismo momento debe tener siempre el mismo desplazamientonumber0
appendToestablecer el elemento raíz para la notificación, por defecto document.bodyCSSSelector / HTMLElement—
zIndexzIndex inicialnumber0
closeIcon 2.9.8custom close iconstring / ComponentClose
progress 2.14.4progress bar indicating auto-close countdown. Set true to show a default bar, or pass an object with Progress options to customize it (percentage, type, duration, indeterminate and width are excluded)boolean / objectfalse
pauseOnHover 2.14.4whether to pause the timer when hovering over the notificationbooleantrue

Método ​

Notification y this.$notify devuelven la instancia de la notificación actual. Para cerrar manualmente la instancia, se puede llamar a close para ello.

NombreDescripciónTipo
closecierra la notificaciónFunction

Fuente ​

Componentes • Style • Documentación

Contribuidores ​