はじめる

1. パッケージをインストールします

   npm

   npm i @capgo/capacitor-shake

   pnpm

   pnpm add @capgo/capacitor-shake

   yarn

   yarn add @capgo/capacitor-shake

   bun

   bun add @capgo/capacitor-shake

2. ネイティブ プロジェクトと同期

   npm

   npx cap sync

   pnpm

   pnpm cap sync

   yarn

   yarn cap sync

   bun

   bunx cap sync

3. プラグインを設定します

   基本的な使用例:

   import { Shake } from '@capgo/capacitor-shake';
   
   // Start listening for shake gestures
   await Shake.start();
   
   // Listen for shake events
   Shake.addListener('shake', () => {
     console.log('Device was shaken!');
     // Perform your action here
   });

   感度設定:

   // Configure shake sensitivity
   await Shake.start({
     threshold: 3.5 // Adjust sensitivity (default: 3.5)
   });

   iOS

   iOS には追加の設定は必要ありません。

   Android

   Android には追加の設定は必要ありません。

4. 揺れを聞くのをやめる

   // Stop shake detection when not needed
   await Shake.stop();
   
   // Remove specific listener
   const handle = await Shake.addListener('shake', () => {
     console.log('Shaken!');
   });
   handle.remove();

5. 実装例

   import { Shake } from '@capgo/capacitor-shake';
   import { App } from '@capacitor/app';
   
   export class ShakeService {
     private shakeListener: any;
   
     async initialize() {
       // Start shake detection
       await Shake.start({ threshold: 4.0 });
   
       // Add shake listener
       this.shakeListener = await Shake.addListener('shake', () => {
         this.handleShake();
       });
   
       // Clean up on app pause
       App.addListener('pause', () => {
         Shake.stop();
       });
   
       // Resume on app resume
       App.addListener('resume', () => {
         Shake.start({ threshold: 4.0 });
       });
     }
   
     private handleShake() {
       console.log('Shake detected!');
       // Show debug menu, refresh data, or trigger any action
     }
   
     async cleanup() {
       if (this.shakeListener) {
         this.shakeListener.remove();
       }
       await Shake.stop();
     }
   }

API リファレンス

メソッド

start(options?: ShakeOptions)

シェイクジェスチャーを聞き始めます。

パラメータ:

• options (オプション): 設定オブジェクト
  • threshold: 数値 - 感度のしきい値 (デフォルト: 3.5)

stop()

シェイクジェスチャーを聞くのをやめてください。

addListener('shake', callback: () => void)

シェイクイベントのリスナーを追加します。

戻り値: リスナーを削除するハンドルを指定した Promise

インターフェース

interface ShakeOptions {
  threshold?: number; // Shake sensitivity threshold
}

プラットフォームに関する注意事項

iOS

• デバイスの加速度計を使用してシェイク ジェスチャを検出します
• フォアグラウンドとバックグラウンドの両方で動作します (アプリにバックグラウンド権限がある場合)

Android

• SensorManager を使用してシェイク イベントを検出します
• 特別な権限は必要ありません
• アプリがフォアグラウンドにあるときに動作します

一般的な使用例

1. デバッグ メニュー: デバイスをシェイクしたときに開発者向けオプションを表示します
2. フィードバック: フィードバック フォームまたはバグ レポートをトリガーします。
3. 更新: アプリのデータを更新するか、キャッシュをクリアします
4. ゲーム: ゲーム制御メカニズムとしてシェイクを使用する
5. 元に戻す: シェイクして元に戻す機能を実装します。

トラブルシューティング

シェイクが検出されませんでした:

• プラグインが Shake.start() で開始されていることを確認してください
• しきい値を調整してみてください (低いほど感度が高くなります)
• リスナーが正しく登録されていることを確認します

敏感すぎる/十分に敏感ではない:

• start() オプションの threshold パラメータを調整します
• 値の範囲は通常、2.0 (非常に敏感) から 5.0 (あまり敏感ではない) です。