This is an automated email from the ASF dual-hosted git repository. GitToTheHub pushed a commit to branch pr-feat-config.xml-add-StatusBarBackgroundColor-update-BackgroundColor in repository https://gitbox.apache.org/repos/asf/cordova-docs.git
commit 13a016e481a97f0097a6697180bb8e164e995576 Author: Manuel Beck <[email protected]> AuthorDate: Thu May 21 12:34:19 2026 +0200 feat(android): add `StatusBarBackgroundColor` preference to `config.xml`, update `BackgroundColor` regarding Android - `StatusBarBackgroundColor` is handled since cordova-android 15, which is reused from cordova-plugin-statusbar. When`AndroidEdgeToEdge` is `true`, this preference may not produce a visible status bar background fill, but it can still influence status bar icon/text light-versus-dark appearance. - Add prefernce example of`StatusBarBackgroundColor` - Update documentation of `BackgroundColor` that on Android if `StatusBarBackgroundColor` is not set, this value is also used for the status bar. Depending on the Android OS version, this preference may also change the navigation/gesture bar. Edge case: if the value is invalid, Cordova ignores it and falls back to platform defaults/fallback colors. - Add note to AndroidEdgeToEdge, that when it set the built-in StatusBar JavaScript API methods (such as `window.statusbar.setBackgroundColor`) are not applied. - Generated-By: GPT-5.3-Codex --- www/docs/en/latest/config_ref/index.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/www/docs/en/latest/config_ref/index.md b/www/docs/en/latest/config_ref/index.md index 25e5d95035..5f6a3a598d 100644 --- a/www/docs/en/latest/config_ref/index.md +++ b/www/docs/en/latest/config_ref/index.md @@ -316,7 +316,7 @@ Attributes | Description ----------------- | ------------ AllowInlineMediaPlayback<br/>{% cdv_vartype boolean %} {% cdv_platform ios %} | *Default: false* <br/> Set to true to allow HTML5 media playback to appear inline within the screen layout, using browser-supplied controls rather than native controls. For this to work, add the ```playsinline``` attribute to any ```<video>``` elements. *NOTE*: Prior to iOS 10, ```<video>``` elements need to use the ```webkit-playsinline``` attribute name instead. AllowNewWindows<br/>{% cdv_vartype boolean %} {% cdv_platform ios %} | *Default: false* <br/> Set to true to allow JavaScript `window.open` and HTML `target="_blank"` links to open a new view overlaying the web view. -AndroidEdgeToEdge<br/>{% cdv_vartype boolean %} {% cdv_platform android %} | *Default: false* <br/> Added in cordova-android 14.0.0. Enables Android edge-to-edge mode. By default, Cordova uses a compatibility behavior that keeps status and navigation bars styled similarly to previous Android releases. Set this preference to `true` to opt in to full edge-to-edge rendering. +AndroidEdgeToEdge<br/>{% cdv_vartype boolean %} {% cdv_platform android %} | *Default: false* <br/> Added in cordova-android 14.0.0. Enables Android edge-to-edge mode. By default, Cordova uses a compatibility behavior that keeps status and navigation bars styled similarly to previous Android releases. Set this preference to `true` to opt in to full edge-to-edge rendering.<br/><br/>When this preference is `true`, the built-in StatusBar JavaScript API methods (such as `window.statusbar.set [...] AndroidLaunchMode<br/>{% cdv_vartype string %} {% cdv_platform android %} | *Default: singleTop* <br/> Allowed values: standard, singleTop, singleTask, singleInstance <br/> Sets the Activity android:launchMode attribute. This changes what happens when the app is launched from app icon or intent and is already running. AndroidInsecureFileModeEnabled<br/>{% cdv_vartype boolean %} {% cdv_platform android %} | *Default: false* <br/> If set to `true` loading `file:///` URLs is allowed. __Note__: Enabling this setting allows malicious scripts loaded in a `file:///` context to launch cross-site scripting attacks, either accessing arbitrary local files including WebView cookies, app private data or even credentials used on arbitrary web sites. android-maxSdkVersion<br/>{% cdv_vartype number %} {% cdv_platform android %} | *Default: Not Specified* <br/> Sets the `maxSdkVersion` attribute of the `<uses-sdk>` tag in the project's `AndroidManifest.xml` (see [here][uses-sdk]). @@ -331,7 +331,7 @@ AndroidXAppCompatVersion<br/>{% cdv_vartype semver %} {% cdv_platform android %} AndroidXWebKitVersion<br/>{% cdv_vartype semver %} {% cdv_platform android %} | *Default: [Dependent on cordova-android Version][android-api-level-support]* <br/>Overrides Android WebKit library version. AppendUserAgent<br/>{% cdv_vartype string %} {% cdv_platform android %} {% cdv_platform ios %} | If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored. AutoHideSplashScreen<br/> {% cdv_vartype boolean %} {% cdv_platform android %} {% cdv_platform ios %} | *Default: true* <br/> Indicates whether to hide splash screen automatically or not. The splash screen is hidden after the amount of time specified in the `SplashScreenDelay` preference. -BackgroundColor<br/>{% cdv_vartype string %} {% cdv_platform android %} {% cdv_platform ios %} | Sets the app's background color. Supports a four-byte hex value, with the first byte representing the alpha channel, and standard RGB values for the following three bytes. +BackgroundColor<br/>{% cdv_vartype string %} {% cdv_platform android %} {% cdv_platform ios %} | Sets the app's background color. Supports a four-byte hex value, with the first byte representing the alpha channel, and standard RGB values for the following three bytes (for example, `0xFF0000FF` for opaque blue). On Android, if `StatusBarBackgroundColor` is not set, this value is also used for the status bar. Depending on the Android OS version, this preference may also change the navigati [...] CordovaWebViewEngine<br/>{% cdv_vartype string %} {% cdv_platform ios %} | *Default: CDVWebViewEngine* <br/> This sets the WebView engine plugin to be used to render the host app. The plugin must conform to the CDVWebViewEngineProtocol protocol. The 'value' here should match the 'feature' name of the WebView engine plugin that is installed. This preference usually would be set by the WebView engine plugin that is installed, automatically. CrashRecoveryBehavior<br/>{% cdv_vartype string %} {% cdv_platform ios %} | *Default: refresh* <br/> Allowed values: refresh, reload <br/> Specifies the crash recovery behavior for the iOS web view. The `reload` option will cause the web view to reload the starting URL for the app, whereas `refresh` will attempt to restore the current URL state. DefaultVolumeStream<br/>{% cdv_vartype string %} {% cdv_platform android %} | *Default: default* <br/> Added in cordova-android 3.7.0, This preference sets which volume the hardware volume buttons link to. By default this is "call" for phones and "media" for tablets. Set this to "media" to have your app's volume buttons always change the media volume. Note that when using Cordova's media plugin, the volume buttons will dynamically change to controlling the media volume when any Media ob [...] @@ -367,6 +367,7 @@ SetFullscreen<br/>{% cdv_vartype boolean %} {% cdv_platform android %} | *Defaul ShowTitle<br/>{% cdv_vartype boolean %} {% cdv_platform android %} | *Default: false* <br/> Show the title at the top of the screen. SplashScreenBackgroundColor<br/>{% cdv_vartype string %} {% cdv_platform android %} {% cdv_platform ios %} | Sets the app's splashscreen background color. Supports a four-byte hex value, with the first byte representing the alpha channel, and standard RGB values for the following three bytes. SplashScreenDelay<br/>{% cdv_vartype float %} {% cdv_platform android %} {% cdv_platform ios %} | *Default: 0* <br/> Amount of time in milliseconds to wait before automatically hide splash screen. +StatusBarBackgroundColor<br/>{% cdv_vartype string %} {% cdv_platform android %} | Added in cordova-android 15.0.0. This preference is reused from `cordova-plugin-statusbar` for compatibility. Sets the status bar background color. Value must be a color hex string in the format `#AARRGGBB` (for example, `#FF0000FF`). If not set, Cordova falls back to the `BackgroundColor` preference. For runtime updates, use `window.statusbar.setBackgroundColor('#AARRGGBB')` from the built-in StatusBar Ja [...] Suppresses3DTouchGesture<br/>{% cdv_vartype boolean %} {% cdv_platform ios %} | *Default: false* <br/> Set to true to avoid 3D Touch capable iOS devices rendering a magnifying glass widget when the user applies force while longpressing the webview. Test your app thoroughly since this disables onclick handlers, but plays nice with ontouchend. If this setting is true, SuppressesLongPressGesture will effectively be true as well. SuppressesIncrementalRendering<br/>{% cdv_vartype boolean %} {% cdv_platform ios %} | *Default: false* <br/> Set to true to wait until all content has been received before it renders to the screen. SuppressesLongPressGesture<br/>{% cdv_vartype boolean %} {% cdv_platform ios %} | *Default: false* <br/> Set to true to avoid iOS9+ rendering a magnifying glass widget when the user longpresses the webview. Test your app thoroughly since this may interfere with text selection capabilities. @@ -427,6 +428,7 @@ Examples: <preference name="GradlePluginKotlinEnabled" value="true" /> <preference name="GradlePluginKotlinCodeStyle" value="official" /> <preference name="GradlePluginKotlinVersion" value="1.3.50" /> +<preference name="StatusBarBackgroundColor" value="#FF0000FF" /> ``` ## feature --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
