Message

Used to show feedback after an activity. The difference with Notification is that the latter is often used to show a system level passive notification.

Basic usage

Displays at the top, and disappears after 3 seconds.

Types

Used to show the feedback of Success, Warning, Message and Error activities.

Closable

A close button can be added.

Centered text

Use the center attribute to center the text.

Use HTML string

message supports HTML string.

WARNING

Although message property supports HTML strings, dynamically rendering arbitrary HTML on your website can be very dangerous because it can easily lead to XSS attacks. So when dangerouslyUseHTMLString is on, please make sure the content of message is trusted, and never assign message to user-provided content.

Grouping

merge messages with the same content.

Global method

Element Plus has added a global method $message for app.config.globalProperties. So in a vue instance you can call Message like what we did in this page.

Local import

import { ElMessage } from 'element-plus'

In this case you should call ElMessage(options). We have also registered methods for different types, e.g. ElMessage.success(options). You can call ElMessage.closeAll() to manually close all the instances.

App context inheritance >= 2.0.3

Now message accepts a context as second parameter of the message constructor which allows you to inject current app's context to message which allows you to inherit all the properties of the app.

You can use it like this:

TIP

If you globally registered ElMessage component, it will automatically inherit your app context.

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

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

API

Options

NameDescriptionTypeDefault
messagemessage textstring / VNode / Function''
typemessage typeenuminfo
iconcustom icon component, overrides typestring / Component
dangerouslyUseHTMLStringwhether message is treated as HTML stringbooleanfalse
customClasscustom class name for Messagestring''
durationdisplay duration, millisecond. If set to 0, it will not turn off automaticallynumber3000
showClosewhether to show a close buttonbooleanfalse
centerwhether to center the textbooleanfalse
onClosecallback function when closed with the message instance as the parameterFunction
offsetset the distance to the top of viewportnumber16
appendToset the root element for the message, default to document.bodystring / HTMLElement
groupingmerge messages with the same content, type of VNode message is not supportedbooleanfalse
repeatNumThe number of repetitions, similar to badge, is used as the initial number when used with groupingnumber1

Methods

Message and this.$message returns the current Message instance. To manually close the instance, you can call close on it.

NameDescriptionType
closeclose the MessageFunction

Source

ComponentDocs

Contributors