react-native-haptic-engine 📳

A unified, high-performance haptic feedback & vibration library for React Native.

Bridge the gap between Android’s precise Vibrator API and iOS’s Taptic Engine with a single, simple function.

---

✨ Features

- 📳 Unified API
One function works seamlessly on both Android and iOS.

- 🤖 Android Precision
Control exact duration (milliseconds) and intensity (1–255).

- 🍏 iOS Taptic Support
Automatically maps vibration strength to Light / Medium / Heavy impact styles.

- ⚡ Zero Lag
Pure native implementation for instant feedback.

- 📱 Expo Compatible
Works with Expo Development Builds (CNG).

- 📦 Zero Dependencies

---

📦 Installation

``bash
npm install react-native-haptic-engine
`

$3

If you are using React Native CLI, install CocoaPods:

`bash
cd ios && pod install && cd ..
`

---

📱 Expo Support

This library includes custom native code and will NOT work in Expo Go.

You must use a Development Build.

$3

1. Install the package:
`bash
npm install react-native-haptic-engine
`

2. Rebuild your app:
`bash
npx expo run:android


or


npx expo run:ios
`

$3

| Environment | Supported |
|-----------|-----------|
| React Native CLI | ✅ Yes |
| Expo Dev Client | ✅ Yes |
| Expo Go | ❌ No |

---

🚀 Usage

`ts
import { vibrate, stop } from 'react-native-haptic-engine';

// 1. Light Tick (toggle / selection)
// Android: 50ms at low power
// iOS: Light Impact
vibrate(50, 40);

// 2. Normal Tap (button press)
// Android: 100ms at medium power
// iOS: Medium Impact
vibrate(100, 150);

// 3. Heavy Thud (error / explosion)
// Android: 500ms at max power
// iOS: Heavy Impact
vibrate(500, 255);

// 4. Stop vibration (Android only)
stop();
`

---

📚 API Reference

$3

Triggers a haptic / vibration event.

| Parameter | Type | Default | Description |
|---------|------|---------|-------------|
| milliseconds | number | 400 | Android only. Duration of vibration. Ignored on iOS |
| amplitude | number | 255 | Intensity from 1–255 |

---

📱 Platform Behavior Mapping

| Amplitude Range | Android Behavior | iOS Behavior |
|----------------|-----------------|--------------|
| 1 – 50 | Low intensity vibration | UIImpactFeedbackStyle.Light |
| 51 – 150 | Medium intensity vibration | UIImpactFeedbackStyle.Medium |
| 151 – 255 | High intensity vibration | UIImpactFeedbackStyle.Heavy |

---

$3

Stops any ongoing vibration.

| Platform | Behavior |
|--------|----------|
| Android | Stops vibration immediately |
| iOS | No-op (impact haptics are instantaneous) |

---

🛠 Troubleshooting

$3

Cause:
Running the app in Expo Go.

Fix:
Build a development client:

`bash
npx expo run:android


or


npx expo run:ios
`

---

$3

- Ensure the device is not in Silent / Do Not Disturb mode
- Some OEMs disable vibration in silent mode
- No manual permissions needed

The library automatically adds:

`xml

``

---

📄 License

MIT

---

Author: Vasanth S