CloseWatcher: close event

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

A close event is fired at a CloseWatcher object when a close request was received and only fired if the cancel event that preceded the close one was not canceled.

The close event handler is where the code to close the UI component should be called: this ensures that the component will be closed properly either from the platform-specific close signal or from a call to CloseWatcher.requestClose().

Syntax

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

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

onclose = (event) => { }

Event type

An Event.

Examples

Using the close event

Use the close to listen for close requests.

js
watcher.addEventListener("close", () => {
  // Close your UI component
  sidebar.hide();
};

Specifications

Specification
HTML Standard
# handler-closewatcher-onclose

Browser compatibility

BCD tables only load in the browser