Informs users while preserving the current page state.


This component requires the <client-only></client-only> wrap when used in SSR (eg: Nuxt) and SSG (eg: VitePress).

Basic usage

Dialog pops up a dialog box, and it's quite customizable.


before-close only works when user clicks the close icon or the backdrop. If you have buttons that close the Dialog in the footer named slot, you can add what you would do with before-close in the buttons' click event handler.

Customized Content

The content of Dialog can be anything, even a table or a form. This example shows how to use Element Plus Table and Form with Dialog.

Customized Header

The header slot can be used to customize the area where the title is displayed. In order to maintain accessibility, use the title attribute in addition to using this slot, or use the titleId slot property to specify which element should be read out as the dialog title.

Nested Dialog

If a Dialog is nested in another Dialog, append-to-body is required.

Centered content

Dialog's content can be centered.


The content of Dialog is lazily rendered, which means the default slot is not rendered onto the DOM until it is firstly opened. Therefore, if you need to perform a DOM manipulation or access a component using ref, do it in the open event callback.

Align Center dialog

Open dialog from the center of the screen.

Destroy on Close

When this is feature is enabled, the content under default slot will be destroyed with a v-if directive. Enable this when you have perf concerns.

Draggable Dialog

Try to drag the header part.


When using modal = false, please make sure that append-to-body was set to true, because Dialog was positioned by position: relative, when modal gets removed, Dialog will position itself based on the current position in the DOM, instead of Document.Body, thus the style will be messed up.


NameDescriptionTypeAccepted ValuesDefault
model-value / v-modelvisibility of Dialogboolean
titletitle of Dialog. Can also be passed with a named slot (see the following table)string
widthwidth of Dialogstring / number50%
fullscreenwhether the Dialog takes up full screenbooleanfalse
topvalue for margin-top of Dialog CSSstring15vh
modalwhether a mask is displayedbooleantrue
append-to-bodywhether to append Dialog itself to body. A nested Dialog should have this attribute set to truebooleanfalse
lock-scrollwhether scroll of body is disabled while Dialog is displayedbooleantrue
custom-classdeprecatedcustom class names for Dialogstring
open-delayTime(milliseconds) before opennumber0
close-delayTime(milliseconds) before closenumber0
close-on-click-modalwhether the Dialog can be closed by clicking the maskbooleantrue
close-on-press-escapewhether the Dialog can be closed by pressing ESCbooleantrue
show-closewhether to show a close buttonbooleantrue
before-closecallback before Dialog closes, and it will prevent Dialog from closingFunction(done) (done is used to close the Dialog)
draggableenable dragging feature for Dialogbooleanfalse
centerwhether to align the header and footer in centerbooleanfalse
align-centerwhether to align the dialog both horizontally and verticallybooleanfalse
destroy-on-closeDestroy elements in Dialog when closedbooleanfalse


custom-class has been deprecated, and will be removed in2.3.0, please use class.


content of Dialog
headercontent of the Dialog header; Replacing this removes the title, but does not remove the close button.
titledeprecatedWorks the same as the header slot. Use that instead.
footercontent of the Dialog footer


opentriggers when the Dialog opens
openedtriggers when the Dialog opening animation ends
closetriggers when the Dialog closes
closedtriggers when the Dialog closing animation ends
open-auto-focustriggers after Dialog opens and content focused
close-auto-focustriggers after Dialog closed and content focused


Using dialog in SFC, the scope style does not take effect.

Typical issue: #10515

PS: Since the dialog is rendered using Teleport, the style of the root node is recommended to be written globally.

When the dialog is displayed and hidden, there is a situation where the page elements are displaced back and forth.

Typical issue: #10481

PS: It is recommended to place the scroll area inside a vue mounted node, e.g. <div id="app" />, and use the overflow: hidden style for the body.