スタートガイド

インストール

AIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いのAIツールに Capgo のスキルを追加してください：

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

次に、以下のプロンプトを使用します：

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 でのスロットル

Shake は連続して発火することがあります。モーダルを開く前や API を呼ぶ前にデバウンスしてください。

よくある落とし穴

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

Source of Truth

このページはプラグインの src/definitions.tsから生成されています。upstream で公開 API が変更されたら、再度 sync を実行してください。

Getting Startedの続きを進める

使用している場合 スタートガイド ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-shakeの使い方 「@capgo/capacitor-shakeの使い方」のネイティブ機能については、 API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー および「API Keys」の実装の詳細については、 デバイス 実装の詳細については Devices を参照してください。