This project has been moved to the following monorepo: capawesome-team/capacitor-plugins.
@capawesome/capacitor-badge
Capacitor plugin to access and update the badge number of the app icon.
| Maintainer | GitHub | Social |
|---|---|---|
| Robin Genz | robingenz | @robin_genz |
This is an MIT-licensed open source project. It can grow thanks to the support by these awesome people. If you'd like to join them, please read more here.
npm install @capawesome/capacitor-badge
npx cap syncThis plugin will use the following project variables (defined in your app’s variables.gradle file):
$shortcutBadgerVersionversion ofme.leolin:ShortcutBadger(default:1.1.22)
These configuration values are available:
| Prop | Type | Description | Default |
|---|---|---|---|
persist |
boolean |
Configure whether the plugin should restore the counter after a reboot or app restart. Only available for Android and iOS. | true |
autoClear |
boolean |
Configure whether the plugin should reset the counter after resuming the application. Only available for Android and iOS. | false |
In capacitor.config.json:
{
"plugins": {
"Badge": {
"persist": true,
"autoClear": false
}
}
}In capacitor.config.ts:
/// <reference types="@capawesome/capacitor-badge" />
import { CapacitorConfig } from '@capacitor/cli';
const config: CapacitorConfig = {
plugins: {
Badge: {
persist: true,
autoClear: false,
},
},
};
export default config;A working example can be found here: robingenz/capacitor-plugin-demo
import { Badge } from '@capawesome/capacitor-badge';
const get = async () => {
const result = await Badge.get();
return result.count;
};
const set = async (count: number) => {
await Badge.set({ count });
};
const increase = async () => {
await Badge.increase();
};
const decrease = async () => {
await Badge.decrease();
};
const clear = async () => {
await Badge.clear();
};
const isSupported = async () => {
const result = await Badge.isSupported();
return result.isSupported;
};
const checkPermissions = async () => {
const result = await Badge.checkPermissions();
};
const requestPermissions = async () => {
const result = await Badge.requestPermissions();
};get()set(...)increase()decrease()clear()isSupported()checkPermissions()requestPermissions()- Interfaces
- Type Aliases
get() => Promise<GetBadgeResult>Get the badge count. The badge count won't be lost after a reboot or app restart.
Default: 0.
Returns: Promise<GetBadgeResult>
set(options: SetBadgeOptions) => Promise<void>Set the badge count.
| Param | Type |
|---|---|
options |
SetBadgeOptions |
increase() => Promise<void>Increase the badge count.
decrease() => Promise<void>Decrease the badge count.
clear() => Promise<void>Clear the badge count.
isSupported() => Promise<IsSupportedResult>Check if the badge count is supported.
Returns: Promise<IsSupportedResult>
checkPermissions() => Promise<PermissionStatus>Check permission to display badge.
Returns: Promise<PermissionStatus>
requestPermissions() => Promise<PermissionStatus>Request permission to display badge.
Returns: Promise<PermissionStatus>
| Prop | Type |
|---|---|
count |
number |
| Prop | Type |
|---|---|
count |
number |
| Prop | Type |
|---|---|
isSupported |
boolean |
| Prop | Type | Description |
|---|---|---|
display |
PermissionState |
Permission state of displaying the badge. |
'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'
On Android not all launchers support badges. This plugin uses ShortcutBadger. All supported launchers are listed there.
On Web, the app must run as an installed PWA (in the taskbar or dock).
See CHANGELOG.md.
See LICENSE.
