Commencer

1. Installez le package

   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. Synchronisation avec les projets natifs

   npm

   npx cap sync

   pnpm

   pnpm cap sync

   yarn

   yarn cap sync

   bun

   bunx cap sync

3. Configurez le plugin

   Basic Usage Example:

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

   Configuration de sensibilité :

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

   iOS

   Aucune configuration supplémentaire requise pour iOS.

   Android

   Aucune configuration supplémentaire requise pour Android.

4. Arrêtez d’écouter les secousses

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

5. Exemple de mise en œuvre

   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 Référence

Methods

start(options?: ShakeOptions)

Commencez à écouter les gestes de secousse.

Paramètres :

• options (facultatif) : Objet de configuration
  • threshold : numéro - Seuil de sensibilité (par défaut : 3,5)

stop()

Arrêtez d’écouter les gestes de secousse.

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

Ajoutez un écouteur pour les événements shake.

Retours : Promesse avec une poignée pour supprimer l’écouteur

Interfaces

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

## Remarques sur la plate-forme

iOS

• Utilise l’accéléromètre de l’appareil pour détecter les gestes de secousse
• Fonctionne au premier plan et en arrière-plan (si l’application dispose d’autorisations en arrière-plan)

Android

• Utilise le SensorManager pour détecter les événements de secousse
• Ne nécessite aucune autorisation spéciale
• Fonctionne lorsque l’application est au premier plan

Cas d’utilisation courants

1. Menu Debug : Afficher les options du développeur lorsque l’appareil est secoué
2. Feedback : Déclenchez un formulaire de commentaires ou un rapport de bug
3. Actualiser : actualisez les données de l’application ou videz le cache
4. Jeux : utilisez Shake comme mécanisme de contrôle du jeu
5. Annuler : implémentez la fonctionnalité secouer pour annuler

Dépannage

Shake not detected:

• Assurez-vous que le plugin est démarré avec Shake.start()
• Essayez d’ajuster la valeur seuil (inférieure = plus sensible)
• Vérifiez que les auditeurs sont correctement enregistrés

Trop sensible/pas assez sensible :

• Ajustez le paramètre threshold dans les options start()
• Les valeurs vont généralement de 2,0 (très sensible) à 5,0 (moins sensible)