Skip to content

Files

Latest commit

 

History

History
31 lines (23 loc) Β· 650 Bytes

useVibrate.md

File metadata and controls

31 lines (23 loc) Β· 650 Bytes

useVibrate

React UI hook to provide physical feedback with device vibration hardware using the Vibration API.

Usage

import {useVibrate} from 'react-use';

const Demo = () => {
  const [vibrating, toggleVibrating] = useToggle(false);

  useVibrate(vibrating, [300, 100, 200, 100, 1000, 300], false);

  return (
    <div>
      <button onClick={toggleVibrating}>{vibrating ? 'Stop' : 'Vibrate'}</button>
    </div>
  );
};

Reference

useVibrate(
  enabled: boolean = true,
  pattern: number | number[] = [1000, 1000],
  loop: boolean = true
): void;