The showNotification()
method of the ServiceWorkerRegistration
interface creates a notification on an active service worker.
Note: This feature is available in Web Workers.
The showNotification()
method of the ServiceWorkerRegistration
interface creates a notification on an active service worker.
Note: This feature is available in Web Workers.
serviceWorkerRegistration.showNotification(title, [options]);
title
The title that must be shown within the notification
options
Optional
An object that allows configuring the notification. It can have the following properties:
actions
: An array of actions to display in the notification. Each element in the array is an object with the following members:
action
: A DOMString
identifying a user action to be displayed on the notification.title
: A DOMString
containing action text to be shown to the user.icon
: A USVString
containing the URL of an icon to display with the action.event.action
within the notificationclick
event. badge
: a USVString
containing the URL of an image to represent the notification when there is not enough space to display the notification itself such as for example, the Android Notification Bar. On Android devices, the badge should accommodate devices up to 4x resolution, about 96 by 96 px, and the image will be automatically masked. body
: A string representing an extra content to display within the notification. data
: Arbitrary data that you want to be associated with the notification. This can be of any data type. dir
: The direction of the notification; it can be auto
, ltr
or rtl
icon
: a USVString
containing the URL of an image to be used as an icon by the notification. image
: a USVString
containing the URL of an image to be displayed in the notification. lang
: Specify the lang used within the notification. This string must be a valid language tag according to RFC 5646: Tags for Identifying Languages (also known as BCP 47). renotify
: A boolean that indicates whether to suppress vibrations and audible alerts when reusing a tag
value. If options's renotify
is true and options's tag
is the empty string a TypeError will be thrown. The default is false
. requireInteraction
: Indicates that on devices with sufficiently large screens, a notification should remain active until the user clicks or dismisses it. If this value is absent or false, the desktop version of Chrome will auto-minimize notifications after approximately twenty seconds. The default value is false
. silent
: When set indicates that no sounds or vibrations should be made. If options's silent
is true and options's vibrate
is present a TypeError exception will be thrown. The default value is false
. tag
: An ID for a given notification that allows you to find, replace, or remove the notification using a script if necessary. timestamp
: A DOMTimeStamp
representing the time when the notification was created. It can be used to indicate the time at which a notification is actual. For example, this could be in the past when a notification is used for a message that couldn't immediately be delivered because the device was offline, or in the future for a meeting that is about to start. vibrate
: A vibration pattern to run with the display of the notification. A vibration pattern can be an array with as few as one member. The values are times in milliseconds where the even indices (0, 2, 4, etc.) indicate how long to vibrate and the odd indices indicate how long to pause. For example, [300, 100, 400]
would vibrate 300ms, pause 100ms, then vibrate 400ms. A Promise
that resolves to undefined
.
navigator.serviceWorker.register('sw.js'); function showNotification() { Notification.requestPermission(function(result) { if (result === 'granted') { navigator.serviceWorker.ready.then(function(registration) { registration.showNotification('Vibration Sample', { body: 'Buzz! Buzz!', icon: '../images/touch/chrome-touch-icon-192x192.png', vibrate: [200, 100, 200, 100, 200, 100, 200], tag: 'vibration-sample' }); }); } }); }
To invoke the above function at an appropriate time, you could use the onnotificationclick
event handler.
You can also retrieve details of the Notification
s that have been fired from the current service worker using ServiceWorkerRegistration.getNotifications()
.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
showNotification |
42
|
17
|
46
Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
|
No
|
29
|
No
|
No
See
bug 421921.
|
42
|
46
|
29
|
No
|
4.0
|
actions |
45
|
≤79
|
No
|
No
|
32
|
No
|
No
|
45
|
No
|
32
|
No
|
5.0
|
badge |
53
|
≤79
|
No
|
No
|
39
|
No
|
No
|
53
|
No
|
41
|
No
|
6.0
|
data |
44
|
≤79
|
No
|
No
|
31
|
No
|
No
|
44
|
No
|
32
|
No
|
4.0
|
image |
56
|
≤79
|
No
|
No
|
43
|
No
|
No
|
56
|
No
|
43
|
No
|
6.0
|
renotify |
50
|
≤79
|
No
|
No
|
37
|
No
|
No
|
50
|
No
|
37
|
No
|
5.0
|
requireInteraction |
47
|
≤79
|
No
|
No
|
34
|
No
|
No
|
47
|
No
|
34
|
No
|
5.0
|
vibrate |
45
|
≤79
|
No
|
No
|
32
|
No
|
No
|
45
|
No
|
32
|
No
|
5.0
|
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/showNotification