Capacitor Badge Plugin

Installation

npm i capacitor-badge-plugin --save

Usage

import 'capacitor-badge-plugin';
import { Plugins } from '@capacitor/core';

const { Badge } = Plugins;

function updateBadgeCount() {
  Badge.hasPermission()
    .then(value => (value.success ? value : Badge.requestPermission()))
    .then(res => (res.success ? Badge.setBadgeCount({ count: 12 }) : res));
}

It’s important to also add the import line: import 'capacitor-badge-plugin'; (as specified in the package.json) because this will actually trigger the web registration of your plugin – otherwise the web part of it won’t work!

Android

Register the badge plugin in your Capacitor app in the MainActivity.java.

// Other imports...
import com.seppedev.plugins.badge.Badge; // << #1 Add import

public class MainActivity extends BridgeActivity {

  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // Initializes the Bridge
    this.init(
        savedInstanceState,
        new ArrayList<Class<? extends Plugin>>() {
          {
            // Additional plugins you've installed go here
            add(Badge.class); // << #2 Register plugin
          }
        }
      );
  }
}

Api

Method	Parameters	Return Type
hasPermission	null	Promise<{success:boolean}>
requestPermission	null	Promise<{success:boolean}>
setBadgeCount	{count: number}	Promise<{success:boolean, value: number}>
clearBadgeCount	null	Promise<{success:boolean}>

Building

To build the plugin locally it's important to run npm run build everytime you change something in the capacitor-badge-plugin directory. After that always run npx cap sync in the demo app to use the latest version of the plugin. Or use

$ cd demo
$ ng build && npx cap sync && npx cap copy ios && npx cap open ios`

Info

Package is based on Fancy-Notifications.

Pull requests are welcome.