快速入门

安装

你可以使用我们的 AI 辅助设置来安装插件。使用以下命令将 Capgo skills 添加到你的 AI 工具中：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下 prompt：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-shake` plugin in my project.

如果你更想手动设置，请运行以下命令安装插件，并按照下方各平台的说明操作：

bun add @capgo/capacitor-shake
bunx cap sync

导入

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

快速入门

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

const listener = await CapacitorShake.addListener('shake', () => {
  openFeedbackSheet();
});

// on logout or route leave
await listener.remove();

示例：在 code 应用中使用节流 (throttle)

Shake 可能连续触发。打开模态框或调用 API 前先做防抖 (debounce)。

常见坑点

• Web 端：通过此插件，移动端浏览器中没有 shake API。
• 清理监听器: 离开页面时请移除监听器，以避免重复触发。
• Android 与 iOS 的差异: 灵敏度有所不同，请在真机上进行测试。

API 概览

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);

单一事实来源

本页面由插件的 src/definitions.ts生成。当上游的公共 API 发生变化时，请重新运行 sync。

从入门指南继续

如果你正在使用 快速入门 要规划 dashboard 和 API 操作，请将其连接到 使用 @capgo/capacitor-shake 在使用 @capgo/capacitor-shake 时，获取原生能力的方法： API 概览 关于 API Overview 中的实现细节， 简介 关于 Introduction 中的实现细节， API 密钥 有关 API Keys 的实现细节，以及 设备 有关 Devices 的实现细节。