Navigator: setAppBadge() method
The setAppBadge()
method of the Navigator
interface sets a badge on the icon associated with this app. If a value is passed to the method, this will be set as the value of the badge. Otherwise the badge will display as a dot, or other indicator as defined by the platform.
Syntax
js
setAppBadge()
setAppBadge(contents)
Parameters
contents
Optional-
A
number
which will be used as the value of the badge. Ifcontents
is0
then the badge will be set tonothing
, indicating a cleared badge.
Return value
Exceptions
NotSupportedError
DOMException
-
The
Navigator
does not have a document that this action can be acted on.
Examples
In the example below an unread count is passed to setAppBadge()
. The badge should then display 30
.
js
const unread = 30;
navigator.setAppBadge(unread);
Specifications
Specification |
---|
Badging API # setappbadge-method |
Browser compatibility
BCD tables only load in the browser