Web/API/NotificationEvent

The parameter passed into the onnotificationclick handler, the NotificationEvent interface represents a notification click event that is dispatched on the ServiceWorkerGlobalScope of a ServiceWorker.

This interface inherits from the ExtendableEvent interface.

Constructor

NotificationEvent()

Creates a new NotificationEvent object.

Properties

Inherits properties from its ancestor, Event.

NotificationEvent.notification Read only

Returns a Notification object representing the notification that was clicked to fire the event.

NotificationEvent.action Read only

Returns the string ID of the notification button the user clicked. This value returns an empty string if the user clicked the notification somewhere other than an action button, or the notification does not have a button.

Methods

Inherits methods from its parent, ExtendableEvent.

ExtendableEvent.waitUntil()

Extends the lifetime of the event. Tells the browser that work is ongoing.

Example

self.addEventListener('notificationclick', function(event) {
  console.log('On notification click: ', event.notification.tag);
  event.notification.close();

  // This looks to see if the current is already open and
  // focuses if it is
  event.waitUntil(clients.matchAll({
    type: "window"
  }).then(function(clientList) {
    for (var i = 0; i < clientList.length; i++) {
      var client = clientList[i];
      if (client.url == '/' && 'focus' in client)
        return client.focus();
    }
    if (clients.openWindow)
      return clients.openWindow('/');
  }));
});

Specifications

Specification	Status	Comment
Notifications APIThe definition of 'NotificationEvent' in that specification.	Living Standard	Living standard.

Note: This interface is specified in the Notifications API, but accessed through ServiceWorkerGlobalScope.

Browser Compatibility

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
NotificationEvent Experimental'	Chrome Full support 42	Edge Full support ≤18	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera Full support 37	Safari ?	WebView Android No support No	Chrome Android Full support 42	Firefox Android Full support 44	Opera Android Full support 37	Safari iOS ?	Samsung Internet Android Full support 4.0
NotificationEvent() constructor Experimental'	Chrome Full support 42	Edge Full support ≤18	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera Full support 37	Safari ?	WebView Android No support No	Chrome Android Full support 42	Firefox Android Full support 44	Opera Android Full support 37	Safari iOS ?	Samsung Internet Android Full support 4.0
action Experimental'	Chrome Full support 48	Edge Full support ≤18	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera No support No	Safari ?	WebView Android No support No	Chrome Android Full support 48	Firefox Android Full support 44	Opera Android No support No	Safari iOS ?	Samsung Internet Android Full support 5.0
notification Experimental'	Chrome Full support 42	Edge Full support ≤18	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera Full support 37	Safari ?	WebView Android No support No	Chrome Android Full support 42	Firefox Android Full support 44	Opera Android Full support 37	Safari iOS ?	Samsung Internet Android Full support 4.0

Legend

Full support  

Full support

No support  

No support

Compatibility unknown  

Compatibility unknown

Experimental. Expect behavior to change in the future.'

Experimental. Expect behavior to change in the future.

See implementation notes.'

See implementation notes.

NotificationEvent by Mozilla Contributors is licensed under CC-BY-SA 2.5.