erisu commented on code in PR #1670:
URL: https://github.com/apache/cordova-ios/pull/1670#discussion_r3458882016
##########
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.
+ */
Review Comment:
```suggestion
/**
* Sets the background color of the visible status bar.
* Supports valid CSS color values, e.g. `rebeccapurple`, `#RRGGBBAA`,
`rgb(255 0 153)`.
*
* If cordova-plugin-statusbar is installed, calls are forwarded to the
plugin API:
* `window.StatusBar.backgroundColorByHexString`
* See {@link https://s.apache.org/cdv-plugin-statusbar} for
cordova-plugin-statusbar details.
*/
```
What you think of this?
It simplifies the wording and removing the alpha limitation of the plugin.
IMO, the alpha limitation comment is not necessary here. While it may be
unlikely, if the implementation detail of the plugin changes, it would make the
comment become obsolete. Instead, I thought including the plugin doc link would
be nice way to avoid this.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
