react-native-screenshot-notifier
v1.0.5
Published
React-Native module for getting notified of screenshots on _Android_. (Not for iOS)
Downloads
18
Readme
react-native-screenshot-notifier
React-Native module for getting notified of screenshots on Android. (Not for iOS)
Installation
yarn add react-native-screenshot-notifier
react-native link react-native-screenshot-notifier
Best API: Hooks!
useScreenshotNotifier()
Returns array of id
, fileName
and path
of captured screenshot
Usage
const { id, fileName, path } = useScreenshotNotifier();
Sample App
import React from "react";
import { StyleSheet, Text, View } from "react-native";
import { useScreenshotNotifier } from "react-native-screenshot-notifier";
export default () => {
const { id, path, fileName } = useScreenshotNotifier();
return (
<View style={styles.container}>
<Text style={styles.welcome}>Welcome to React Native!</Text>
{id ? (
<Text>{`Screenshot Taken! ${id}: ${path}/${fileName}`}</Text>
) : (
<Text>NO screenshot taken... yet!</Text>
)}
</View>
);
};
const styles = StyleSheet.create({
container: {
flex: 1,
justifyContent: "center",
alignItems: "center",
backgroundColor: "#F5FCFF"
},
welcome: {
fontSize: 20,
textAlign: "center",
margin: 10
}
});
useDisableScreenshots(disableScreenshots = true)
Disables screenshots (or turns them back on if disableScreenshots
is false
)
Usage
useDisableScreenshots(); // That's it.
Sample App
import React from "react";
import { StyleSheet, Text, View } from "react-native";
import { useDisableScreenshots } from "react-native-screenshot-notifier";
export default () => {
useDisableScreenshots();
return (
<View style={styles.container}>
<Text style={styles.welcome}>I dare you to screenshot me</Text>
</View>
);
};
const styles = StyleSheet.create({
container: {
flex: 1,
justifyContent: "center",
alignItems: "center",
backgroundColor: "#F5FCFF"
},
welcome: {
fontSize: 20,
textAlign: "center",
margin: 10
}
});
Low-Level API
async disableScreenshots()
Yes, it disables screenshots.
async enableScreenshots()
And it enables screenshots. Documentation FTW.
async getPermission()
Get permission to use the READ_EXTERNAL_STORAGE
API as required to detect screenshots.
async start(options)
Start listening for screenshots
async stop
Stop listening for screenshots
async addListener(func)
Add a callback for when a screenshot is returned
async removeListener(func)
Remove that listener by reference
async pause()
Very Low-Level - probably should not use
Pause screenshot listening (normally managed automatically by start
)
async resume()
Very Low-Level - probably should not use
Pause screenshot listening (normally managed automatically by start
)
Credit
This package depends on and embeds the great, terse ShotWatch library code.