Skip to content
Open
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
13a016e
feat(android): add `StatusBarBackgroundColor` preference to `config.x…
GitToTheHub May 21, 2026
8cc6f1b
Remove <br>s, small change on AndroidEdgeToEdge
GitToTheHub May 21, 2026
6b92ca6
Add edge case for `BackgroundColor` and `AndroidEdgeToEdge=true`
GitToTheHub May 21, 2026
0e8f2c7
Remove "Edge case:" wordings from `BackgroundColor`
GitToTheHub May 21, 2026
8618b29
Remove "Edge case:" wording from `StatusBarBackgroundColor`
GitToTheHub May 21, 2026
95163f8
Small wording change on `StatusBarBackgroundColor`
GitToTheHub May 21, 2026
d7ba569
Use hex string format for BackgroundColor
GitToTheHub May 26, 2026
5d8a125
Improve documentation, `StatusBarBackgroundColor` also available on c…
GitToTheHub Jun 13, 2026
20958cf
BackgroundColor changes also the Splash Screen background color
GitToTheHub Jun 13, 2026
a50e660
update documentation for AndroidEdgeToEdge
GitToTheHub Jun 24, 2026
ef20fa8
Merge branch 'master' into pr-feat-config.xml-add-StatusBarBackground…
GitToTheHub Jun 24, 2026
5aae9c3
Change small wording on AndroidEdgeToEdge
GitToTheHub Jun 24, 2026
dd3c616
Improve documentation of `AndroidEdgeToEdge`
GitToTheHub Jul 9, 2026
8cda52e
Improve documentation of `StatusBarBackgroundColor`
GitToTheHub Jul 9, 2026
b329462
Merge branch 'master' into pr-feat-config.xml-add-StatusBarBackground…
GitToTheHub Jul 9, 2026
acd8c5d
Improve documentation of `StatusBarBackgroundColor`
GitToTheHub Jul 18, 2026
f3a8b77
Remove wrong sentence on `StatusBarBackgroundColor`
GitToTheHub Jul 18, 2026
116a08f
Some word changes for `StatusBarBackgroundColor`
GitToTheHub Jul 19, 2026
d34fed3
Some word changes for `BackgroundColor`
GitToTheHub Jul 19, 2026
e9fd925
Some changes for `AndroidEdgeToEdge`
GitToTheHub Jul 19, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions www/docs/en/latest/config_ref/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 to enable Android edge-to-edge mode optionally. Since cordova-android 15.0.0, the app always runs in edge-to-edge mode, but mimics optionally a colored status bar and navigation bar. If `AndroidEdgeToEdge` is set to `true`, the status bar and navigation bar will be transparent and overlay the web view and you have to handle the safe area by the CSS environment variables [safe-area-inset-*](https://developer.mozilla.org/en-US/docs/Web/CSS/Guides/Environment_variables/Using#safe-area-inset-), but which are only fully functional since [WebView version 149](https://caniuse.com/mdn-css_types_env_safe-area-inset-top) released on 20th May 2026. To support older web view versions, you can use the plugin [cordova-plugin-insets](https://github.com/totalpaveinc/cordova-plugin-insets), where you have to [create custom CSS variables and set the insets calculated by the plugin](https://github.com/totalpaveinc/cordova-plugin-insets/blob/main/docs.md#40---sample-code).<br><br>The status bar plugin `cordova-plugin-statusbar` is optional and must no be used anymore. The preference `StatusBarBackgroundColor` can still be used without the plugin. Also a Status Bar JavaScript API was added for setting the background color by `window.statusbar.setBackgroundColor()` and setting the visibility by `window.statusbar.visible`.<br><br>Since cordova-android 15.0.0, the user can decide to opt into edge-to-edge or not, while Google will not claim about not using edge-to-edge. Using edge-to-edge is a requirement by Google on [August 31 2026 for new apps and app updates](https://developer.android.com/google/play/requirements/target-sdk).
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]).
Expand All @@ -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 background color of the splash screen and app. The value must be a color hex string in the format `#AARRGGBB` (for example, `#FF0000FF` for opaque blue). If `StatusBarBackgroundColor` is not set, this value is also used for the status bar background color, if it is visible. On Android, depending on the OS version, this preference may also change the navigation/gesture bar.
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 objects are active.
Expand Down Expand Up @@ -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 %} {% cdv_platform ios %} | Added in the core of cordova-android 15.0.0 and cordova-ios 8.0.0 to set the status bar background color without needing the plugin `cordova-plugin-statusbar`. The value must be a color hex string in the format `#AARRGGBB` (for example, `#FF0000FF`). If not set, Cordova falls back to the `BackgroundColor` preference if present. The light/dark appeareance of the status bar will be set automtatically in contrast to the status bar background color, e.g. if the background color is black, the status bar text and icons will appear white. On Android, when `AndroidEdgeToEdge` is `true`, this preference may not produce a visible status bar background fill, but can be used to set the light/dark appearance of the status bar. The status bar background color can also be set on runtime by the Status Bar JS API `window.statusbar.setBackgroundColor()` which supports any [valid CSS color format](https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/Values/color_value) like `rebeccapurple`, `#f09`, `rgb(255 0 153)`, etc., but this is only fully functional since cordova-ios 8.1.1 and cordova-android 15.1.0.
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.
Expand All @@ -383,7 +384,7 @@ Examples:
```xml
<preference name="DisallowOverscroll" value="true"/>
<preference name="Fullscreen" value="true" />
<preference name="BackgroundColor" value="0xff0000ff"/>
<preference name="BackgroundColor" value="#FF0000FF"/>
<preference name="HideKeyboardFormAccessoryBar" value="true"/>
<preference name="Orientation" value="landscape" />

Expand Down Expand Up @@ -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
Expand Down