react-native-screenguard

A Native library for blocking screenshot for react-native developer, with background color screenshot customizable.

https://github.com/gbumps/react-native-screenguard/assets/16846439/26d8ac37-9bc3-4d5b-8ad5-93525fb90a72

Get started

Installation

1. Install the dependency

$ npm install react-native-screenguard --save

$ yarn add react-native-screenguard

1. Linking:

• React-native 0.60 and higher: just cd ios && pod install, no additional requirements.

• React-native 0.59 and lower: Please do manual installation as follow

iOS

1. In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project's name]

2. Go to node_modules ➜ react-native-screenguard and add ScreenGuard.xcodeproj

3. In XCode, in the project navigator, select your project. Add libScreenguard.a to your project's Build Phases ➜ Link Binary With Libraries

Android

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

• Add import com.screenguard.ScreenGuardPackage; to the imports at the top of the file

• Add new ScreenGuardPackage() to the list returned by the getPackages() method

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

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

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

     compile project(':react-native-screenguard')
   

For Expo user: First, you need to eject Expo or npx expo prebuild in order to use this library, check Expo docs below:

https://docs.expo.dev/workflow/prebuild/

Usage

1. ScreenGuardModule.register

• (iOS + Android) : Activate the screenguard.

import ScreenGuardModule from 'react-native-screenguard';

ScreenGuardModule.register('', (_) => {
	.....do anything you want after the screenshot 
});

• (iOS only) Activate the screenguard with your custom background color layout.

import ScreenGuardModule from 'react-native-screenguard';

ScreenGuardModule.register(
	//insert any hex color you want here, default black if null or empty
	'#0F9D58',
	(_) => {
	.....do anything you want after the screenshot 
});

https://github.com/gbumps/react-native-screenguard/assets/16846439/fd4b3662-6e3b-4428-a927-23ee2068c22a

2. ScreenGuardModule.registerWithoutScreenguard (v0.0.6+)

• (iOS + Android) Activate without screenguard, if you just want to detect and receive event callback only.

import ScreenGuardModule from 'react-native-screenguard';

ScreenGuardModule.registerWithoutScreenguard(
	(_) => {
	.....do anything you want after the screenshot 
});

3. ScreenGuardModule.registerWithBlurView (v0.1.2+)

• (iOS only) Activate screenguard with a blurred effect view after captured.

• Accepted a blur radius value number in between [15, 50] (Explain below) , throws warning if smaller than 15 or bigger than 50, exception if smaller than 1 or not a number.

import ScreenGuardModule from 'react-native-screenguard';

//register with a blur radius of 35
ScreenGuardModule.registerWithBlurView(
	35
	(_) => {
	.....do anything you want after the screenshot 
});

Explain: Set blur radius smaller than 15 won't help much, as content still look very clear and easy to read. Same with bigger than 50 but content will be shrinked and vanished inside the view, blurring is meaningless. So, between 15 and 50 is enough.

https://github.com/gbumps/react-native-screenguard/assets/16846439/17429686-1bc4-4d5b-aa6c-82616ec8d1c5

4. ScreenGuardModule.unregister (v0.0.2+)

• (iOS + Android) Deactivate the screenguard.

ScreenGuardModule.unregister();

Limitation

• This library support blocking screenshot for iOS 13+ only.

• register supports background color and event callback for iOS only.

• registerWithBlurView supports blur view for iOS only.

• You can use registerWithBlurView with register to add custom background color. However, please be aware that blur effect may not works properly if background color and your current view background color are the same. Use as your own risk.

• On Android, if you want to use callback, consider using registerWithoutScreenguard instead, as you might not receive any event after a screenshot has been triggered if using with register.

Contributing

All contributions are welcome! Please open an issue if you get stuck and bugs, or a PR if you have any feature idea, improvements and bug fixing. I'm very appreciate !

License

MIT