Skip to content

A convenient React hook that utilizes input[switch] introduced in Safari 18.0 to trigger haptic feedback anytime, anywhere in your application.

License

Notifications You must be signed in to change notification settings

posaune0423/use-haptic

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

84 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

use-haptic 📳

A convenient React hook to trigger haptic feedback anywhere in your application

CI npm package downloads

✨ Overview

This package utilizes the input[switch] element introduced in Safari 18.0 to trigger haptic feedback anytime, anywhere in your React application.

🚀 Features

  • ✅ Trigger haptic feedback at any time in your React application
  • ✅ Support iOS, Android
  • ✅ Simple, intuitive API
  • ✅ Native TypeScript support by 🦕
  • ✅ ESM / CJS compatible
  • ✅ jsr / npm compatible

📦 Installation

npm install use-haptic
yarn add use-haptic
pnpm install use-haptic
bun add use-haptic
deno add jsr:@posaune0423/use-haptic

🔧 Usage

import { useHaptic } from "use-haptic";

function HapticButton() {
  const { triggerHaptic } = useHaptic();
  return <button onClick={triggerHaptic}>Feel Haptic</button>;
}

🏃‍♂️ Quick Start

Clone the repository and run the sample app:

git clone https://github.com/posaune0423/use-haptic.git
cd sample/deno-vite-react
deno task dev

You can visit the demo page by scanning the QR code displayed in the terminal.

🧰 Development

Publishing to npm

This package uses dnt for npm package preparation:

# Build the package
deno run -A scripts/build_npm.ts <version>

# Publish to npm
cd npm
npm publish

📄 License

MIT

About

A convenient React hook that utilizes input[switch] introduced in Safari 18.0 to trigger haptic feedback anytime, anywhere in your application.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published