ios-haptics/README.md

haptic feedback for ios safari

# ios-haptics

javascript library for haptic feedback inside of safari on ios

![GitHub last commit](https://img.shields.io/github/last-commit/tijnjh/ios-haptics)
[![npm version](https://img.shields.io/npm/v/ios-haptics.svg)](https://npmjs.com/package/ios-haptics)
![NPM Downloads](https://img.shields.io/npm/dm/ios-haptics)
![npm package minimized gzipped size](https://img.shields.io/bundlejs/size/ios-haptics)

demo: [ios-haptics demo](https://codepen.io/tijnjh/pen/KwpgPqB)

## installation

```sh
npm i ios-haptics
```

## usage

```javascript
import { haptic } from 'ios-haptics'

// a single haptic
haptic()

// two rapid haptics (good for confirmation)
haptic.confirm()

// three rapid haptics (useful for errors)
haptic.error()
```

## how it works

this uses the `<input type="checkbox" switch />` (introduced in safari 17.4), which has haptic feedback when toggled

every `haptic` call, it will create one of those in the background, toggle it, then remove it

---

Feel free to send a PR or open an issue if you have suggestions or find
improvements.