This is an automated email from the ASF dual-hosted git repository.
GitToTheHub pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cordova-plugin-statusbar.git
The following commit(s) were added to refs/heads/master by this push:
new b264830 doc(readme): background transparent on iOS when
`StatusBarOverlaysWebView` is true (#293)
b264830 is described below
commit b2648300d8bf8970f6207cbd569251de8b7f8326
Author: Manuel Beck <[email protected]>
AuthorDate: Tue Aug 25 12:25:58 2026 +0200
doc(readme): background transparent on iOS when `StatusBarOverlaysWebView`
is true (#293)
- The documentation made not clear, that the status bar background color is
transparent on iOS when `StatusBarOverlaysWebView` is set to `true` and cannot
be changed by `StatusBarBackgroundColor`.
---
README.md | 14 +++++++++++---
1 file changed, 11 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 07c4cd8..1641f17 100644
--- a/README.md
+++ b/README.md
@@ -47,14 +47,22 @@ Preferences
<preference name="StatusBarOverlaysWebView" value="true" />
+ ##### iOS Specifics
+
+ The status bar will be transparent if `StatusBarOverlaysWebView` is set to
`true`. A background color cannot be applied.
+
##### Android Quirks
Only supported on Android 5 or later. Earlier versions will ignore this
preference.
-- __StatusBarBackgroundColor__ (color hex string, no default value). Set the
background color of the statusbar by a hex string (#RRGGBB) at startup. If this
value is not set, the background color will be transparent. If
`StatusBarOverlaysWebView` is set to true, then a 8 digit hex (#AARRGGBB)
string can optionally be used to define the transparency.
+- __StatusBarBackgroundColor__ (color hex string, no default value). Set the
background color of the statusbar by a hex string (#RRGGBB) at startup. If this
value is not set, the background color will be transparent.
<preference name="StatusBarBackgroundColor" value="#000000" />
+ #### Android Specifics
+
+ If `StatusBarOverlaysWebView` is set to true, then a 8 digit hex
(#AARRGGBB) string can optionally be used to define the transparency.
+
- __StatusBarStyle__ (status bar style, defaults to lightcontent). Set the
status bar style (e.g. text color). Available options: `default`,
`lightcontent`.
<preference name="StatusBarStyle" value="lightcontent" />
@@ -216,9 +224,9 @@ CSS shorthand properties are also supported.
StatusBar.backgroundColorByHexString("#333"); // => #333333
StatusBar.backgroundColorByHexString("#FAB"); // => #FFAABB
-On iOS, when you set StatusBar.overlaysWebView to false, you can set the
background color of the statusbar by a hex string (#RRGGBB).
+On iOS you can set the background color of the statusbar by a hex string
(#RRGGBB) if StatusBar.overlaysWebView is false.
-On Android, when StatusBar.overlaysWebView is true, and on WP7&8, you can also
specify values as #AARRGGBB, where AA is an alpha value.
+On Android, when StatusBar.overlaysWebView is true you can also specify values
as #AARRGGBB, where AA is an alpha value.
Supported Platforms
-------------------
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
