feat(ios): add preventScreenshots configuration option (#105)

* lowercased cases of switch in getContentModeFromString * added disableScreenshots option * renamed disableScreenshots to preventScreenshots * fixed erroneous substitution * added missing file * updated method comment as suggested --------- Co-authored-by: ksenia <[email protected]>
capacitor-community · Aug 12, 2024 · 9276f48 · 9276f48
1 parent d4bbee0
commit 9276f48
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -53,6 +53,7 @@ These configuration values are available:
 | **`enable`**      | <code>boolean</code>                                                            | Configure whether the plugin should be enabled from startup. Only available for Android and iOS.                                                            | <code>true</code>     |
 | **`imageName`**   | <code>string</code>                                                             | 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. | <code>""</code>       |
 | **`contentMode`** | <code>'center' \| 'scaleToFill' \| 'scaleAspectFit' \| 'scaleAspectFill'</code> | Configure the content mode of displayed image. Only available for iOS.                                                                                      | <code>"center"</code> |
+| **`preventScreenshots`** | <code>boolean</code>                                                            | Configure whether the plugin should disable/enable the possibility of taking screenshots. Only available for iOS.                                           | <code>true</code>     |
 
 ### Examples
 
@@ -64,7 +65,8 @@ In `capacitor.config.json`:
     "PrivacyScreen": {
       "enable": true,
       "imageName": "Splashscreen",
-      "contentMode": "scaleAspectFit"
+      "contentMode": "scaleAspectFit",
+      "preventScreenshots": true
     }
   }
 }
@@ -83,6 +85,7 @@ const config: CapacitorConfig = {
       enable: true,
       imageName: "Splashscreen",
       contentMode: "scaleAspectFit",
+      preventScreenshots: true,
     },
   },
 };

diff --git a/ios/Plugin/PrivacyScreen.swift b/ios/Plugin/PrivacyScreen.swift
@@ -21,7 +21,10 @@ import UIKit
         }
 
         self.window = window
-        configurePreventionScreenshot()
+        let preventScreenshots = config.preventScreenshots ?? true
+        if preventScreenshots {
+            configurePreventionScreenshot()
+        }
     }
 
     public func configurePreventionScreenshot() {

diff --git a/ios/Plugin/PrivacyScreenConfig.swift b/ios/Plugin/PrivacyScreenConfig.swift
@@ -4,4 +4,5 @@ public struct PrivacyScreenConfig {
     var enable = true
     var imageName: String? = ""
     var contentMode: String? = "center"
+    var preventScreenshots: Bool? = true
 }
diff --git a/ios/Plugin/PrivacyScreenPlugin.swift b/ios/Plugin/PrivacyScreenPlugin.swift
@@ -70,6 +70,7 @@ public class PrivacyScreenPlugin: CAPPlugin {
         config.enable = getConfig().getBoolean("enable", config.enable)
         config.imageName = getConfig().getString("imageName", config.imageName)
         config.contentMode = getConfig().getString("contentMode", config.contentMode)
+        config.preventScreenshots = getConfig().getBoolean("preventScreenshots", true)
         return config
     }
 }
diff --git a/src/definitions.ts b/src/definitions.ts
@@ -40,6 +40,16 @@ declare module '@capacitor/cli' {
         | 'scaleToFill'
         | 'scaleAspectFit'
         | 'scaleAspectFill';
+      /**
+       * Configure whether the plugin should prevent screenshots if enabled.
+       *
+       * Only available for iOS.
+       *
+       * @default true
+       * @example false
+       * @since 5.2.0
+       */
+      preventScreenshots?: boolean;
     };
   }
 }