web api instance method

Navigator: setAppBadge() method

Secure context

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

contents Optional
- : 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

InvalidStateError DOMException
- : Thrown if the document is not fully active.
SecurityError DOMException
- : Thrown if the call was blocked by the same-origin policy.
NotAllowedError DOMException
- : Thrown if 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

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.