capacitor-community/privacy-screen

Privacy Screen

@capacitor-community/privacy-screen

Capacitor Privacy Screen Plugin

Introduction

⚡️ Capacitor plugin that protects your app from displaying a screenshot in Recents screen/App Switcher.

On Android, this plugin sets the FLAG_SECURE flag to treat the content of the window as secure, preventing it from appearing in screenshots or from being viewed on non-secure displays.
On iOS, this plugin hides the webview window when the app is no longer active and loses focus (UIApplicationWillResignActiveNotification) so that a gray screen is shown instead. It also prevents screenshots (a black screen will be captured).

Using the Camera Plugin

Disabling screenshots can interfere with plugins that hide the WebView like the Camera plugin. To avoid issues call disable before using a plugin and then enable after you are finished.

Maintainers

Maintainer	GitHub	Social
Robin Genz	robingenz	@robin_genz

Installation

npm install @capacitor-community/privacy-screen
npx cap sync

Configuration

These configuration values are available: | Prop | Type | Description | Default | | --------------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | | **`enable`** | boolean | Configure whether the plugin should be enabled from startup. Only available for Android and iOS. | true | | **`imageName`** | string | Configure whether the plugin should display a custom image from assets instead of a default background gray for the privacy screen. Only available for iOS. | "" | ### Examples In `capacitor.config.json`: ```json { "plugins": { "PrivacyScreen": { "enable": true, "imageName": "Splashscreen" } } } ``` In `capacitor.config.ts`: ```ts /// import { CapacitorConfig } from '@capacitor/cli'; const config: CapacitorConfig = { plugins: { PrivacyScreen: { enable: true, imageName: "Splashscreen", }, }, }; export default config; ```

Demo

A working example can be found here: robingenz/capacitor-plugin-demo

Usage

The plugin only needs to be installed. The protection is enabled by default.
However, you have the option to enable/disable the protection:

import { PrivacyScreen } from '@capacitor-community/privacy-screen';

const enable = async () => {
  await PrivacyScreen.enable();
};

const disable = async () => {
  await PrivacyScreen.disable();
};

API

* [`enable()`](#enable) * [`disable()`](#disable) * [`addListener('screenRecordingStarted', ...)`](#addlistenerscreenrecordingstarted) * [`addListener('screenRecordingStopped', ...)`](#addlistenerscreenrecordingstopped) * [`addListener('screenshotTaken', ...)`](#addlistenerscreenshottaken) * [`removeAllListeners()`](#removealllisteners) * [Interfaces](#interfaces)

### enable() ```typescript enable() => Promise ``` Enables the privacy screen protection. Only available for Android and iOS. **Since:** 1.1.0 -------------------- ### disable() ```typescript disable() => Promise ``` Disables the privacy screen protection. Only available for Android and iOS. **Since:** 1.1.0 -------------------- ### addListener('screenRecordingStarted', ...) ```typescript addListener(eventName: 'screenRecordingStarted', listenerFunc: () => void) => Promise & PluginListenerHandle ``` Called when the screen recording is started. Only available on iOS for now. | Param | Type | | ------------------ | ------------------------------------- | | **`eventName`** | 'screenRecordingStarted' | | **`listenerFunc`** | () => void | **Returns:** Promise<PluginListenerHandle> & PluginListenerHandle **Since:** 3.0.2 -------------------- ### addListener('screenRecordingStopped', ...) ```typescript addListener(eventName: 'screenRecordingStopped', listenerFunc: () => void) => Promise & PluginListenerHandle ``` Called when the screen recording is stopped. Only available on iOS for now. | Param | Type | | ------------------ | ------------------------------------- | | **`eventName`** | 'screenRecordingStopped' | | **`listenerFunc`** | () => void | **Returns:** Promise<PluginListenerHandle> & PluginListenerHandle **Since:** 3.0.2 -------------------- ### addListener('screenshotTaken', ...) ```typescript addListener(eventName: 'screenshotTaken', listenerFunc: () => void) => Promise & PluginListenerHandle ``` Called when the screenshot is taken. Only available on iOS for now. | Param | Type | | ------------------ | ------------------------------ | | **`eventName`** | 'screenshotTaken' | | **`listenerFunc`** | () => void | **Returns:** Promise<PluginListenerHandle> & PluginListenerHandle **Since:** 3.2.0 -------------------- ### removeAllListeners() ```typescript removeAllListeners() => Promise ``` Remove all listeners for this plugin. **Since:** 3.0.2 -------------------- ### Interfaces #### PluginListenerHandle | Prop | Type | | ------------ | ----------------------------------------- | | **`remove`** | () => Promise<void> |

Changelog

See CHANGELOG.md.

License

See LICENSE.