https://github.com/Cap-go/capacitor-shake
Capacitor Plugin to detect when a physical device performs a shake gesture
https://github.com/Cap-go/capacitor-shake
capacitor capacitor-plugin plugin
Last synced: 2 months ago
JSON representation
Capacitor Plugin to detect when a physical device performs a shake gesture
- Host: GitHub
- URL: https://github.com/Cap-go/capacitor-shake
- Owner: Cap-go
- Created: 2023-03-10T02:52:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-06T18:04:19.000Z (2 months ago)
- Last Synced: 2025-05-09T17:21:31.843Z (2 months ago)
- Topics: capacitor, capacitor-plugin, plugin
- Language: JavaScript
- Homepage: https://capgo.app
- Size: 733 KB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- awesome-capacitor - Shake - Detect shake gesture in device. ([Capgo plugins](https://capgo.app/))
README
# @capgo/capacitor-shake
➡️ Get Instant updates for your App with Capgo 🚀
Fix your annoying bug now, Hire a Capacitor expert 💪
Detect shake gesture in device
## Install
```bash
npm install @capgo/capacitor-shake
npx cap sync
```
## API
* [`addListener('shake', ...)`](#addlistenershake-)
* [Interfaces](#interfaces)
### addListener('shake', ...)
```typescript
addListener(eventName: "shake", listenerFunc: () => void) => Promise
```
| Param | Type |
| ------------------ | -------------------------- |
| **`eventName`** | 'shake' |
| **`listenerFunc`** | () => void |
**Returns:** Promise<PluginListenerHandle>
--------------------
### Interfaces
#### PluginListenerHandle
| Prop | Type |
| ------------ | ----------------------------------------- |
| **`remove`** | () => Promise<void> |