@capgo/capacitor-shake

➡️ Get Instant updates for your App with Capgo

Missing a feature? We’ll build the plugin for you 💪

Detect shake gesture in device

Documentation

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

Compatibility

Plugin version	Capacitor compatibility	Maintained
v8.*.*	v8.*.*	✅
v7.*.*	v7.*.*	On demand
v6.*.*	v6.*.*	❌
v5.*.*	v5.*.*	❌

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.

Install

npm install @capgo/capacitor-shake
npx cap sync

API

• 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('shake', ...)

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.

Param	Type	Description
eventName	'shake'	The shake change event name. Must be 'shake'.
listenerFunc	() => void	Callback function invoked when the phone is shaken.

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

---

getPluginVersion()

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

---

Interfaces

PluginListenerHandle

Prop	Type
remove	() => Promise<void>