Dialog

Informs users while preserving the current page state.

Basic usage

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

Set model-value / v-model attribute with a Boolean, and Dialog shows when it is true. The Dialog has two parts: body and footer, and the latter requires a slot named footer. The optional title attribute (empty by default) is for defining a title. Finally, this example demonstrates how before-close is used.

export function DialogBasicUsage() {  const [visible, setVisible] = useState(false);  return (    <>      <ElButton plain onClick={() => setVisible(true)}>        Click to open the Dialog      </ElButton>      <ElDialog        visible={visible}        onVisibleChange={setVisible}        title="Tips"        width={500}        beforeClose={(done) => {          MessageBox.confirm("Are you sure to close this dialog?")            .then(() => done())            .catch(() => {});        }}        footer={          <Footer            cancel={() => setVisible(false)}            confirm={() => setVisible(false)}          />        }      >        <span>This is a message</span>      </ElDialog>    </>  );}

TIP

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.

export function DialogCustomizationContent() {  const [tableVisible, setTableVisible] = useState(false);  const [formVisible, setFormVisible] = useState(false);  const [form, setForm] = useState({ name: "", region: "" });  return (    <>      <div className={styles.row}>        <ElButton plain onClick={() => setTableVisible(true)}>          Open a Table nested Dialog        </ElButton>        <ElButton plain onClick={() => setFormVisible(true)}>          Open a Form nested Dialog        </ElButton>      </div>      <ElDialog visible={tableVisible} onVisibleChange={setTableVisible} title="Shipping address" width={800}>        <ElTable data={gridData}>          <ElTableColumn property="date" label="Date" width={150} />          <ElTableColumn property="name" label="Name" width={200} />          <ElTableColumn property="address" label="Address" />        </ElTable>      </ElDialog>      <ElDialog        visible={formVisible}        onVisibleChange={setFormVisible}        title="Shipping address"        width={500}        footer={          <Footer            cancel={() => setFormVisible(false)}            confirm={() => setFormVisible(false)}          />        }      >        <div style={{ display: "grid", gap: "0.875rem" }}>          <label style={{ display: "flex", alignItems: "center", gap: "0.75rem" }}>            <span style={{ width: 140 }}>Promotion name</span>            <ElInput              value={form.name}              onChange={(value) => setForm((current) => ({ ...current, name: value }))}            />          </label>          <label style={{ display: "flex", alignItems: "center", gap: "0.75rem" }}>            <span style={{ width: 140 }}>Zones</span>            <ElSelect              value={form.region}              onChange={(value) =>                setForm((current) => ({ ...current, region: String(value ?? "") }))              }              placeholder="Please select a zone"              options={[                { value: "shanghai", label: "Zone No.1" },                { value: "beijing", label: "Zone No.2" },              ]}              style={{ flex: 1 }}            />          </label>        </div>      </ElDialog>    </>  );}

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.

export function DialogCustomizationHeader() {  const [visible, setVisible] = useState(false);  return (    <>      <ElButton plain onClick={() => setVisible(true)}>        Open Dialog with customized header      </ElButton>      <ElDialog        visible={visible}        onVisibleChange={setVisible}        showClose={false}        width={500}        header={({ close, titleId, titleClass }) => (          <div            style={{              display: "flex",              flexDirection: "row",              justifyContent: "space-between",              gap: 16,            }}          >            <h4 id={titleId} className={titleClass} style={{ margin: 0 }}>              This is a custom header!            </h4>            <ElButton type="danger" onClick={close}>              <CircleCloseFilled style={{ marginRight: 4 }} />              Close            </ElButton>          </div>        )}      >        This is dialog content.      </ElDialog>    </>  );}

Nested Dialog

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

Normally we do not recommend using nested Dialog. If you need multiple Dialogs rendered on the page, you can simply flat them so that they're siblings to each other. If you must nest a Dialog inside another Dialog, set append-to-body of the nested Dialog to true, and it will append to body instead of its parent node, so both Dialogs can be correctly rendered.

export function DialogNestedDialog() {  const [outerVisible, setOuterVisible] = useState(false);  const [innerVisible, setInnerVisible] = useState(false);  return (    <>      <ElButton plain onClick={() => setOuterVisible(true)}>        Open the outer Dialog      </ElButton>      <ElDialog        visible={outerVisible}        onVisibleChange={setOuterVisible}        title="Outer Dialog"        width={800}        footer={          <Footer            cancel={() => setOuterVisible(false)}            confirm={() => setInnerVisible(true)}            confirmText="Open the inner Dialog"          />        }      >        <span>This is the outer Dialog</span>        <ElDialog          visible={innerVisible}          onVisibleChange={setInnerVisible}          width={500}          title="Inner Dialog"          appendToBody        >          <span>This is the inner Dialog</span>        </ElDialog>      </ElDialog>    </>  );}

Centered content

Dialog's content can be centered.

Setting center to true will center dialog's header and footer horizontally. center only affects Dialog's header and footer. The body of Dialog can be anything, so sometimes it may not look good when centered. You need to write some CSS if you wish to center the body as well.

export function DialogCenteredContent() {  const [visible, setVisible] = useState(false);  return (    <>      <ElButton plain onClick={() => setVisible(true)}>        Click to open the Dialog      </ElButton>      <ElDialog        visible={visible}        onVisibleChange={setVisible}        title="Warning"        width={500}        center        footer={          <Footer            cancel={() => setVisible(false)}            confirm={() => setVisible(false)}          />        }      >        <span>          It should be noted that the content will not be aligned in center by          default        </span>      </ElDialog>    </>  );}

TIP

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.

Setting align-center to true will center the dialog both horizontally and vertically. The prop top will not work at the same time because the dialog is vertically centered in a flexbox.

export function DialogAlignCenter() {  const [visible, setVisible] = useState(false);  return (    <>      <ElButton plain onClick={() => setVisible(true)}>        Click to open the Dialog      </ElButton>      <ElDialog        visible={visible}        onVisibleChange={setVisible}        title="Warning"        width={500}        alignCenter        footer={          <Footer            cancel={() => setVisible(false)}            confirm={() => setVisible(false)}          />        }      >        <span>Open the dialog from the center from the screen</span>      </ElDialog>    </>  );}

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.

Note that by enabling this feature, the content will not be rendered before transition.beforeEnter dispatched, there will only be overlay header(if any) footer(if any).

export function DialogDestroyOnClose() {  const [visible, setVisible] = useState(false);  return (    <>      <ElButton plain onClick={() => setVisible(true)}>        Click to open Dialog      </ElButton>      <ElDialog        visible={visible}        onVisibleChange={setVisible}        title="Notice"        width={500}        destroyOnClose        center        footer={          <Footer            cancel={() => setVisible(false)}            confirm={() => setVisible(false)}          />        }      >        <span>          Notice: before the dialog is opened for the first time, this node and          the one below will not be rendered.        </span>        <div>          <strong>Extra content (Not rendered)</strong>        </div>      </ElDialog>    </>  );}

Draggable Dialog

Try to drag the header part.

Set draggable to true to drag. Set overflow 2.5.4 to true can drag overflow the viewport.

export function DialogDraggableDialog() {  const [visible, setVisible] = useState(false);  const [overflowVisible, setOverflowVisible] = useState(false);  const [customVisible, setCustomVisible] = useState(false);  return (    <>      <div className={styles.rowGap1}>        <ElButton plain onClick={() => setVisible(true)}>          Open a draggable Dialog        </ElButton>        <ElButton plain onClick={() => setOverflowVisible(true)}>          Open a overflow draggable Dialog        </ElButton>        <ElButton plain onClick={() => setCustomVisible(true)}>          Open a custom dragging style Dialog        </ElButton>      </div>      <ElDialog        visible={visible}        onVisibleChange={setVisible}        title="Tips"        width={500}        draggable        footer={          <Footer            cancel={() => setVisible(false)}            confirm={() => setVisible(false)}          />        }      >        <span>It&apos;s a draggable Dialog</span>      </ElDialog>      <ElDialog        visible={overflowVisible}        onVisibleChange={setOverflowVisible}        title="Tips"        width={500}        draggable        overflow        footer={          <Footer            cancel={() => setOverflowVisible(false)}            confirm={() => setOverflowVisible(false)}          />        }      >        <span>It&apos;s a overflow draggable Dialog</span>      </ElDialog>      <ElDialog        visible={customVisible}        onVisibleChange={setCustomVisible}        className="custom-dragging-style"        title="Custom Dragging Style"        width={500}        draggable        footer={          <Footer            cancel={() => setCustomVisible(false)}            confirm={() => setCustomVisible(false)}          />        }      >        <span>          This dialog has custom dragging styles. Try dragging it to see the          effects!        </span>      </ElDialog>    </>  );}

TIP

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.

Fullscreen

Set the fullscreen attribute to open fullscreen dialog.

export function DialogFullscreen() {  const [visible, setVisible] = useState(false);  return (    <>      <ElButton plain onClick={() => setVisible(true)}>        Open the fullscreen Dialog      </ElButton>      <ElDialog        visible={visible}        onVisibleChange={setVisible}        fullscreen        footer={          <Footer            cancel={() => setVisible(false)}            confirm={() => setVisible(false)}          />        }      >        <span>It&apos;s a fullscreen Dialog</span>      </ElDialog>    </>  );}

TIP

If fullscreen is true, width top draggable attributes don't work.

Setting modal to false will hide modal (overlay) of dialog.

Starting from version 2.10.5, modal-penetrable attribute is added, which can be penetrable.

export function DialogModal() {  const [visible, setVisible] = useState(false);  return (    <>      <ElButton plain onClick={() => setVisible(true)}>        Open the modal Dialog      </ElButton>      <ElDialog        visible={visible}        onVisibleChange={setVisible}        modal={false}        modalPenetrable        footer={          <Footer            cancel={() => setVisible(false)}            confirm={() => setVisible(false)}          />        }      >        <span>It&apos;s a modal Dialog</span>      </ElDialog>    </>  );}

Custom Animation 2.10.5

Customize dialog animation through the transition attribute, which accepts either:

Transition name (string)
Vue transition configuration (object)

Examples include scale, slide, fade, bounce animations and object-based configurations with custom event handlers.

export function DialogCustomAnimation() {  const [visible, setVisible] = useState(false);  const [animation, setAnimation] = useState("fade");  const [isObjectConfig, setIsObjectConfig] = useState(false);  const open = (type: string) => {    setAnimation(type);    setIsObjectConfig(false);    setVisible(true);  };  const openWithObject = () => {    setAnimation("object-config");    setIsObjectConfig(true);    setVisible(true);  };  const transition = isObjectConfig    ? "dialog-custom-object"    : `dialog-${animation}`;  return (    <>      <div>        <ElButton plain onClick={() => open("fade")}>          Default        </ElButton>        <ElButton plain onClick={() => open("scale")}>          Scale        </ElButton>        <ElButton plain onClick={() => open("slide")}>          Slide        </ElButton>        <ElButton plain onClick={() => open("bounce")}>          Bounce        </ElButton>        <ElButton plain onClick={openWithObject}>          Object Config        </ElButton>      </div>      <ElDialog        visible={visible}        onVisibleChange={setVisible}        className="custom-transition-dialog"        title={`${animation} Animation Dialog`}        width="30%"        transition={transition}        footer={          <Footer            cancel={() => setVisible(false)}            confirm={() => setVisible(false)}          />        }      >        <div>          <p>            Current animation: <strong>{animation}</strong>          </p>          <p>            This dialog demonstrates the {animation} animation effect.          </p>          {isObjectConfig && (            <p>              <strong>Using object configuration:</strong>              <br />              <code className={styles.code}>                {JSON.stringify(objectTransitionConfig, null, 2)}              </code>            </p>          )}        </div>      </ElDialog>    </>  );}

TIP

Animation classes are dynamically generated based on the transition name. For granular control over animation behavior, you may explicitly define these classes. Refer to custom-transition-classes for details.

Events

Open developer console (ctrl + shift + J), to see order of events.

export function DialogEvents() {  const [visible, setVisible] = useState(false);  const [logs, setLogs] = useState<string[]>([]);  const log = (name: string) => setLogs((current) => [...current, name]);  return (    <>      <ElButton plain onClick={() => setVisible(true)}>        Open the event Dialog      </ElButton>      <ElDialog        visible={visible}        onVisibleChange={setVisible}        beforeClose={(done) => {          log("before-close");          done();        }}        onOpen={() => log("open")}        onOpened={() => log("opened")}        onClose={() => log("close")}        onClosed={() => log("closed")}        onOpenAutoFocus={() => log("open-auto-focus")}        onCloseAutoFocus={() => log("close-auto-focus")}        footer={          <Footer            cancel={() => setVisible(false)}            confirm={() => setVisible(false)}          />        }      >        <span>It&apos;s a event Dialog</span>        <div style={{ marginTop: 12, fontSize: 12, color: "var(--el-text-color-secondary)" }}>          {logs.length > 0 ? logs.join(" → ") : "No events yet"}        </div>      </ElDialog>    </>  );}

API

Attributes

Name	Description	Type	Default
model-value / v-model	visibility of Dialog	`boolean`	false
title	title of Dialog. Can also be passed with a named slot (see the following table)	`string`	''
width	width of Dialog, default is 50%	`string` / `number`	''
fullscreen	whether the Dialog takes up full screen	`boolean`	false
top	value for `margin-top` of Dialog CSS, default is 15vh	`string`	''
modal	whether a mask is displayed	`boolean`	true
modal-penetrable 2.10.5	whether the mask is penetrable. The modal attribute must be `false`.	`boolean`	false
modal-class	custom class names for mask	`string`	—
header-class 2.9.3	custom class names for header wrapper	`string`	—
body-class 2.9.3	custom class names for body wrapper	`string`	—
footer-class 2.9.3	custom class names for footer wrapper	`string`	—
append-to-body	whether to append Dialog itself to body. A nested Dialog should have this attribute set to `true`	`boolean`	false
append-to 2.4.3	which element the Dialog appends to. Will override `append-to-body`	`CSSSelector` / `HTMLElement`	body
lock-scroll	whether scroll of body is disabled while Dialog is displayed	`boolean`	true
open-delay	the Time(milliseconds) before open	`number`	0
close-delay	the Time(milliseconds) before close	`number`	0
close-on-click-modal	whether the Dialog can be closed by clicking the mask	`boolean`	true
close-on-press-escape	whether the Dialog can be closed by pressing ESC	`boolean`	true
show-close	whether to show a close button	`boolean`	true
before-close	callback before Dialog closes, and it will prevent Dialog from closing, use done to close the dialog	`Function`	—
draggable	enable dragging feature for Dialog	`boolean`	false
overflow 2.5.4	draggable Dialog can overflow the viewport	`boolean`	false
center	whether to align the header and footer in center	`boolean`	false
align-center 2.2.16	whether to align the dialog both horizontally and vertically	`boolean`	false
destroy-on-close	destroy elements in Dialog when closed	`boolean`	false
close-icon	custom close icon, default is Close	`string` / `Component`	—
z-index	same as z-index in native CSS, z-order of dialog	`number`	—
header-aria-level a11y	header's `aria-level` attribute	`string`	2
transition 2.10.5	custom transition configuration for dialog animation. Can be a string (transition name) or an object with Vue transition props	`string` / `object`	dialog-fade
custom-class deprecated	custom class names for Dialog	`string`	''

WARNING

custom-class has been deprecated, and will be removed in 2.4.0, please use class.

Slots

Name	Description
default	default content of Dialog
header	content of the Dialog header; Replacing this removes the title, but does not remove the close button.
footer	content of the Dialog footer
title deprecated	works the same as the header slot. Use that instead.

WARNING

title has been deprecated, and will be removed in 3.0.0, please use header.

Events

Name	Description	Type
open	triggers when the Dialog opens	`Function`
opened	triggers when the Dialog opening animation ends	`Function`
close	triggers when the Dialog closes	`Function`
closed	triggers when the Dialog closing animation ends	`Function`
open-auto-focus	triggers after Dialog opens and content focused	`Function`
close-auto-focus	triggers after Dialog closed and content focused	`Function`

Exposes

Name	Description	Type
resetPosition 2.8.1	reset position	`Function`
handleClose 2.9.8	close dialog	`Function`

FAQ

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.