@capgo/capacitor-privacy-screen

Block Android screenshots and hide sensitive UI in the iOS app switcher snapshot.

Overview

Enable privacy protection by default so support PINs, health data, and internal dashboards do not appear in screenshots, screen recordings, or the iOS task switcher preview. Temporarily disable() only for flows that must be capturable, then enable() again.

Android can apply secure window flags and dim overlays. iOS obscures content during app switcher snapshots. Web keeps an in memory flag for API parity only.

Platform support

Platform	Support	Notes
iOS	Yes	App switcher snapshot protection
Android	Yes	Secure surface, screenshot and recording blocking options
Web	API parity	In memory enabled flag only

Core Capabilities

enable - Enables the privacy screen.
disable - Disables the privacy screen.
isEnabled - Returns the current enabled state.

Public API

Method	Description
`enable`	Enables the privacy screen.
`disable`	Disables the privacy screen.
`isEnabled`	Returns the current enabled state.
`getPluginVersion`	Returns the native implementation version marker.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-privacy-screen.

Keep going from @capgo/capacitor-privacy-screen

If you are using @capgo/capacitor-privacy-screen to plan security and compliance, connect it with Using @capgo/capacitor-privacy-screen for the native capability in Using @capgo/capacitor-privacy-screen, Encryption for the implementation detail in Encryption, Compliance for the implementation detail in Compliance, Capgo Security Scanner for the product workflow in Capgo Security Scanner, and Capgo Security for the product workflow in Capgo Security.