react-native-lock-detection
v1.0.2
Published
Library to detect when the phone is locked or not
Downloads
6
Readme
React Native Lock Detection
Let know your app when the phone is locked or not. (iOS & Android)
Getting started
This is not published in NPM yet, so, if you want to use it you need to download it from GitHub or clone it and follow this:
Go to the folder where you have the library and run:
$ yarn link
After, go to your project folder and run:
$ yarn link react-native-lock-detection
Mostly automatic installation
Like this is native, you need to link the library, run:
$ react-native link react-native-lock-detection
Manual installation
In case the previous command doesn't do it's job, follow the next steps:
iOS
- In XCode, in the project navigator, right click
Libraries
➜Add Files to [your project's name]
- Go to
node_modules
➜react-native-lock-detection
and addRNLockDetection.xcodeproj
- In XCode, in the project navigator, select your project. Add
libRNLockDetection.a
to your project'sBuild Phases
➜Link Binary With Libraries
- Run your project (
Cmd+R
)<
Android
- Open up
android/app/src/main/java/[...]/MainActivity.java
- Add
import com.talosdigital.reactnative.RNLockDetectionPackage;
to the imports at the top of the file - Add
new RNLockDetectionPackage()
to the list returned by thegetPackages()
method
- Append the following lines to
android/settings.gradle
:include ':react-native-lock-detection' project(':react-native-lock-detection').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-lock-detection/android')
- Insert the following lines inside the dependencies block in
android/app/build.gradle
:compile project(':react-native-lock-detection')
Usage
The usage is differs for each platform:
iOS
In iOS is a little harder to use because of the configuration that React Native has for sending events trough the bridge.
import { NativeModules, NativeEventEmitter } from 'react-native'
...
const { LockDetection } = NativeModules
LockDetection.registerforDeviceLockNotif() // Register the library to listen the events for Darwin notifications
const LockDetectionEmitter = new NativeEventEmitter(LockDetection) // Create instance of EventEmitter
this.lockDetectionSuscription = LockDetectionEmitter.addListener( // and add the listener
'LockStatusChange',
newStatus => {
this.setState({ lockStatus: [...this.state.lockStatus, newStatus] }) // Do whatever you need with the information
}
)
...
componentWillUnmount() {
this.lockDetectionSuscription.remove() // Always remove the listener to avoid memory leaks
}
For iOS, once the event has been fired, it sends an object with the following structure
{
"newStatus": "LOCKED"
}
With the value being one of "LOCKED"
or "NOT_LOCKED"
. Note that it sends NOT_LOCKED
instead of UNLOCKED
meaning that it doesn't detect if the phone is unlocked or not. (This is because of the Darwin Notifications)
Android
TODO: write Android documentation