@capgo/capacitor-shake

Detect when users shake their phone in your Capacitor app, to open feedback, undo an action or reveal a debug menu.

• Shake event: addListener('shake', ...) calls your code on each shake.
• iOS: uses the system shake motion event.
• Android: accelerometer-based detection with a tuned threshold.
• Clean up: remove the listener when you no longer need it.
• Platforms: iOS and Android. Not available on web.

The most complete doc is available here: https://capgo.app/docs/plugins/shake/

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

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

Then use the following prompt:

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

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

npm install @capgo/capacitor-shake
npx cap sync

• addListener('shake', ...)
• getPluginVersion()
• Interfaces

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.

addListener(eventName: 'shake', listenerFunc: () => void) => Promise<PluginListenerHandle>

Listen for shake event on the device.

Registers a listener that will be called whenever a shake gesture is detected. The shake detection uses the device's accelerometer to identify shake patterns.

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor plugin version.

Returns the current version of the native plugin implementation.

Returns: Promise<{ version: string; }>

Since: 1.0.0