电容徽标插件

控制器插件,用于访问并更新应用程序图标的徽标编号.

特征

Capacitor徽标插件是Capacitor App最完整的应用图标徽标解决方案之一. 以下是一些关键特征:

• 🖥️ 跨平台:支持Android,iOS,和Web(PWA).
• 🔢 徽章管理:得到,设置,增加,减少,并清楚警徽计数.
• 💾 持久徽章: 重启或应用程序重新启动后, 徽章计数持续存在 .
• 🔄 自动清除选项:恢复应用时自动重置计数器.
• 🔐 权限处理: 检查并请求徽章显示权限.
• ⚙️ 可配置:自定义持久性和自动清晰的行为.
• 🤝 兼容性: 与 应用图标 财务报告和审定财务报表 火地云通讯 插件 .
• 🔁 最新数据:总是支持最新的Capacitor版本.

缺少一个功能? 刚刚 打开一个问题 我们看看!

使用大小写

徽章插件通常用于显示反映待决项目的应用程序图标上的计数,例如:

• 未读信件: 在应用程序图标上显示未读的聊天消息或电子邮件的数量.
• 待发通知: 保持徽章与用户尚未见到的通知同步.
• 打开任务: 在购物车中显示打开的待办事宜、提醒或项目的数量.
• 自动重置: 当用户使用程序恢复时自动清除计数器 autoClear 配置选项.

兼容性

演示

这里有一个实例: robingenz/电容器-插管-demo

安装

你可以用我们的 AI 辅助设置 以安装插件. 添加数据 超级技能 至您的 AI 工具,使用以下命令:

npx skills add capawesome-team/skills --skill capacitor-plugins

然后使用下列提示:

 Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-badge` plugin in my project.

如果你喜欢 手动设置,通过运行以下命令来安装插件,并遵循下面的平台特定指令:

npm install @capawesome/capacitor-badge
npx cap sync

机器人

变量

如果需要, 您可以在您的应用程序中定义以下工程变量 variables.gradle 要更改依赖的默认版本的文件 :

• $shortcutBadgerVersion 版本 me.leolin:ShortcutBadger (默认 : 1.1.22(中文(简体) )

如果您在工程中遇到其它插件的依赖性冲突, 这会有所帮助 .

iOS系统

隐私表

添加数据 NSPrivacyAccessedAPICategoryUserDefaults 您的字典密钥 隐私宣言 (通常情况) ios/App/PrivacyInfo.xcprivacy:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>NSPrivacyAccessedAPITypes</key>
    <array>
      <!-- Add this dict entry to the array if the file already exists. -->
      <dict>
        <key>NSPrivacyAccessedAPIType</key>
        <string>NSPrivacyAccessedAPICategoryUserDefaults</string>
        <key>NSPrivacyAccessedAPITypeReasons</key>
        <array>
          <string>CA92.1</string>
        </array>
      </dict>
    </array>
  </dict>
</plist>

配置

这些配置值是可用的 :

实例

单位 capacitor.config.json数字 :

{
  "plugins": {
    "Badge": {
      "persist": true,
      "autoClear": false
    }
  }
}

单位 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;

使用量

以下例子显示如何获得,设置,增加,减少,并清除徽章计数,检查徽章是否得到支持,以及检查和请求权限.

获取当前徽章数

读取当前徽章计数 。 重新启动或程序重新启动后, 计数不会丢失 :

import { Badge } from '@capawesome/capacitor-badge';

const get = async () => {
  const result = await Badge.get();
  return result.count;
};

设置徽章数

设置徽章计数为特定值. 在iOS上,将计数设置为 0 将删除徽章并清除所有通知 :

import { Badge } from '@capawesome/capacitor-badge';

const set = async (count: number) => {
  await Badge.set({ count });
};

增加或减少徽章计数

例如,当新信件到达或被读取时,徽章数会增加或减少一个:

import { Badge } from '@capawesome/capacitor-badge';

const increase = async () => {
  await Badge.increase();
};

const decrease = async () => {
  await Badge.decrease();
};

清除徽章计数

从应用程序图标中删除徽章 。 在iOS上,这也将清除所有通知:

import { Badge } from '@capawesome/capacitor-badge';

const clear = async () => {
  await Badge.clear();
};

检查是否支持徽章

检查当前设备是否支持徽标计数, 例如, 并不是每个 Android 发射器都支持徽标 :

import { Badge } from '@capawesome/capacitor-badge';

const isSupported = async () => {
  const result = await Badge.isSupported();
  return result.isSupported;
};

检查和请求权限

检查并请求显示徽章的权限 :

import { Badge } from '@capawesome/capacitor-badge';

const checkPermissions = async () => {
  const result = await Badge.checkPermissions();
};

const requestPermissions = async () => {
  const result = await Badge.requestPermissions();
};

API 密码

• get()
• set(...)
• increase()
• decrease()
• clear()
• isSupported()
• checkPermissions()
• requestPermissions()
• 接口
• 类型异名

获取()

get() => Promise<GetBadgeResult>

得到警徽计数. 重启或应用程序重新启动后,徽章计数不会丢失.

默认 : 0。 。 。 .

回返情况: Promise<GetBadgeResult>

设置(...)

set(options: SetBadgeOptions) => Promise<void>

设出徽记.

增加()

increase() => Promise<void>

增加警徽数.

减少()

decrease() => Promise<void>

减少警徽数.

清除( c)

clear() => Promise<void>

清除警徽计数.

打开 iOS系统,这将移除徽章,并清除所有通知.

已支持 ()

isSupported() => Promise<IsSupportedResult>

检查是否支持徽章计数 .

回返情况: Promise<IsSupportedResult>

检查( )

checkPermissions() => Promise<PermissionStatus>

检查显示徽章的权限 .

回返情况: Promise<PermissionStatus>

请求( )

requestPermissions() => Promise<PermissionStatus>

请求允许显示徽章 .

回返情况: Promise<PermissionStatus>

接口

获取 Badge 报表

设置基准选项

支持的结果

权限状态

类型异名

权限状态

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'

基尔克

打开 机器人 没有官方API来设置徽章,因此并非所有发射器都支持徽章. 此插件使用 快捷键这取决于针对供应商的机制。 所有辅助发射器都列入清单 那边。在库存Android发射器,如像素发射器上,没有显示徽章.

打开 网页,应用程序必须作为安装的PWA(在任务栏或码头)运行.

财务问题

为什么我的Android设备没有显示警徽?

Android没有提供官方API来为发射器图标设置徽章. 此插件因此使用 快捷键 它依赖于一些制造商(如三星、小米、HTC和索尼)提供的供应商专用机制。 只有列入清单的发射器 辅助发射器 可以显示徽章。 在库存的Android发射器上,最出名的是像素发射器,没有显示徽章. 你可以用这个 isSupported() 用于检查当前设备是否支持徽章的方法.

插件能否显示一个 Android 通知徽章( 点) ?

没有。 自Android 8.0起,发射器显示 通知徽章 只在应用程序有 活动 通知。 该徽章出自该通知并一经驳回即消失,因此不能单独设置. 在Android的股票上,它也是一个没有计数的点. 如果您的应用程序已经显示通知, 徽章会自动显示, 没有插件调用 .

重启或应用程序重启后, 徽章计数是否持续 ?

是的, 默认情况下, 徽章计数会在重启或应用程序后恢复 。 您可以通过设置 persist 配置选项到 false,参见 配置 节.

恢复应用时,我怎么自动清除徽章??

设定 autoClear 配置选项到 true 在恢复应用程序后重新设置计数器。 请注意,在iOS上,这也将清除所有通知。 见 配置 节为例.

为什么 checkPermissions() 总是返回 granted 在Android和Web上吗?

只有iOS需要权限才能显示徽章. 在Android和Web上不需要权限,所以权限状态总是 granted。 。 。 .

为什么清除徽章也会删除我在iOS上的通知?

在iOS上,打电话 clear() 或设置徽章计数到 0 删除徽章并清除所有通知。 这是平台行为,不能被插件所改变.

这个插件在网络上工作吗 ?

是的,但应用程序必须作为安装的PWA(在任务栏或码头)运行. 同时检查浏览器是否支持使用 isSupported() 方法.

我能用这个插件吗? 有Ionic、React、Vue或Angular?

是的,插件是框架不可知的。 它在任意网络框架的Capacitor app中工作,包括有Angular,React,或Vue的Ionic,以及平版JavaScript等项目.

相关插件

• 应用图标:运行时更改应用程序图标.
• 应用快捷键: 管理应用快捷键和快速动作.
• 火地云通讯:通过Firebase Cloud Massaging接收按键通知.

通讯

随时更新有关卡帕韦索姆、Capacitor和Ionic生态系统的最新消息和最新消息,因为我们 《卡帕索克通讯》。 。 。 .

更改日志

见 变动情况。 。 。 .

许可证

见 自由主义。 。 。 .

贷项

此插件基于 电容徽章 插件 . 感谢所有为这个项目捐款的人!