awesome-cordova-plugins/docs/plugins/badge.md
2021-09-29 13:46:28 +00:00

25 lines
1.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Badge
```text
$ ionic cordova plugin add cordova-plugin-badge
$ npm install @awesome-cordova-plugins/badge
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/badge/)
Plugin Repo: [https://github.com/katzer/cordova-plugin-badge](https://github.com/katzer/cordova-plugin-badge)
The essential purpose of badge numbers is to enable an application to inform its users that it has something for them — for example, unread messages — when the application isnt running in the foreground.
Requires Cordova plugin: cordova-plugin-badge. For more info, please see the [Badge plugin docs](https://github.com/katzer/cordova-plugin-badge).
Android Note: Badges have historically only been a feature implemented by third party launchers and not visible unless one of those launchers was being used \(E.G. Samsung or Nova Launcher\) and if enabled by the user. As of Android 8 \(Oreo\), [notification badges](https://developer.android.com/training/notify-user/badges) were introduced officially to reflect unread notifications. This plugin is unlikely to work as expected on devices running Android 8 or newer. Please see the [local notifications plugin docs](https://github.com/katzer/cordova-plugin-local-notifications) for more information on badge use with notifications.
## Supported platforms
* Android
* Browser
* iOS
* Windows