Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/huextrat/react-native-screenshot-aware
React Native module for real-time screenshot detection on Android and iOS
https://github.com/huextrat/react-native-screenshot-aware
android ios react-native screenshot
Last synced: 1 day ago
JSON representation
React Native module for real-time screenshot detection on Android and iOS
- Host: GitHub
- URL: https://github.com/huextrat/react-native-screenshot-aware
- Owner: huextrat
- License: mit
- Created: 2024-09-18T14:55:44.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-01-24T17:10:59.000Z (4 days ago)
- Last Synced: 2025-01-27T06:16:30.058Z (2 days ago)
- Topics: android, ios, react-native, screenshot
- Language: Kotlin
- Homepage: https://www.npmjs.com/package/react-native-screenshot-aware
- Size: 4.31 MB
- Stars: 97
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# React Native Screenshot Aware
Real-time screenshot detection for React Native apps
## Features
- 🚀 Real-time screenshot detection
- 🔄 Cross-platform support (iOS & Android)
- 🎣 Easy-to-use React hooks
- ⚡ Optimized for performance
- 📱 Supports Android 14+ (API level 34+) and iOS 14+
- 🏗️ Supports the new architecture for React Native
## Installation
```sh
yarn add react-native-screenshot-aware
```
or
```sh
npm install react-native-screenshot-aware
```
## Important Notes
### Android
- Supports Android 14+ (API level 34 and above)
- Utilizes the latest Android API for efficient screenshot detection
- Leverages the new `DETECT_SCREEN_CAPTURE` permission introduced in Android 14
- Provides a more privacy-friendly and performant approach to screenshot detection
### Permissions
To use the screenshot detection feature on Android, you need to add the following permission to your `AndroidManifest.xml` file:
```xml
```
> **Note**: Callbacks will never be triggered on devices running Android versions below 14. This is due to the reliance on the new `DETECT_SCREEN_CAPTURE` permission and APIs introduced in Android 14, which are not available in earlier versions.
> **Note**: The decision to support only Android 14+ is based on the introduction of new, dedicated screenshot detection APIs. These APIs offer improved performance and respect user privacy better than previous methods. For more details, see the [Android 14 screenshot detection documentation](https://developer.android.com/about/versions/14/features/screenshot-detection).
## API Reference
### `useScreenshotAware(callback)`
This hook allows you to detect when a screenshot is taken on the device. It takes a callback function as an argument, which will be executed whenever a screenshot event is detected.
#### Parameters
- `callback` (function): A function to be called when a screenshot is detected. This function does not take any arguments.
#### Example
```javascript
import { useScreenshotAware } from 'react-native-screenshot-aware';
useScreenshotAware(() => {
console.log('A screenshot was taken!');
});
```
### `addListener(callback)`
This function allows you to add a listener for the screenshot event. It takes a callback function as an argument, which will be executed whenever a screenshot event is detected.
#### Parameters
- `callback` (function): A function to be called when a screenshot is detected. This function does not take any arguments.
#### Example
```javascript
import ScreenshotAware from 'react-native-screenshot-aware';
useEffect(() => {
const listener = ScreenshotAware.addListener(() => {
console.log('A screenshot was taken!');
});
return () => {
listener.remove();
}
}, [])
```
### `removeAllListeners()`
This function allows you to remove all listeners for the screenshot event.
#### Example
```javascript
import ScreenshotAware from 'react-native-screenshot-aware';
function removeScreenshotListeners() {
ScreenshotAware.removeAllListeners();
}
```
## Jest Mocks
```javascript
jest.mock('react-native-screenshot-aware', () => ({
useScreenshotAware: jest.fn(),
addListener: jest.fn().mockReturnValue({
remove: jest.fn(),
}),
removeAllListeners: jest.fn(),
}));
```
## Contributing
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for more details.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Support
If you like this project, please consider supporting it by giving it a ⭐️ on GitHub!
## Acknowledgements
- [create-react-native-library](https://github.com/callstack/react-native-builder-bob) for the initial project setup