跳转至正文
@capgo/capacitor-shake 设备 API 开源

摇一摇 Capacitor 插件

检测设备上的摇晃手势,用于触发撤销或反馈等操作

安装

bun add @capgo/capacitor-shake bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-shake
  • pnpm add @capgo/capacitor-shake
  • yarn add @capgo/capacitor-shake

指南

如何在 Capacitor 中使用 Shake

在设备上测试

下载 Capgo App,然后扫描二维码 code。

Shake 插件预览二维码 code

使用 @capgo/capacitor-shake

Capacitor Shake 插件用于检测移动设备上的摇晃手势。通过该插件,你可以监听摇晃事件并获取插件版本信息。

安装

bun add @capgo/capacitor-shake
bunx cap sync

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

import { CapacitorShake } from '@capgo/capacitor-shake';

API 概览

方法 描述
addListener 监听设备的摇晃事件。
getPluginVersion 获取原生 Capacitor 插件版本。

示例

addListener()

监听设备的摇晃事件。

import { CapacitorShake } from '@capgo/capacitor-shake';

const listener = await CapacitorShake.addListener('shake', () => {
  console.log('Shake detected!');
});

// To remove the listener:
await listener.remove();

getPluginVersion()

获取原生 Capacitor 插件版本。

import { CapacitorShake } from '@capgo/capacitor-shake';

const { version } = await CapacitorShake.getPluginVersion();
console.log('Plugin version:', version);

监听事件

addListener 会返回一个句柄。调用 handle.remove() 当屏幕卸载时。

完整参考文档

继续阅读:使用 @capgo/capacitor-shake

如果你正在使用 使用 @capgo/capacitor-shake 要规划原生插件工作,请将其与 @capgo/capacitor-shake 有关 @capgo/capacitor-shake 的实现细节, 快速入门 有关“入门指南”中的实现细节, Capgo 插件目录 查看 Capgo 插件目录中的产品工作流, Capgo 提供的 Capacitor 插件 有关 Capgo 开发的 Capacitor 插件的实现细节,以及 添加或更新插件 有关添加或更新插件的实现细节。

常见问题

Shake 插件常见问题

如何在 Capacitor 应用中安装 Shake 插件?

运行 "bun add @capgo/capacitor-shake"(或 "npm install @capgo/capacitor-shake"),然后运行 "bunx cap sync",让 iOS 和 Android 项目加载原生 code。再在应用的 code 中从 "@capgo/capacitor-shake" 导入。

@capgo/capacitor-shake 支持 React、Vue 和 Angular 吗?

支持。Shake 是一个 Capacitor 包,所以任何运行在 Capacitor 里的 Web 框架都能用,包括 Ionic、React、Vue、Angular、Svelte 和纯 JavaScript。

@capgo/capacitor-shake 支持哪个 Capacitor 版本?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-shake 是免费开源的吗?

是的。code 源码已在 GitHub 公开,地址是 https://github.com/Cap-go/capacitor-shake/,也可以从 npm 免费安装。欢迎提交 Bug 报告和 Pull Request。

不经过 App Store 审核,也能更新使用了 Shake 的 code 吗?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待 App 审核,即可即时发布 Shake 更新

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo