Message Box

A set of modal boxes simulating system message box, mainly for alerting information, confirm operations and prompting messages.

TIP

By design MessageBox provides simulations of system's alert, confirm and prompt,so it's content should be simple. For more complicated contents, please use Dialog.

Alert

Alert interrupts user operation until the user confirms.

Confirm

Confirm is used to ask users' confirmation.

Prompt

Prompt is used when user input is required.

Customization

Can be customized to show various content.

TIP

The content of MessageBox can be VNode, allowing us to pass custom components. When opening the MessageBox, Vue compares new VNode with old VNode, then figures out how to efficiently update the UI, so the components may not be completely re-rendered (#8931). In this case, you can add a unique key to VNode each time MessageBox opens: example.

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.

Distinguishing cancel and close

In some cases, clicking the cancel button and close button may have different meanings.

Centered content

Content of MessageBox can be centered.

Global method

If Element Plus is fully imported, it will add the following global methods for app.config.globalProperties: $msgbox, $alert, $confirm and $prompt. So in a Vue instance you can call MessageBox like what we did in this page. The parameters are:

  • $msgbox(options)
  • $alert(message, title, options) or $alert(message, options)
  • $confirm(message, title, options) or $confirm(message, options)
  • $prompt(message, title, options) or $prompt(message, options)

Local import

If you prefer importing MessageBox on demand:

import { ElMessageBox } from 'element-plus'

The corresponding methods are: ElMessageBox, ElMessageBox.alert, ElMessageBox.confirm and ElMessageBox.prompt. The parameters are the same as above.

Options

AttributeDescriptionTypeAccepted ValuesDefault
titletitle of the MessageBoxstring
messagecontent of the MessageBoxstring
dangerouslyUseHTMLStringwhether message is treated as HTML stringbooleanfalse
typemessage type, used for icon displaystringsuccess / info / warning / error
icon-classcustom icon's class, overrides typestring
custom-classcustom class name for MessageBoxstring
custom-stylecustom inline style for MessageBoxCSSProperties
callbackMessageBox closing callback if you don't prefer Promisefunction(action), where action can be 'confirm', 'cancel' or 'close', and instance is the MessageBox instance. You can access to that instance's attributes and methods
showClosewhether to show close icon of MessageBoxbooleantrue
before-closecallback before MessageBox closes, and it will prevent MessageBox from closingfunction(action, instance, done), where action can be 'confirm', 'cancel' or 'close'; instance is the MessageBox instance, and you can access to that instance's attributes and methods; done is for closing the instance
distinguish-cancel-and-closewhether to distinguish canceling and closing the MessageBoxbooleanfalse
lock-scrollwhether to lock body scroll when MessageBox promptsbooleantrue
show-cancel-buttonwhether to show a cancel buttonbooleanfalse (true when called with confirm and prompt)
show-confirm-buttonwhether to show a confirm buttonbooleantrue
cancel-button-texttext content of cancel buttonstringCancel
confirm-button-texttext content of confirm buttonstringOK
cancel-button-classcustom class name of cancel buttonstring
confirm-button-classcustom class name of confirm buttonstring
close-on-click-modalwhether MessageBox can be closed by clicking the maskbooleantrue (false when called with alert)
close-on-press-escapewhether MessageBox can be closed by pressing the ESCbooleantrue (false when called with alert)
close-on-hash-changewhether to close MessageBox when hash changesbooleantrue
show-inputwhether to show an inputbooleanfalse (true when called with prompt)
input-placeholderplaceholder of inputstring
input-typetype of inputstringtext
input-valueinitial value of inputstring
input-patternregexp for the inputregexp
input-validatorvalidation function for the input. Should returns a boolean or string. If a string is returned, it will be assigned to inputErrorMessagefunction
input-error-messageerror message when validation failsstringIllegal input
centerwhether to align the content in centerbooleanfalse
round-buttonwhether to use round buttonbooleanfalse
button-sizecustom size of confirm and cancel buttonsstringmini / small / medium / largesmall