ContextQMD
Back to Content

Navigator: setAppBadge() method

files/en-us/web/api/navigator/setappbadge/index.md

latest1.4 KB
Original Source

{{APIRef("Badging API")}}{{securecontext_header}}

The setAppBadge() method of the {{domxref("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-nolint
setAppBadge()
setAppBadge(contents)

Parameters

  • contents {{optional_inline}}
    • : A {{jsxref("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 {{jsxref("Promise")}} that resolves with {{jsxref("undefined")}}.

Exceptions

  • InvalidStateError {{domxref("DOMException")}}
    • : Thrown if the document is not fully active.
  • SecurityError {{domxref("DOMException")}}
  • NotAllowedError {{domxref("DOMException")}}
    • : Thrown if {{domxref('PermissionStatus.state')}} is not granted.

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

{{Specifications}}

Browser compatibility

{{Compat}}

See also