Memulai

1. Instal paket

   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. Sinkronkan dengan proyek native

   npm

   npx cap sync

   pnpm

   pnpm cap sync

   yarn

   yarn cap sync

   bun

   bunx cap sync

3. Konfigurasi plugin

   Contoh Penggunaan Dasar:

   import { Shake } from '@capgo/capacitor-shake';
   
   // Mulai mendengarkan gerakan shake
   await Shake.start();
   
   // Dengarkan event shake
   Shake.addListener('shake', () => {
     console.log('Perangkat digoyangkan!');
     // Lakukan aksi Anda di sini
   });

   Konfigurasi Sensitivitas:

   // Konfigurasi sensitivitas shake
   await Shake.start({
     threshold: 3.5 // Sesuaikan sensitivitas (default: 3.5)
   });

   iOS

   Tidak diperlukan pengaturan tambahan untuk iOS.

   Android

   Tidak diperlukan pengaturan tambahan untuk Android.

4. Hentikan mendengarkan shake

   // Hentikan deteksi shake ketika tidak diperlukan
   await Shake.stop();
   
   // Hapus listener spesifik
   const handle = await Shake.addListener('shake', () => {
     console.log('Digoyangkan!');
   });
   handle.remove();

5. Contoh implementasi

   import { Shake } from '@capgo/capacitor-shake';
   import { App } from '@capacitor/app';
   
   export class ShakeService {
     private shakeListener: any;
   
     async initialize() {
       // Mulai deteksi shake
       await Shake.start({ threshold: 4.0 });
   
       // Tambahkan shake listener
       this.shakeListener = await Shake.addListener('shake', () => {
         this.handleShake();
       });
   
       // Bersihkan saat aplikasi dijeda
       App.addListener('pause', () => {
         Shake.stop();
       });
   
       // Lanjutkan saat aplikasi dilanjutkan
       App.addListener('resume', () => {
         Shake.start({ threshold: 4.0 });
       });
     }
   
     private handleShake() {
       console.log('Shake terdeteksi!');
       // Tampilkan menu debug, refresh data, atau picu aksi apapun
     }
   
     async cleanup() {
       if (this.shakeListener) {
         this.shakeListener.remove();
       }
       await Shake.stop();
     }
   }

Referensi API

Methods

start(options?: ShakeOptions)

Mulai mendengarkan gerakan shake.

Parameter:

• options (opsional): Objek konfigurasi
  • threshold: number - Ambang sensitivitas (default: 3.5)

stop()

Hentikan mendengarkan gerakan shake.

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

Tambahkan listener untuk event shake.

Mengembalikan: Promise dengan handle untuk menghapus listener

Interfaces

interface ShakeOptions {
  threshold?: number; // Ambang sensitivitas shake
}

Catatan Platform

iOS

• Menggunakan accelerometer perangkat untuk mendeteksi gerakan shake
• Bekerja di foreground dan background (jika aplikasi memiliki izin background)

Android

• Menggunakan SensorManager untuk mendeteksi event shake
• Tidak memerlukan izin khusus
• Bekerja ketika aplikasi di foreground

Kasus Penggunaan Umum

1. Menu Debug: Tampilkan opsi developer ketika perangkat digoyangkan
2. Feedback: Picu formulir feedback atau laporan bug
3. Refresh: Refresh data aplikasi atau bersihkan cache
4. Games: Gunakan shake sebagai mekanisme kontrol game
5. Undo: Implementasikan fungsionalitas shake-to-undo

Pemecahan Masalah

Shake tidak terdeteksi:

• Pastikan plugin dimulai dengan Shake.start()
• Coba sesuaikan nilai threshold (lebih rendah = lebih sensitif)
• Periksa bahwa listener terdaftar dengan benar

Terlalu sensitif/tidak cukup sensitif:

• Sesuaikan parameter threshold di opsi start()
• Nilai biasanya berkisar dari 2.0 (sangat sensitif) hingga 5.0 (kurang sensitif)