SAMPLE APP 👉

Cordova Badge Plugin

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 isn’t running in the foreground.

Note: With v0.7.2 the plugin ID is cordova-plugin-badge

How they appear to the user

Users see notifications in the following ways:

• Badging the app’s icon

Supported Platforms

The current 0.7 branch does support the following platforms:

• Amazon FireOS (deprecated with 0.7.1)
• Android (via ShortcutBadger)
• Browser
• iOS
• Windows
• WP8 and WP8.1 Silverlight (deprecated)

Find out more informations here in our wiki.

Installation

The plugin is installable from source and available on Cordova Plugin Registry and PhoneGap Build.

Find out more informations here in our wiki.

I want to get a quick overview

All wiki pages contain samples, but for a quick overview the sample section may be the fastest way.

Find out more informations here in our wiki.

I want to get a deep overview

The plugin allows you to set, get, clear, increase and decrease the badge number. For Android the plugin offers additional configuration flags.

Find out more about how to set, increase or decrease the badge here.

To get a deep overview we recommend to read about all the topics in this wiki and try out the Kitchen Sink App

I want to see the plugin in action

The plugin offers a kitchen sink sample app. Check out the cordova project and run the app directly from your command line or preferred IDE.

Find out more informations here.

What's new

We are proud to announce our newest release version 0.7.x. Beside the hard work at the office and at the weekends it contains a lot of goodies, new features and easy to use APIs.

Find out more informations here in our wiki.

Sample

The sample demonstrates how to set a fix badge number and how to increase the current badge number.

// Set 10 on device ready
document.addEventListener('deviceready', function () {
    cordova.plugins.notification.badge.set(10);
}, false);

// Increase the badge each time on pause
document.addEventListener('pause', function () {
    cordova.plugins.notification.badge.increase();
}, false);

Find out more informations here in our wiki.

Quirks

On Android not all launchers support badges. In order to set badges we use ShortcutBadger. Check out their website to see which launchers are supported.

If you're using PhoneGap Build please make sure you specify gradle as your Android build tool in config.xml:

<preference name="android-build-tool" value="gradle" />

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

License

This software is released under the Apache 2.0 License.

Made with 😋 from Leipzig

© 2016 appPlant GmbH