Skip to content

Commit

Permalink
Add package README
Browse files Browse the repository at this point in the history
  • Loading branch information
christianbaroni committed Nov 13, 2024
1 parent 5a0cbd8 commit 09782f6
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions package/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# 🌀 Turbo Haptics

Fast, **worklet-compatible** haptic feedback for React Native.

## Features

- 🏎️ Zero-delay haptic feedback, powered by JSI
- 🪄 Compatible with Reanimated and Gesture Handler worklets
- 🎯 9 different haptic patterns (impact, notification, selection)
- 📱 iOS and Android support
- 🪶 Lightweight, zero dependencies

## Installation

```sh
yarn add react-native-turbo-haptics
cd ios && pod install
```

## Usage

```ts
import { triggerHaptics } from 'react-native-turbo-haptics';

// In any JavaScript context:
triggerHaptics('selection');

// In worklets:
Gesture.Tap()
.onBegin(() => triggerHaptics('soft'));
```

```ts
// Available haptic types:
const HapticTypes = {
impactHeavy: 'impactHeavy',
impactLight: 'impactLight',
impactMedium: 'impactMedium',
notificationError: 'notificationError',
notificationSuccess: 'notificationSuccess',
notificationWarning: 'notificationWarning',
rigid: 'rigid',
selection: 'selection',
soft: 'soft',
};
```

## License

MIT

0 comments on commit 09782f6

Please sign in to comment.