CloseWatcher: requestClose() method
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.
The requestClose()
method of the CloseWatcher
interface fires a cancel
event and if that event is not canceled with Event.preventDefault()
, proceeds to fire a close
event, and then finally deactivates the close watcher as if destroy()
was called.
Syntax
requestClose()
Parameters
None.
Return value
None (undefined
).
Examples
Using the requestClose()
method
In this example, you have your own UI component (a picker), and you want to support both the platform's default close method (e.g. the Esc key) and your custom close method (a close button).
The onclick
handler of your UI component can call requestClose
to request a close and to route your close request through the same onclose
handler the platform close method uses.
const watcher = new CloseWatcher();
const picker = setUpAndShowPickerDOMElement();
let chosenValue = null;
watcher.onclose = () => {
chosenValue = picker.querySelector("input").value;
picker.remove();
};
picker.querySelector(".close-button").onclick = () => watcher.requestClose();
Specifications
Specification |
---|
HTML Standard # dom-closewatcher-requestclose |
Browser compatibility
BCD tables only load in the browser