Skip to content

Commit da6a810

Browse files
committedAug 12, 2024
docs: run docgen
1 parent 9276f48 commit da6a810

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed
 

‎README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,12 @@ npx cap sync
4848

4949
These configuration values are available:
5050

51-
| Prop | Type | Description | Default |
52-
| ----------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
53-
| **`enable`** | <code>boolean</code> | Configure whether the plugin should be enabled from startup. Only available for Android and iOS. | <code>true</code> |
54-
| **`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> |
55-
| **`contentMode`** | <code>'center' \| 'scaleToFill' \| 'scaleAspectFit' \| 'scaleAspectFill'</code> | Configure the content mode of displayed image. Only available for iOS. | <code>"center"</code> |
56-
| **`preventScreenshots`** | <code>boolean</code> | Configure whether the plugin should disable/enable the possibility of taking screenshots. Only available for iOS. | <code>true</code> |
51+
| Prop | Type | Description | Default | Since |
52+
| ------------------------ | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | ----- |
53+
| **`enable`** | <code>boolean</code> | Configure whether the plugin should be enabled from startup. Only available for Android and iOS. | <code>true</code> | |
54+
| **`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> | |
55+
| **`contentMode`** | <code>'center' \| 'scaleToFill' \| 'scaleAspectFit' \| 'scaleAspectFill'</code> | Configure the content mode of displayed image. Only available for iOS. | <code>"center"</code> | |
56+
| **`preventScreenshots`** | <code>boolean</code> | Configure whether the plugin should prevent screenshots if enabled. Only available for iOS. | <code>true</code> | 5.2.0 |
5757

5858
### Examples
5959

@@ -66,7 +66,7 @@ In `capacitor.config.json`:
6666
"enable": true,
6767
"imageName": "Splashscreen",
6868
"contentMode": "scaleAspectFit",
69-
"preventScreenshots": true
69+
"preventScreenshots": false
7070
}
7171
}
7272
}
@@ -85,7 +85,7 @@ const config: CapacitorConfig = {
8585
enable: true,
8686
imageName: "Splashscreen",
8787
contentMode: "scaleAspectFit",
88-
preventScreenshots: true,
88+
preventScreenshots: false,
8989
},
9090
},
9191
};

0 commit comments

Comments
 (0)
Please sign in to comment.