Notification: close() method
Note: This feature is available in Web Workers
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The close()
method of the Notification
interface is used to
close/remove a previously displayed notification.
Note: This API shouldn't be used just to have the notification removed from the screen after a fixed delay since this method will also remove the notification from any notification tray, preventing users from interacting with it after it was initially shown. A valid use for this API would be to remove a notification that is no longer relevant (e.g. the user already read the notification on the webpage in the case of a messaging app or the following song is already playing in a music app).
Syntax
js
close()
Parameters
None.
Return value
None (undefined
).
Examples
In the following snippet, we have a simple function that when called creates an
options
object and then a new notification. At the end of the function, it
also calls close()
inside a
addEventListener()
function to remove the
notification when the relevant content has been read on the webpage.
js
function spawnNotification(theBody, theIcon, theTitle) {
const options = {
body: theBody,
icon: theIcon,
};
const n = new Notification(theTitle, options);
document.addEventListener("visibilitychange", () => {
if (document.visibilityState === "visible") {
// The tab has become visible so clear the now-stale Notification.
n.close();
}
});
}
Specifications
Specification |
---|
Notifications API Standard # dom-notification-close |
Browser compatibility
BCD tables only load in the browser