Navigator: clearAppBadge() method

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

The clearAppBadge() method of the Navigator interface clears a badge on the current app's icon by setting it to nothing. The value nothing indicates that no badge is currently set, and the status of the badge is cleared.

Syntax

js
clearAppBadge()

Parameters

None.

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 PermissionStatus.state is not granted.

Examples

Once all messages in an application have been read, call clearAppBadge() to clear the badge and remove the notification.

js
navigator.clearAppBadge();

Specifications

Specification
Badging API
# clearappbadge-method

Browser compatibility

BCD tables only load in the browser

See also