Skip to content
Capgo - Build, ship, and update Capacitor apps Capgo

@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.
Get started GitHub

Overview

Section titled “Overview”

@capgo/capacitor-shake listens for device shake gestures so you can trigger undo, feedback forms, or hidden debug menus without extra UI chrome. iOS uses the system shake motion event; Android uses accelerometer thresholds tuned for pocket false positives.

Platform support

Section titled “Platform support”
PlatformSupport
iOSYes
AndroidYes
WebNo

Core Capabilities

Section titled “Core Capabilities”
  • addListener - Listen for shake event on the device.
  • getPluginVersion - Get the native Capacitor plugin version.

Public API

Section titled “Public API”
MethodDescription
addListenerListen for shake event on the device.
getPluginVersionGet the native Capacitor plugin version.

Source Of Truth

Section titled “Source Of Truth”

This reference is synced from src/definitions.ts in capacitor-shake.

Keep going from @capgo/capacitor-shake

Section titled “Keep going from @capgo/capacitor-shake”

If you are using @capgo/capacitor-shake to plan dashboard and API operations, connect it with Using @capgo/capacitor-shake for the native capability in Using @capgo/capacitor-shake, API Overview for the implementation detail in API Overview, Introduction for the implementation detail in Introduction, API Keys for the implementation detail in API Keys, and Devices for the implementation detail in Devices.