Prise en main

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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

Si vous préférez une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

bun add @capgo/capacitor-shake
bunx cap sync

Importer

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

Démarrage rapide

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

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

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

Exemple : throttle dans l'app code

Shake peut se déclencher par rafales. Appliquez un debounce avant d’ouvrir des modales ou d’appeler des API.

Erreurs courantes

• Le Web: il n’y a pas de shake API dans les navigateurs mobiles via ce plugin.
• Nettoyage des listeners : supprimez les listeners en quittant l'écran pour éviter les handlers en double.
• Android vs iOS : la sensibilité diffère, testez sur un appareil réel.

Aperçu de API

addListener

Écoutez l'événement de secousse sur l'appareil.

Enregistre un listener qui sera appelé dès qu'un geste de secousse est détecté. La détection de secousse utilise l'accéléromètre de l'appareil pour identifier les patterns de secousse.

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

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

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

getPluginVersion

Récupère la version du plugin natif Capacitor.

Renvoie la version actuelle de l'implémentation du plugin natif.

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

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

Source de vérité

Cette page est générée à partir de src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Continuer depuis Getting Started

Si vous utilisez Prise en main pour planifier les opérations du dashboard et de API, connectez-l’avec Utilisation de @capgo/capacitor-shake pour la fonctionnalité native dans « Utiliser @capgo/capacitor-shake », Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'introduction, Clés API pour les détails d'implémentation dans « Clés API », et Appareils pour les détails d'implémentation dans Devices.