Skip to main content
Capgo logo
← Back To Plugins

Using @capgo/capacitor-shake

Capacitor Shake Plugin interface for detecting shake gestures on mobile devices. This plugin allows you to listen for shake events and get plugin version information.

Install

bun add @capgo/capacitor-shake
bunx cap sync

What This Plugin Exposes

  • addListener - Listen for shake event on the device.
  • getPluginVersion - Get the native Capacitor plugin version.

Example Usage

addListener

Listen for shake event on the device.

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

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

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

getPluginVersion

Get the native Capacitor plugin version.

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

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

Full Reference