HTMLDialogElement: cancel event

The cancel event fires on a <dialog> when the user instructs the browser that they wish to dismiss the current open dialog. For example, the browser might fire this event when the user presses the Esc key or clicks a "Close dialog" button which is part of the browser's UI.

This event does not bubble.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

addEventListener('cancel', (event) => {});

oncancel = (event) => { };

Event type

A generic Event.

Examples

Live example

HTML

<dialog class="example-dialog">
  <button class="close" type="reset">Close</button>
</dialog>

<button class="open-dialog">Open dialog</button>

<div class="result"></div>

JavaScript

const result = document.querySelector('.result');

const dialog = document.querySelector('.example-dialog');

dialog.addEventListener('cancel', (event) => {
  result.textContent = 'dialog was canceled';
});

const openDialog = document.querySelector('.open-dialog');
openDialog.addEventListener('click', () => {
  if (typeof dialog.showModal === 'function') {
      dialog.showModal();
      result.textContent = '';
  } else {
      result.textContent = 'The dialog API is not supported by this browser';
  }
});

const closeButton = document.querySelector('.close');
closeButton.addEventListener('click', () => {
    dialog.close();
});

Result

Specifications

Specification
HTML Standard
# event-cancel
HTML Standard
# handler-oncancel

Browser compatibility

BCD tables only load in the browser

See also