rn-shake

React Native useShake hook that helps detecting shake gesture with phone accelerometer.

Usage no npm install needed!

<script type="module">
  import rnShake from 'https://cdn.skypack.dev/rn-shake';
</script>

README

rn-shake

📱 React Native useShake hook that helps detecting shake gesture with phone accelerometer.

📦 Installation

yarn add rn-shake react-native-sensors

🚀 Usage

  • The first argument of the hook is the callback function.
  • Second argument is the configuration object - All fields optional.
  • It is strongly recommended that you adjust the threshold value with experiments to match your needs.
import {useShake} from 'rn-shake';

useShake(
  () => {
    console.log('🐍 Shook Shook');
  },
  {
    threshold: 3,
    sensorUpdateInterval: 200,
    minimalTimeBetweenTriggers: 1000,
    isTriggerAfterShakes: true,
    resetDependencies: [],
  }
);