Navigator.setAppBadge()

The setAppBadge() method of the Navigator interface 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

let promise = Navigator.setAppBadge(contents);

Parameters

contentsOptional
A number which will be used as the value of the badge. If contents is 0 then the badge will be set to nothing, indicating a cleared badge.

Return value

A Promise that resolves with undefined.

Exceptions

NotSupportedError
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.

const unread = 30;
navigator.setAppBadge(unread);

Specifications

Specification Status Comment
Badging API
The definition of 'setAppBadge' in that specification.
Draft Initial definition.

Browser compatibility

BCD tables only load in the browser

See also