@candlefinance/haptics
v0.3.3TypeScript
Haptic feedback generator with support for playing patterns.
0/weekUpdated 1 years agoMITUnpacked: 52.2 KB
Published by Gary Tokman
npm install @candlefinance/haptics
Haptics for React Native
Supports playing haptics on iOS with default UIImpactFeedbackGenerator and CoreHaptics for patterns and ahap files. Vibrates on Android.
Installation
``sh`
yarn add @candlefinance/haptics
`sh`
npm i @candlefinance/haptics
Basic Usage
There are three functions:
`js
import { haptic, hapticWithPattern } from '@candlefinance/haptics';
// light, medium, heavy, soft, rigid, warning, error, success, selectionChanged
haptic('medium');
// pattern
hapticWithPattern(['.', '.', '.', 'o', 'O', '-', 'O', 'o', '.', '.', '.', '.']);
// play ahap file (iOS only)
play('fileName');
`
The pattern format:
`
- 'o' - medium impact
- 'O' - heavy impact
- '.' - light impact
- ':' - soft impact
- '-' - wait of 0.1 second
- '=' - wait of 1 second
For playing ahap files to the root of your project add a folder called haptics` and add your ahap files there. Use (Haptrix)[https://www.haptrix.com/] or equivalent to generate ahap files.
Contributing
Join our Discord and ask questions in the #oss channel.
License
MIT