HTMLDialogElement: close event

فهرست فصل‌ها دانلود آرشیوناشر

MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونه‌کد

{{APIRef("HTML DOM")}}

The close event is fired on an HTMLDialogElement object when the {{htmlelement("dialog")}} it represents has been closed.

This event is not cancelable and does not bubble.

Syntax

Use the event name in {{domxref("EventTarget/addEventListener", "addEventListener()")}}:

js-nolint
addEventListener("close", (event) => { })

Alternatively, assign to the event handler property of the interface:

js-nolint
onclose = (event) => { }

Event type

A generic {{domxref("Event")}}.

Examples

Handling close events

This example demonstrates how to listen for close events triggered by several different methods for closing a dialog:

  • Calling the {{domxref("HTMLDialogElement.close()", "close()")}} method
  • A form with method="dialog". Submitting the form closes the dialog and causes a {{domxref("HTMLFormElement/submit_event", "submit")}} event to be fired, without submitting data or clearing the form
  • The <kbd>Esc</kbd> key.

See {{domxref("HTMLDialogElement/cancel_event", "cancel")}} event

HTML

html
<dialog id="dialog">
  <form method="dialog">
    <button type="submit">Close via method="dialog"</button>
  </form>
  <p><button id="close">Close via .close() method</button></p>
  <p>Or hit the <kbd>Esc</kbd> key</p>
</dialog>

<button id="open">Open dialog</button>
html hidden
css hidden
js hidden

JavaScript

js
const dialog = document.getElementById("dialog");
const openButton = document.getElementById("open");
const closeButton = document.getElementById("close");

openButton.addEventListener("click", () => {
  log("open button click event fired", true);
  log("dialog showModal() called");
  dialog.showModal();
});

closeButton.addEventListener("click", () => {
  log("close button click event fired");
  log("dialog close() called");
  dialog.close();
});

dialog.addEventListener("close", (event) => {
  log("dialog close event fired");
});

Result

{{ EmbedLiveSample('Handling close events', '100%', '250px') }}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • HTML {{htmlelement("dialog")}} element