Navigator: setAppBadge() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

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

setAppBadge() 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

InvalidStateErrorDOMException: Thrown if the document is not fully active.
SecurityErrorDOMException: Thrown if the call was blocked by the same-origin policy.
NotAllowedErrorDOMException: Thrown if PermissionStatus.state is not granted.

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
Badging API # setappbadge-method