Getting Started

1. Install the plugin

   npm

   npm i @capgo/capacitor-privacy-screen

   pnpm

   pnpm add @capgo/capacitor-privacy-screen

   yarn

   yarn add @capgo/capacitor-privacy-screen

   bun

   bun add @capgo/capacitor-privacy-screen

2. Sync native platforms

   npm

   npx cap sync

   pnpm

   pnpm cap sync

   yarn

   yarn cap sync

   bun

   bunx cap sync

3. Review platform behavior

   • Read the iOS notes for app switcher behavior.
   • Read the Android notes for screenshot and recording behavior.

Default behavior

The plugin enables privacy protection automatically when the native implementation loads.

• On Android, secure mode blocks screenshots, screen recording capture, and the recent apps preview.
• On iOS, the plugin hides your app during app switcher snapshot generation.
• On Web, the plugin keeps an in-memory enabled flag only for API parity.

Basic usage

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

await PrivacyScreen.disable();

// Run a flow where screenshots or previews are temporarily allowed.

await PrivacyScreen.enable();

const { enabled } = await PrivacyScreen.isEnabled();
console.log('Privacy screen enabled:', enabled);

When to disable it temporarily

Use disable() only when the current screen should remain visible in system previews or be capturable by the user, for example:

• account verification steps that require screenshots for support
• payment or identity-provider flows that need a visible app switcher preview
• controlled debugging sessions on trusted devices

Restore protection immediately afterward with enable().