npmpackage.info

@capacitor-community/privacy-screen

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

5.2.1

MIT

Swift

Installations

npm install @capacitor-community/privacy-screen

Pull Requests

Open

3

Total

59

Closed

7

Merged

49

Issues

Open

5

Total

52

Closed

47

Releases

v5.2.1

Published on 16 Aug 2024

v5.2.0

Published on 12 Aug 2024

v5.1.3

Published on 09 Aug 2024

v5.1.2

Published on 08 Aug 2024

v5.1.1

Published on 17 Jul 2024

v5.1.0

Published on 17 Jul 2024

View all 28 releases

Developer

capacitor-community

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

18.20.4

NPM Version

10.7.0 Statistics

88 Stars

134 Commits

23 Forks

9 Watching

2 Branches

27 Contributors

Updated on 25 Nov 2024

Languages

Swift (49.91%)

Java (21.47%)

TypeScript (17.54%)

Ruby (4.92%)

Objective-C (3.75%)

JavaScript (2.41%)

Total Downloads

Cumulative downloads

Total Downloads

487,474

Last day

-20.2%

1,157

Compared to previous day

Last week

-0.7%

6,982

Compared to previous week

Last month

12.6%

35,779

Compared to previous month

Last year

54.3%

229,566

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

@capacitor/core

Dev Dependencies

eslint rimraf rollup prettier swiftlint typescript @capacitor/cli @capacitor/ios @capacitor/core standard-version @capacitor/docgen @capacitor/android @ionic/eslint-config prettier-plugin-java @ionic/prettier-config @ionic/swiftlint-config

Versions

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	Since
`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.	`""`
`contentMode`	`'center' \| 'scaleToFill' \| 'scaleAspectFit' \| 'scaleAspectFill'`	Configure the content mode of displayed image. Only available for iOS.	`"center"`
`preventScreenshots`	`boolean`	Configure whether the plugin should prevent screenshots if enabled. Only available for iOS.	`true`	5.2.0

Examples

In capacitor.config.json:

1{
2  "plugins": {
3    "PrivacyScreen": {
4      "enable": true,
5      "imageName": "Splashscreen",
6      "contentMode": "scaleAspectFit",
7      "preventScreenshots": false
8    }
9  }
10}

In capacitor.config.ts:

1/// <reference types="@capacitor/privacy-screen" />
2
3import { CapacitorConfig } from '@capacitor/cli';
4
5const config: CapacitorConfig = {
6  plugins: {
7    PrivacyScreen: {
8      enable: true,
9      imageName: "Splashscreen",
10      contentMode: "scaleAspectFit",
11      preventScreenshots: false,
12    },
13  },
14};
15
16export 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:

1import { PrivacyScreen } from '@capacitor-community/privacy-screen';
2
3const enable = async () => {
4  await PrivacyScreen.enable();
5};
6
7const disable = async () => {
8  await PrivacyScreen.disable();
9};

API

enable()
disable()
addListener('screenRecordingStarted', ...)
addListener('screenRecordingStopped', ...)
addListener('screenshotTaken', ...)
removeAllListeners()
Interfaces

enable()

1enable() => Promise<void>

Enables the privacy screen protection.

Only available for Android and iOS.

Since: 1.1.0

disable()

1disable() => Promise<void>

Disables the privacy screen protection.

Only available for Android and iOS.

Since: 1.1.0

addListener('screenRecordingStarted', ...)

1addListener(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>

Since: 3.0.2

addListener('screenRecordingStopped', ...)

1addListener(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>

Since: 3.0.2

addListener('screenshotTaken', ...)

1addListener(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>

Since: 3.2.0

removeAllListeners()

1removeAllListeners() => Promise<void>

Remove all listeners for this plugin.

Since: 3.0.2

Interfaces

PluginListenerHandle

Prop	Type
`remove`	`() => Promise<void>`

Changelog

See CHANGELOG.md.

License

See LICENSE.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

9

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

7

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

4

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

1

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.7

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @capacitor-community/privacy-screen

@capacitor-community/in-app-review

6.0.0

Lets you prompt users to submit app store ratings and reviews without leaving your app - using platform native dialogs.

@capacitor/preferences

6.0.3

The Preferences API provides a simple key/value persistent store for lightweight data.

@capacitor-community/screen-brightness

6.0.0

control screen brightness on ios and android

@capacitor-community/keep-awake

5.0.1

Prevent your screen from getting some sleep!