--- description: Capacitor plugin to detect physical shake gestures on the device with configurable sensitivity on Android and iOS. title: Capacitor Shake Plugin for Android & iOS - Capawesome image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/shake.png --- [Skip to content ](#capacitor-shake-plugin) [πŸ“² Introducing **Build Sharing** β€” get your builds onto testers' devices with a link & QR code. No account required. ](/blog/share-mobile-app-builds-with-testers/) * [ SDKs ](/docs/sdks/) * [ Formbricks ](/docs/sdks/capacitor/formbricks/) * [ Geocoder ](/docs/sdks/capacitor/geocoder/) * [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/) * [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/) * [ Gyroscope ](/docs/sdks/capacitor/gyroscope/) * [ Haptics ](/docs/sdks/capacitor/haptics/) * [ Home Indicator ](/docs/sdks/capacitor/home-indicator/) * [ In-App Browser ](/docs/sdks/capacitor/in-app-browser/) * [ Install Referrer ](/docs/sdks/capacitor/install-referrer/) * [ Intercom ](/docs/sdks/capacitor/intercom/) * [ Intune ](/docs/sdks/capacitor/intune/) * [ Keep Awake ](/docs/sdks/capacitor/keep-awake/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Light Sensor ](/docs/sdks/capacitor/light-sensor/) * [ Live Update ](/docs/sdks/capacitor/live-update/) * [ Localization ](/docs/sdks/capacitor/localization/) * [ Mail Composer ](/docs/sdks/capacitor/mail-composer/) * [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/) * [ Maps Launcher ](/docs/sdks/capacitor/maps-launcher/) * [ Media Session ](/docs/sdks/capacitor/media-session/) * [ ML Kit ](/docs/sdks/capacitor/mlkit/) * [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/) * [ Network ](/docs/sdks/capacitor/network/) * [ NFC ](/docs/sdks/capacitor/nfc/) * [ Node.js ](/docs/sdks/capacitor/nodejs/) * [ OAuth ](/docs/sdks/capacitor/oauth/) * [ Passkeys ](/docs/sdks/capacitor/passkeys/) * [ Password Autofill ](/docs/sdks/capacitor/password-autofill/) * [ PDF Generator ](/docs/sdks/capacitor/pdf-generator/) * [ PDF Viewer ](/docs/sdks/capacitor/pdf-viewer/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Permissions ](/docs/sdks/capacitor/permissions/) * [ Phone Dialer ](/docs/sdks/capacitor/phone-dialer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ Photo Manipulator ](/docs/sdks/capacitor/photo-manipulator/) * [ PixLive ](/docs/sdks/capacitor/pixlive/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Privacy Screen ](/docs/sdks/capacitor/privacy-screen/) * [ Proximity Sensor ](/docs/sdks/capacitor/proximity-sensor/) * [ Purchases ](/docs/sdks/capacitor/purchases/) * [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ Root Detection ](/docs/sdks/capacitor/root-detection/) * [ Screen Brightness ](/docs/sdks/capacitor/screen-brightness/) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * [ Screen Reader ](/docs/sdks/capacitor/screen-reader/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ Settings Launcher ](/docs/sdks/capacitor/settings-launcher/) * Shake [ Shake ](/docs/sdks/capacitor/shake/) * [ API ](#api) * [ Type Aliases ](#type-aliases) * [ Sensitivity Levels ](#sensitivity-levels) * [ FAQ ](#faq) * [ Related Plugins ](#related-plugins) * [ Newsletter ](#newsletter) * [ Changelog ](#changelog) * [ License ](#license) * [ Silent Mode ](/docs/sdks/capacitor/silent-mode/) * [ SIM ](/docs/sdks/capacitor/sim/) * [ SMS Composer ](/docs/sdks/capacitor/sms-composer/) * [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/) * [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/) * [ Share Target ](/docs/sdks/capacitor/share-target/) * [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/) * [ SQLite ](/docs/sdks/capacitor/sqlite/) * [ Superwall ](/docs/sdks/capacitor/superwall/) * [ System WebView ](/docs/sdks/capacitor/system-webview/) * [ Tauri ](/docs/sdks/capacitor/tauri/) * [ Text Interaction ](/docs/sdks/capacitor/text-interaction/) * [ Text Zoom ](/docs/sdks/capacitor/text-zoom/) * [ Thermal State ](/docs/sdks/capacitor/thermal-state/) * [ Toast ](/docs/sdks/capacitor/toast/) * [ Torch ](/docs/sdks/capacitor/torch/) * [ Vault ](/docs/sdks/capacitor/vault/) * [ Volume ](/docs/sdks/capacitor/volume/) * [ Wallet ](/docs/sdks/capacitor/wallet/) * [ Wifi ](/docs/sdks/capacitor/wifi/) * [ YouTube Player ](/docs/sdks/capacitor/youtube-player/) * [ Zip ](/docs/sdks/capacitor/zip/) * [ Cordova ](/docs/sdks/cordova/) * [ Cloud ](/docs/cloud/) * [ Integrations ](/docs/cloud/live-updates/integrations/) * Concepts * Reference * [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/) * [ FAQ ](/docs/cloud/live-updates/faq/) * [ Native Builds ](/docs/cloud/native-builds/) * [ Set Up Environments ](/docs/cloud/native-builds/environments/) * [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/) * [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/) * [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/) * [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/) * [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/) * [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/) * [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/) * [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/) * [ Build without Git ](/docs/cloud/native-builds/build-without-git/) * [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/) * [ Integrations ](/docs/cloud/native-builds/integrations/) * Reference * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ FAQ ](/docs/cloud/native-builds/faq/) * [ App Store Publishing ](/docs/cloud/app-store-publishing/) * [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/) * [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/) * [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/) * [ FAQ ](/docs/cloud/app-store-publishing/faq/) * [ Automations ](/docs/cloud/automations/) * [ Reference ](/docs/cloud/automations/reference/) * [ Troubleshooting ](/docs/cloud/automations/troubleshooting/) * [ FAQ ](/docs/cloud/automations/faq/) * [ Assist ](/docs/cloud/assist/) * [ CLI ](/docs/cloud/cli/) * APIs and SDKs * [ Webhooks ](/docs/cloud/webhooks/) * [ Integrations ](/docs/cloud/integrations/) * Notifications * Account * [ Organization ](/docs/cloud/organizations/) * [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/) * [ Audit Logs ](/docs/cloud/organizations/audit-logs/) * [ Billing ](/docs/cloud/organizations/billing/) * [ License Keys ](/docs/cloud/license-keys/) * [ AI ](/docs/ai/) * [ Insiders ](/docs/insiders/) * [ Billing & Plans ](/docs/insiders/billing-and-plans/) * [ FAQ ](/docs/insiders/faq/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/support/) * [ Contributing ](/docs/contributing/) * Contributing code * [ Code of Conduct ](/docs/contributing/code-of-conduct/) * [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion) * [ Blog ](/blog/) * Categories * [ API ](#api) * [ Type Aliases ](#type-aliases) * [ Sensitivity Levels ](#sensitivity-levels) * [ FAQ ](#faq) * [ Related Plugins ](#related-plugins) * [ Newsletter ](#newsletter) * [ Changelog ](#changelog) * [ License ](#license) # Capacitor Shake Plugin[ΒΆ](#capacitor-shake-plugin "Permanent link") Capacitor plugin to detect shake gestures. [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Features[ΒΆ](#features "Permanent link") * πŸ“³ **Shake detection**: Detect physical shake gestures on the device. * 🎚️ **Sensitivity**: Configure how strong a shake must be to trigger an event. * πŸ”‹ **Battery-friendly**: The sensor is only active while you are watching for shakes. * πŸ“± **Cross-platform**: One consistent API for Android and iOS. * 🀝 **Compatibility**: Works alongside the [Accelerometer](https://capawesome.io/docs/sdks/capacitor/accelerometer/), [Gyroscope](https://capawesome.io/docs/sdks/capacitor/gyroscope/) and [Haptics](https://capawesome.io/docs/sdks/capacitor/haptics/) plugins. * πŸ” **Up-to-date**: Always supports the latest Capacitor version. Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look! ## Use Cases[ΒΆ](#use-cases "Permanent link") The Shake plugin is typically used to trigger an action when the user shakes the device, for example: * **Feedback and bug reporting**: Let users shake the device to open a feedback or bug report dialog. * **Debug menus**: Open a hidden developer or debug menu in internal builds when the device is shaken. * **Undo actions**: Offer a shake-to-undo interaction, a gesture many users already know from iOS. * **Refresh content**: Reload data or shuffle content when a shake gesture is detected. ## Compatibility[ΒΆ](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 0.x.x | \>=8.x.x | Active support | ## Guides[ΒΆ](#guides "Permanent link") * [The Complete Guide to Capacitor Device Sensors](https://capawesome.io/blog/capacitor-device-sensors-guide/): How shake gestures relate to the Accelerometer and Gyroscope for shake-to-undo and shake-to-reroll interactions. ## Installation[ΒΆ](#installation "Permanent link") You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-1-1) Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-shake` plugin in my project. `` If you prefer **Manual Setup**, install the plugin by running the following command: `[](#%5F%5Fcodelineno-2-1)npm install @capawesome/capacitor-shake [](#%5F%5Fcodelineno-2-2)npx cap sync ` This plugin is available on **Android** and **iOS**. On Web, all methods reject as unimplemented. No additional permissions or privacy descriptions are required. ## Configuration[ΒΆ](#configuration "Permanent link") No configuration required for this plugin. ## Usage[ΒΆ](#usage "Permanent link") The following examples show how to detect shake gestures and stop detecting them. ### Detect shake gestures[ΒΆ](#detect-shake-gestures "Permanent link") Attach a `shake` listener and start watching for shake gestures. Use the `sensitivity` option to control how strong a shake must be to trigger an event (see [Sensitivity Levels](#sensitivity-levels)). Only available on Android and iOS: `[](#%5F%5Fcodelineno-3-1)import { Shake } from '@capawesome/capacitor-shake'; [](#%5F%5Fcodelineno-3-2) [](#%5F%5Fcodelineno-3-3)const startWatching = async () => { [](#%5F%5Fcodelineno-3-4) await Shake.addListener('shake', () => { [](#%5F%5Fcodelineno-3-5) console.log('Shake detected!'); [](#%5F%5Fcodelineno-3-6) }); [](#%5F%5Fcodelineno-3-7) await Shake.startWatching({ sensitivity: 'medium' }); [](#%5F%5Fcodelineno-3-8)}; ` ### Stop detecting shake gestures[ΒΆ](#stop-detecting-shake-gestures "Permanent link") Stop watching and remove all listeners when you no longer need shake detection, for example when the user leaves the corresponding screen. The sensor is only active while you are watching, so this keeps the plugin battery-friendly: `[](#%5F%5Fcodelineno-4-1)import { Shake } from '@capawesome/capacitor-shake'; [](#%5F%5Fcodelineno-4-2) [](#%5F%5Fcodelineno-4-3)const stopWatching = async () => { [](#%5F%5Fcodelineno-4-4) await Shake.stopWatching(); [](#%5F%5Fcodelineno-4-5) await Shake.removeAllListeners(); [](#%5F%5Fcodelineno-4-6)}; ` ## API[ΒΆ](#api "Permanent link") * [startWatching(...)](#startwatching) * [stopWatching()](#stopwatching) * [addListener('shake', ...)](#addlistenershake-) * [removeAllListeners()](#removealllisteners) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) ### startWatching(...)[ΒΆ](#startwatching "Permanent link") `[](#%5F%5Fcodelineno-5-1)startWatching(options?: StartWatchingOptions | undefined) => Promise ` Start watching for shake gestures. Only available on Android and iOS. | Param | Type | | ----------- | --------------------------------------------- | | **options** | [StartWatchingOptions](#startwatchingoptions) | **Since:** 0.1.0 --- ### stopWatching()[ΒΆ](#stopwatching "Permanent link") `[](#%5F%5Fcodelineno-6-1)stopWatching() => Promise ` Stop watching for shake gestures. Only available on Android and iOS. **Since:** 0.1.0 --- ### addListener('shake', ...)[ΒΆ](#addlistenershake "Permanent link") `[](#%5F%5Fcodelineno-7-1)addListener(eventName: 'shake', listenerFunc: () => void) => Promise ` Called when a shake gesture is detected. Only available on Android and iOS. | Param | Type | | ---------------- | ---------- | | **eventName** | 'shake' | | **listenerFunc** | () => void | **Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>` **Since:** 0.1.0 --- ### removeAllListeners()[ΒΆ](#removealllisteners "Permanent link") `[](#%5F%5Fcodelineno-8-1)removeAllListeners() => Promise ` Remove all listeners for this plugin. **Since:** 0.1.0 --- ### Interfaces[ΒΆ](#interfaces "Permanent link") #### StartWatchingOptions[ΒΆ](#startwatchingoptions "Permanent link") | Prop | Type | Description | Default | Since | | --------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----- | | **sensitivity** | [Sensitivity](#sensitivity) | The sensitivity of the shake detection. Use 'light' to detect gentle shakes and 'hard' to only detect strong shakes. Only available on Android and iOS. | 'medium' | 0.1.0 | #### PluginListenerHandle[ΒΆ](#pluginlistenerhandle "Permanent link") | Prop | Type | | ---------- | ------------------- | | **remove** | () => Promise | ### Type Aliases[ΒΆ](#type-aliases "Permanent link") #### Sensitivity[ΒΆ](#sensitivity "Permanent link") `'hard' | 'light' | 'medium'` ## Sensitivity Levels[ΒΆ](#sensitivity-levels "Permanent link") The `sensitivity` option controls how strong a shake must be to emit a `shake` event: * `light`: A gentle shake is enough to trigger an event. * `medium`: A moderate shake is required to trigger an event (default). * `hard`: Only a strong shake triggers an event. ## FAQ[ΒΆ](#faq "Permanent link") ### How is this plugin different from other similar plugins?[ΒΆ](#how-is-this-plugin-different-from-other-similar-plugins "Permanent link") It focuses on doing one thing well: detecting physical shake gestures on Android and iOS through a single, fully typed API. You can tune how strong a shake must be with three sensitivity levels, and the motion sensor only runs between `startWatching(...)` and `stopWatching()`, so it stays battery-friendly. It is actively maintained against the latest Capacitor version, giving you consistent shake behavior on both platforms from one dependency. ### Which platforms are supported by the Shake plugin?[ΒΆ](#which-platforms-are-supported-by-the-shake-plugin "Permanent link") The plugin is available on Android and iOS. On the Web, all methods reject as unimplemented, since browsers do not provide a comparable shake detection API. ### Does shake detection drain the battery?[ΒΆ](#does-shake-detection-drain-the-battery "Permanent link") No, the plugin is designed to be battery-friendly. The motion sensor is only active between `startWatching(...)` and `stopWatching()`, so no sensor data is processed while you are not watching for shakes. Remember to call `stopWatching()` and `removeAllListeners()` when you no longer need shake detection. ### How can I control how strong a shake must be?[ΒΆ](#how-can-i-control-how-strong-a-shake-must-be "Permanent link") Pass the `sensitivity` option to `startWatching(...)`. Use `light` to detect gentle shakes, `medium` (the default) for moderate shakes, or `hard` to only detect strong shakes. See [Sensitivity Levels](#sensitivity-levels) for details. ### Do I need any permissions to detect shake gestures?[ΒΆ](#do-i-need-any-permissions-to-detect-shake-gestures "Permanent link") No, the plugin does not require any additional permissions or privacy descriptions on Android or iOS. You can install it and start watching for shake gestures right away. ### Can I use this plugin with Ionic, React, Vue or Angular?[ΒΆ](#can-i-use-this-plugin-with-ionic-react-vue-or-angular "Permanent link") Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects. ## Related Plugins[ΒΆ](#related-plugins "Permanent link") * [Accelerometer](https://capawesome.io/docs/sdks/capacitor/accelerometer/): Capture the acceleration force along the x, y, and z axes. * [Gyroscope](https://capawesome.io/docs/sdks/capacitor/gyroscope/): Read the device's gyroscope sensor. * [Haptics](https://capawesome.io/docs/sdks/capacitor/haptics/): Provide haptic feedback such as impacts, notifications, and vibrations. ## Newsletter[ΒΆ](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Changelog[ΒΆ](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/shake/CHANGELOG.md). ## License[ΒΆ](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/shake/LICENSE). July 8, 2026 Back to top ```json {"@context": "https://schema.org", "@graph": [{"@type": "TechArticle", "@id": "https://capawesome.io/docs/sdks/capacitor/shake/#article", "headline": "Capacitor Shake Plugin for Android & iOS", "name": "Capacitor Shake Plugin for Android & iOS", "description": "Capacitor plugin to detect physical shake gestures on the device with configurable sensitivity on Android and iOS.", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/shake/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/shake/", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "about": {"@id": "https://capawesome.io/docs/sdks/capacitor/shake/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/shake/#software", "name": "Capacitor Shake Plugin for Android & iOS", "description": "Capacitor plugin to detect physical shake gestures on the device with configurable sensitivity on Android and iOS.", "url": "https://capawesome.io/docs/sdks/capacitor/shake/", "programmingLanguage": "TypeScript", "runtimePlatform": "Capacitor", "codeRepository": "https://github.com/capawesome-team", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}}]} {"@context": "https://schema.org", "@type": "FAQPage", "mainEntity": [{"@type": "Question", "name": "How is this plugin different from other similar plugins?", "acceptedAnswer": {"@type": "Answer", "text": "It focuses on doing one thing well: detecting physical shake gestures on Android and iOS through a single, fully typed API. You can tune how strong a shake must be with three sensitivity levels, and the motion sensor only runs between startWatching(...) and stopWatching(), so it stays battery-friendly. It is actively maintained against the latest Capacitor version, giving you consistent shake behavior on both platforms from one dependency."}}, {"@type": "Question", "name": "Which platforms are supported by the Shake plugin?", "acceptedAnswer": {"@type": "Answer", "text": "The plugin is available on Android and iOS. On the Web, all methods reject as unimplemented, since browsers do not provide a comparable shake detection API."}}, {"@type": "Question", "name": "Does shake detection drain the battery?", "acceptedAnswer": {"@type": "Answer", "text": "No, the plugin is designed to be battery-friendly. The motion sensor is only active between startWatching(...) and stopWatching(), so no sensor data is processed while you are not watching for shakes. Remember to call stopWatching() and removeAllListeners() when you no longer need shake detection."}}, {"@type": "Question", "name": "How can I control how strong a shake must be?", "acceptedAnswer": {"@type": "Answer", "text": "Pass the sensitivity option to startWatching(...). Use light to detect gentle shakes, medium (the default) for moderate shakes, or hard to only detect strong shakes. See Sensitivity Levels for details."}}, {"@type": "Question", "name": "Do I need any permissions to detect shake gestures?", "acceptedAnswer": {"@type": "Answer", "text": "No, the plugin does not require any additional permissions or privacy descriptions on Android or iOS. You can install it and start watching for shake gestures right away."}}, {"@type": "Question", "name": "Can I use this plugin with Ionic, React, Vue or Angular?", "acceptedAnswer": {"@type": "Answer", "text": "Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects."}}], "url": "https://capawesome.io/docs/sdks/capacitor/shake/"} ```