(cordova-ios) 01/01: doc(statusbar.js): document `setBackgroundColor()`

[ma...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

GitToTheHub pushed a commit to branch pr-doc-statusbar.js-setBackgroundColor
in repository https://gitbox.apache.org/repos/asf/cordova-ios.git

commit 2407f9dad3551335de01c890f2458866c987b593
Author: Manuel Beck <ma...@outlook.de>
AuthorDate: Tue Jun 23 11:56:33 2026 +0200

    doc(statusbar.js): document `setBackgroundColor()`
---
 cordova-js-src/plugin/ios/statusbar.js | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/cordova-js-src/plugin/ios/statusbar.js b/cordova-js-src/plugin/ios/statusbar.js
index 63349877..2cb8180f 100644
--- a/cordova-js-src/plugin/ios/statusbar.js
+++ b/cordova-js-src/plugin/ios/statusbar.js
@@ -52,6 +52,13 @@ Object.defineProperty(statusBar, 'visible', {
     }
 });
 
+/**
+ * Sets the background color of the status bar, which will visually only have an impact,
+ * if the status bar is visible. The supported format is any valid CSS color value,
+ * like `rebeccapurple`, `#RRGGBBAA`, `rgb(255 0 153)`.
+ * If cordova-plugin-statusbar is installed, the call will be forwarded to
+ * `window.StatusBar.backgroundColorByHexString`, which will not support an alpha value.
+ */
 Object.defineProperty(statusBar, 'setBackgroundColor', {
     configurable: false,
     enumerable: false,


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org