Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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
Last synced: 24 days 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 (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-06T20:51:34.000Z (9 months ago)
- Last Synced: 2024-04-13T21:58:12.500Z (8 months ago)
- Language: JavaScript
- Size: 373 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS.txt
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> |