Skip to content
This repository has been archived by the owner on Jul 21, 2021. It is now read-only.

📱 A React Native wrapper that provides access to the proximity sensor on iOS and Android.

License

Notifications You must be signed in to change notification settings

williambout/react-native-proximity

Repository files navigation

npm version

react-native-proximity

A React Native wrapper that provides access to the state of the proximity sensor for iOS and Android.

Usage of react-native-proximity and scrollview.

Getting Started

  • Install the library
npm install --save react-native-proximity
  • Link the library
react-native link react-native-proximity

Usage

Import the library

import Proximity from 'react-native-proximity';

addListener(callback)

The callback function returns an object with proximity and distance properties. If proximity is true, it means the device is close to an physical object. distance is only supported in Android.

componentDidMount(){
 Proximity.addListener(this._proximityListener);
},

/**
 * State of proximity sensor
 * @param {object} data
 */
 _proximityListener(data) {
   this.setState({
     proximity: data.proximity,
     distance: data.distance // Android-only 
   });
 },

removeListener(callback)

componentWillUnmount() {
  Proximity.removeListener(this._proximityListener);
},