@capacitor-community/privacy-screen

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

Usage no npm install needed!

<script type="module">
  import capacitorCommunityPrivacyScreen from 'https://cdn.skypack.dev/@capacitor-community/privacy-screen';
</script>

README


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.

Maintainers

Maintainer GitHub Social
Robin Genz robingenz @robin_genz

Installation

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

Configuration

These config values are available:

{
  "plugins": {
    "PrivacyScreen": {
      "enable": true
    }
  }
}

If you do not want the plugin to be enabled by default, set enable to false.

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() => Promise<void>

Enables the privacy screen protection.

Only available for Android and iOS.

Since: 1.1.0


disable()

disable() => Promise<void>

Disables the privacy screen protection.

Only available for Android and iOS.

Since: 1.1.0


Changelog

See CHANGELOG.md.

License

See LICENSE.