Message

Utilizado para mostrar comentarios después de una actividad. La diferencia con el componente Notification es que este último es utilizado para mostrar una notificación pasiva.

Uso básico

Se muestra en la parte superior de la pagina y desaparece después de 3 segundos.

La configuración del componente Message es muy similar al del componente notification, así que parte de las opciones no serán explicadas en detalle aquí. Puedes consultar la tabla de opciones en la parte inferior combinada con la documentación del componente notification para comprenderla. Element Plus ha registrado el método $message para poder invocarlo. Message puede tomar una cadena o un Vnode como parámetro, y lo mostrara como el cuerpo principal.

Tipos

Utilizado para mostrar los comentarios de Éxito, Advertencia, Mensaje y Error de las actividades.

Cuando necesite mas personalización, el componente Message también puede tomar un objeto como parámetro. Por ejemplo, estableciendo el valor de type puede definir diferentes tipos, el predeterminado es info. En tales casos el cuerpo principal se pasa como el valor de message. También, hay registrados métodos para los diferentes tipos, así que, puedes llamarlos sin necesidad de pasar un tipo como open4.

Plain 2.6.3

Set plain to have a plain background.

Cerrable

Un botón para cerrar que puede ser agregado.

Un componente Message predeterminado no se puede cerrar manualmente. Si necesita un componente message que pueda cerrarse, puede establecer el campo showClose. Además, al igual que las notificaciones, message tiene un atributo duration que puede ser controlado. Por defecto la duración es de 3000 ms, y no desaparecerá al llegar a 0.

Texto centrado

Para centrar el texto utilice el atributo center.

Usando cadenas HTML

message soporta cadenas HTML.

Establezca el valor de dangerouslyUseHTMLString a true y 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 está activada, asegúrese que el contenido de message sea de confianza, y nunca asigne a message contenido generado por el usuario.

Agrupando

fusiona mensajes con el mismo contenido.

Asigne true a grouping y el mismo contenido de message será fusionado.

Métodos Globales

Element Plus ha agregado un método global llamado $message para app.config.globalProperties. Así en una instancia de vue puede llamar a Mensaje como lo que hicimos en esta página.

Importación local

ts
import { ElMessage } from 'element-plus'

En este caso debería llamar al método ElMessage(options). También se han registrado métodos para los diferentes tipos, e.g. ElMessage.success(options). Puede llamar al método ElMessage.closeAll() para cerrar manualmente todas las instancias.

App context inheritance 2.0.3

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

Puede usarlo así:

TIP

Si ha registrado globalmente el componente ElMessage, automáticamente heredará el contexto de la aplicación.

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

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

API

Opciones

NombreDescripciónTipoPor defecto
messagetexto del mensajestring / VNode / Function''
typetipo de mensajeenuminfo
plain 2.6.3whether message is plainbooleanfalse
iconcomponente de icono personalizado, sobreescribe typestring / Component
dangerouslyUseHTMLStringutilizado para que message sea tratado como cadena HTMLbooleanfalse
customClassnombre de clase personalizado para el componente Messagestring''
durationduración del tiempo en que será mostrado, en milisegundos. Si se establece a 0, no se desactivará automáticamentenumber3000
showClosesi se muestra el botón de cerrarbooleanfalse
centerutilizado para centrar el textobooleanfalse
onClosefunción callback ejecutada cuando se cierra con una instancia de message como parámetroFunction
offsetajustar la distancia a la parte superior de la vistanumber16
appendToestablecer el elemento raíz del mensaje, por defecto document.bodystring / HTMLElement
groupingcombinar mensajes con el mismo contenido, el tipo de mensaje VNode no está soportadobooleanfalse
repeatNumThe number of repetitions, similar to badge, is used as the initial number when used with groupingnumber1

Métodos

Message y this.$message regresan una instancia del componente Message. Para cerrar manualmente la instancia, puede llamar al método close.

NombreDescripciónTipo
closecierra el componente MessageFunction

Fuente

ComponentesStyleDocumentación

Contribuidores