docs(splash): Update splashscreen config preferences #1348
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Include some preferences that were missing for auto-hiding and controlling splash screen delays, and also add the iOS `SplashScreenBackgroundColor` preference (from apache/cordova-ios#1411)
3 tasks
erisu
requested changes
Mar 29, 2024
| @@ -331,12 +331,15 @@ AndroidGradlePluginGoogleServicesVersion<br/>{% cdv_vartype semver %} {% cdv_pla | |||
| AndroidGradlePluginGoogleServicesEnabled<br/>{% cdv_vartype boolean %} {% cdv_platform android %} | *Default: false* <br/>Enables Google Services. The `google-services.json` file will be required. | |||
| GradlePluginKotlinEnabled<br/>{% cdv_vartype boolean %} {% cdv_platform android %} | *Default: false* <br/>Enables Kotlin plugin for Kotline support. | |||
| 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. | |||
| 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. <br/>__Note__: `transparent` value will set the application tile background to the accent color on Windows. | |||
| 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. | |||
There was a problem hiding this comment.
I think BackgroundColor preference is no longer valid for Android.
Android uses preference AndroidWindowSplashScreenIconBackgroundColor.
BackgroundColor is also missing from this page: https://github.com/apache/cordova-docs/blob/master/www/docs/en/dev/core/features/splashscreen/index.md
| @@ -362,6 +365,8 @@ PreferredContentMode<br/>{% cdv_vartype string %} {% cdv_platform ios %} | *Defa | |||
| InAppBrowserStatusBarStyle<br/>{% cdv_vartype string %} {% cdv_platform ios %} | *Default: default* <br/> Set text color style of the StatusBar for InAppBrowser for iOS. Valid values are: `lightcontent` and `default`. | |||
| SetFullscreen<br/>{% cdv_vartype boolean %} {% cdv_platform android %} | *Default: false* <br/> Same as the Fullscreen parameter in the global configuration of this xml file. This Android-specific element is deprecated in favor of the global Fullscreen element, and will be removed in a future version. | |||
| 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 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. | |||
There was a problem hiding this comment.
SplashScreenBackgroundColor should also be added to: https://github.com/apache/cordova-docs/blob/master/www/docs/en/dev/core/features/splashscreen/index.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Platforms affected
Mostly iOS
Motivation and Context
We're adding a new preference on iOS to control the splash screen background colour.
Description
Include some preferences that were missing for auto-hiding and controlling splash screen delays, and also add the iOS
SplashScreenBackgroundColorpreference (from apache/cordova-ios#1411)Checklist