throwjojo/react-native-overlays-android

A React Native library that helps with asking for Overlay drawing permissions.

react-native-overlays-android

Just a library to request permissions for drawing overlays in Android. This library was mostly written in Kotlin, so if you use it(and aren't already using Kotlin in your project) your build times will increase slightly. You'll only need this if your React Native project targets a higher SDK version than 22. Any project that targets 22 or lower is automatically granted overlay permissions by the system.

Getting started

$ npm install react-native-overlays-android --save

Automatic installation

$ react-native link react-native-overlays-android

Manual installation

Android

1. Open up android/app/src/main/java/[...]/MainActivity.java

• Add import com.throwjojo.overlaysandroid.RNOverlaysAndroidPackage; to the imports at the top of the file
• Add new RNOverlaysAndroidPackage() to the list returned by the getPackages() method

2. Append the following lines to android/settings.gradle:

   include ':react-native-overlays-android'
   project(':react-native-overlays-android').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-overlays-android/android')
   

3. Insert the following lines inside the dependencies block in android/app/build.gradle:

     compile project(':react-native-overlays-android')
   

Usage

import { OverlaysAndroid } from 'react-native-overlays-android';

async function tryRequestOverlay() {
  let granted = await OverlaysAndroid.requestOverlayPermissions();
  // do something with granted
}

Check if overlays have been granted without opening the settings window

import { OverlaysAndroid } from 'react-native-overlays-android';

async function checkOverlays() {
  let granted = await OverlaysAndroid.overlaysGranted();
  // do something with granted
}

A note about before Marshmallow

Any devices using APIs prior to Marshmallow will grant overlay drawing automatically(if you have the permission in your manifest). In this case, granted will come back in this library as true without opening a request intent window.