react-native-screenguard/README.md

A Native screenshot blocking library for React-Native developer, with background customizable after captured. Screenshot detector are also supported.

<p align="center">
  <h1>React Native Screenguard</h1>
  <p>A Native library for blocking screenshot for react-native developer, with background screenshot customizable.</p>
  <a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg"></a>
  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg"></a>
  <a href="https://aleen42.github.io/badges/src/eslint.svg"><img src="https://aleen42.github.io/badges/src/eslint.svg"></a>
</p>

![ts](https://flat.badgen.net/badge/Built%20With/TypeScript/blue)

![main](https://github.com/user-attachments/assets/135826cd-9cc7-4d7d-a4c4-8237efe36816)

You can find full documentation and how to use [here](https://gbumps.github.io/react-native-screenguard)

Web docs repo (for contribution) [here](https://github.com/gbumps/rn-screenguard-docs)

<b>For Flutter dev</b>: If you want to implement some of features from this library, please check it out here [flutter_screenguard](https://pub.dev/packages/flutter_screenguard) for more infos.

# Get started

<!--ts-->
  * [Installation](#installation)
    * [1.Install](https://gbumps.github.io/react-native-screenguard/docs/getting-started/install)
    * [2.Linking](https://gbumps.github.io/react-native-screenguard/docs/getting-started/linking)
  * [Usage](#usage)
     * [initSettings](https://gbumps.github.io/react-native-screenguard/docs/usages-and-apis/init-settings)
     * [register](https://gbumps.github.io/react-native-screenguard/docs/usages-and-apis/register)
     * [registerWithoutEffect](https://gbumps.github.io/react-native-screenguard/docs/usages-and-apis/register-without-effect-android)
     * [registerScreenshotEventListener](https://gbumps.github.io/react-native-screenguard/docs/usages-and-apis/register-screenshot-event-listener)(removed in v2.0.0)
     * [registerScreenRecordingEventListener](https://gbumps.github.io/react-native-screenguard/docs/usages-and-apis/register-screen-recording-event-listener)(removed in v2.0.0)
     * [registerWithBlurView](https://gbumps.github.io/react-native-screenguard/docs/usages-and-apis/register-with-blurview)
     * [registerWithImage](https://gbumps.github.io/react-native-screenguard/docs/usages-and-apis/register-with-image)
     * [unregister](https://gbumps.github.io/react-native-screenguard/docs/usages-and-apis/unregister)
     * [getScreenGuardLogs](https://gbumps.github.io/react-native-screenguard/docs/usages-and-apis/get-screen-guard-logs)
  * [Hooks](#hooks)
    * [useSGScreenShot](https://gbumps.github.io/react-native-screenguard/docs/usages-and-apis/use-sg-screenshot)
    * [useSGScreenRecord](https://gbumps.github.io/react-native-screenguard/docs/usages-and-apis/use-sg-screen-record)
  * [Limitation](https://gbumps.github.io/react-native-screenguard/docs/limitation/)
  * [Contributing](#contributing)
  * [License](#license)
<!--te-->