diff options
Diffstat (limited to 'StoneIsland/plugins/cordova-plugin-splashscreen/README.md')
| -rw-r--r-- | StoneIsland/plugins/cordova-plugin-splashscreen/README.md | 221 |
1 files changed, 175 insertions, 46 deletions
diff --git a/StoneIsland/plugins/cordova-plugin-splashscreen/README.md b/StoneIsland/plugins/cordova-plugin-splashscreen/README.md index ff790b16..6a6faaf9 100644 --- a/StoneIsland/plugins/cordova-plugin-splashscreen/README.md +++ b/StoneIsland/plugins/cordova-plugin-splashscreen/README.md @@ -1,3 +1,7 @@ +--- +title: Splashscreen +description: Control the splash screen for your app. +--- <!-- # license: Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file @@ -17,11 +21,15 @@ # under the License. --> +|Android|iOS| Windows 8.1 Store | Windows 8.1 Phone | Windows 10 Store | Travis CI | +|:-:|:-:|:-:|:-:|:-:|:-:| +|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=android,PLUGIN=cordova-plugin-splashscreen/)|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=ios,PLUGIN=cordova-plugin-splashscreen/)|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-8.1-store,PLUGIN=cordova-plugin-splashscreen/)|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-8.1-phone,PLUGIN=cordova-plugin-splashscreen/)|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-10-store,PLUGIN=cordova-plugin-splashscreen/)|[](https://travis-ci.org/apache/cordova-plugin-splashscreen)| + # cordova-plugin-splashscreen -This plugin displays and hides a splash screen during application launch. +This plugin is required to work with splash screens. This plugin displays and hides a splash screen during application launch. -:warning: Report issues on the [Apache Cordova issue tracker](https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20%22Plugin%20Splashscreen%22%20ORDER%20BY%20priority%20DESC%2C%20summary%20ASC%2C%20updatedDate%20DESC) +Report issues with this plugin on the [Apache Cordova issue tracker][Apache Cordova issue tracker]. ## Installation @@ -38,76 +46,192 @@ This plugin displays and hides a splash screen during application launch. - BlackBerry 10 - iOS - Windows Phone 7 and 8 -- Windows 8 -- Windows +- Windows (`cordova-windows` version >= 4.4.0 is required) - Browser -## Preferences +__Note__: Extended splashscreen does not require the plugin on Windows (as opposed to Android and iOS) in case you don't use the plugin API, i.e. programmatic hide/show. -#### config.xml +## Example Configuration +In the top-level `config.xml` file (not the one in `platforms`), add configuration elements like those specified here. -- __SplashScreen__ (string). The resource name which is used for the displaying splash screen. Different platforms use values for this. +Please notice that the value of the "src" attribute is relative to the project root directory and not to the www directory (see `Directory structure` below). You can name the source image whatever you like. The internal name in the app is determined by Cordova. - <preference name="SplashScreen" value="resourcename" /> +Directory structure: -- __AutoHideSplashScreen__ (boolean, default to `true`). Indicates wherether hide splash screen automatically or not. Splash screen hidden after amount of time specified in the `SplashScreenDelay` preference. +``` +projectRoot + hooks + platforms + plugins + www + css + img + js + res + screen + android + ios + windows +``` - <preference name="AutoHideSplashScreen" value="true" /> +```xml +<platform name="android"> + <!-- you can use any density that exists in the Android project --> + <splash src="res/screen/android/splash-land-hdpi.png" density="land-hdpi"/> + <splash src="res/screen/android/splash-land-ldpi.png" density="land-ldpi"/> + <splash src="res/screen/android/splash-land-mdpi.png" density="land-mdpi"/> + <splash src="res/screen/android/splash-land-xhdpi.png" density="land-xhdpi"/> -- __SplashScreenDelay__ (number, default to 3000). Amount of time in milliseconds to wait before automatically hide splash screen. + <splash src="res/screen/android/splash-port-hdpi.png" density="port-hdpi"/> + <splash src="res/screen/android/splash-port-ldpi.png" density="port-ldpi"/> + <splash src="res/screen/android/splash-port-mdpi.png" density="port-mdpi"/> + <splash src="res/screen/android/splash-port-xhdpi.png" density="port-xhdpi"/> +</platform> - <preference name="SplashScreenDelay" value="3000" /> +<platform name="ios"> + <!-- images are determined by width and height. The following are supported --> + <splash src="res/screen/ios/Default~iphone.png" width="320" height="480"/> + <splash src="res/screen/ios/Default@2x~iphone.png" width="640" height="960"/> + <splash src="res/screen/ios/Default-Portrait~ipad.png" width="768" height="1024"/> + <splash src="res/screen/ios/Default-Portrait@2x~ipad.png" width="1536" height="2048"/> + <splash src="res/screen/ios/Default-Landscape~ipad.png" width="1024" height="768"/> + <splash src="res/screen/ios/Default-Landscape@2x~ipad.png" width="2048" height="1536"/> + <splash src="res/screen/ios/Default-568h@2x~iphone.png" width="640" height="1136"/> + <splash src="res/screen/ios/Default-667h.png" width="750" height="1334"/> + <splash src="res/screen/ios/Default-736h.png" width="1242" height="2208"/> + <splash src="res/screen/ios/Default-Landscape-736h.png" width="2208" height="1242"/> +</platform> +<platform name="windows"> + <!-- images are determined by width and height. The following are supported --> + <splash src="res/screen/windows/splashscreen.png" width="620" height="300"/> + <splash src="res/screen/windows/splashscreenphone.png" width="1152" height="1920"/> +</platform> -### Android Quirks +<platform name="blackberry10"> + <!-- Add a rim:splash element for each resolution and locale you wish --> + <!-- http://developer.blackberry.com/html5/documentation/rim_splash_element.html --> + <rim:splash src="res/screen/blackberry/splashscreen.png"/> +</platform> -In your `config.xml`, you need to add the following preferences: +<preference name="SplashScreenDelay" value="10000" /> +``` - <preference name="SplashScreen" value="foo" /> - <preference name="SplashScreenDelay" value="3000" /> - <preference name="SplashMaintainAspectRatio" value="true|false" /> +## Preferences -Where foo is the name of the splashscreen file, preferably a 9 patch file. Make sure to add your splashcreen files to your res/xml directory under the appropriate folders. The second parameter represents how long the splashscreen will appear in milliseconds. It defaults to 3000 ms. See [Icons and Splash Screens](http://cordova.apache.org/docs/en/edge/config_ref_images.md.html) -for more information. +#### config.xml -"SplashMaintainAspectRatio" preference is optional. If set to true, splash screen drawable is not stretched to fit screen, but instead simply "covers" the screen, like CSS "background-size:cover". This is very useful when splash screen images cannot be distorted in any way, for example when they contain scenery or text. This setting works best with images that have large margins (safe areas) that can be safely cropped on screens with different aspect ratios. +- `AutoHideSplashScreen` (boolean, default to `true`). Indicates whether to hide splash screen automatically or not. Splash screen hidden after amount of time specified in the `SplashScreenDelay` preference. -The plugin reloads splash drawable whenever orientation changes, so you can specify different drawables for portrait and landscape orientations. +```xml + <preference name="AutoHideSplashScreen" value="true" /> +``` -### Browser Quirks +- `SplashScreenDelay` (number, default to 3000). Amount of time in milliseconds to wait before automatically hide splash screen. -You can use the following preferences in your `config.xml`: +```xml + <preference name="SplashScreenDelay" value="3000" /> +``` - <platform name="browser"> - <preference name="SplashScreen" value="images/browser/splashscreen.jpg" /> <!-- defaults to "img/logo.png" --> - <preference name="SplashScreenDelay" value="3000" /> <!-- defaults to "3000" --> - <preference name="SplashScreenBackgroundColor" value="green" /> <!-- defaults to "#464646" --> - <preference name="ShowSplashScreen" value="false" /> <!-- defaults to "true" --> - <preference name="SplashScreenWidth" value="600" /> <!-- defaults to "170" --> - <preference name="SplashScreenHeight" value="300" /> <!-- defaults to "200" --> - </platform> +Note also that this value used to be seconds, and not milliseconds, so values less than 30 will still be treated as seconds. ( Consider this a deprecated patch that will disapear in some future version. ) +To disable the splashscreen add the following preference to `config.xml`: +```xml +<preference name="SplashScreenDelay" value="0"/> +``` -### iOS Quirks +**iOS Quirk**: to disable the splashscreen on `ios` platform you should also add `<preference name="FadeSplashScreenDuration" value="0"/>` to `config.xml`. - `FadeSplashScreen` (boolean, defaults to `true`): Set to `false` to prevent the splash screen from fading in and out when its display state changes. - <preference name="FadeSplashScreen" value="false"/> +```xml + <preference name="FadeSplashScreen" value="false"/> +``` -- `FadeSplashScreenDuration` (float, defaults to `3000`): Specifies the +- `FadeSplashScreenDuration` (float, defaults to `500`): Specifies the number of milliseconds for the splash screen fade effect to execute. - <preference name="FadeSplashScreenDuration" value="3000"/> +```xml + <preference name="FadeSplashScreenDuration" value="750"/> +``` -Note also that this value used to be seconds, and not milliseconds, so values less than 30 will still be treated as seconds. ( Consider this a deprecated patch that will disapear in some future version. ) +_Note_: `FadeSplashScreenDuration` is included into `SplashScreenDelay`, for example if you have `<preference name="SplashScreenDelay" value="3000" />` and `<preference name="FadeSplashScreenDuration" value="1000"/>` defined in `config.xml`: +- 00:00 - splashscreen is shown +- 00:02 - fading has started +- 00:03 - splashscreen is hidden + +Turning the fading off via `<preference name="FadeSplashScreen" value="false"/>` technically means fading duration to be `0` so that in this example the overall splash delay will still be 3 seconds. + +_Note_: This only applies to the app startup - you need to take the fading timeout into account when manually showing/hiding the splashscreen in the code: + +```javascript +navigator.splashscreen.show(); +window.setTimeout(function () { + navigator.splashscreen.hide(); +}, splashDuration - fadeDuration); +``` - `ShowSplashScreenSpinner` (boolean, defaults to `true`): Set to `false` to hide the splash-screen spinner. - <preference name="ShowSplashScreenSpinner" value="false"/> +```xml + <preference name="ShowSplashScreenSpinner" value="false"/> +``` + +### Android Quirks + +In your `config.xml`, you can add the following preferences: + +```xml +<preference name="SplashMaintainAspectRatio" value="true|false" /> +<preference name="SplashShowOnlyFirstTime" value="true|false" /> +``` + +"SplashMaintainAspectRatio" preference is optional. If set to true, splash screen drawable is not stretched to fit screen, but instead simply "covers" the screen, like CSS "background-size:cover". This is very useful when splash screen images cannot be distorted in any way, for example when they contain scenery or text. This setting works best with images that have large margins (safe areas) that can be safely cropped on screens with different aspect ratios. + +The plugin reloads splash drawable whenever orientation changes, so you can specify different drawables for portrait and landscape orientations. + +"SplashShowOnlyFirstTime" preference is also optional and defaults to `true`. When set to `true` splash screen will only appear on application launch. However, if you plan to use `navigator.app.exitApp()` to close application and force splash screen appear on next launch, you should set this property to `false` (this also applies to closing the App with Back button). + +### Browser Quirks + +You can use the following preferences in your `config.xml`: + +```xml +<platform name="browser"> + <preference name="SplashScreen" value="/images/browser/splashscreen.jpg" /> <!-- defaults to "/img/logo.png" --> + <preference name="SplashScreenDelay" value="3000" /> <!-- defaults to "3000" --> + <preference name="SplashScreenBackgroundColor" value="green" /> <!-- defaults to "#464646" --> + <preference name="ShowSplashScreen" value="false" /> <!-- defaults to "true" --> + <preference name="SplashScreenWidth" value="600" /> <!-- defaults to "170" --> + <preference name="SplashScreenHeight" value="300" /> <!-- defaults to "200" --> +</platform> +``` + +__Note__: `SplashScreen` value should be absolute in order to work in a sub-page. The `SplashScreen` value is used only for the browser platform. The value will be ignored for other platforms. + +### iOS Quirks + +- In iOS, the splashscreen images are called launch images. These images are mandatory on iOS. + +### Windows Quirks + +- `SplashScreenSpinnerColor` (string, defaults to system accent color): hash, rgb notation or CSS color name. + +```xml +<preference name="SplashScreenSpinnerColor" value="#242424"/> +<preference name="SplashScreenSpinnerColor" value="DarkRed"/> +<preference name="SplashScreenSpinnerColor" value="rgb(50,128,128)"/> +``` + +- `SplashScreenBackgroundColor` (string, defaults to #464646): hex notation. + +```xml +<preference name="SplashScreenBackgroundColor" value="0xFFFFFFFF"/> +``` ## Methods @@ -118,7 +242,9 @@ Note also that this value used to be seconds, and not milliseconds, so values le Dismiss the splash screen. - navigator.splashscreen.hide(); +```js +navigator.splashscreen.hide(); +``` ### BlackBerry 10, WP8, iOS Quirk @@ -127,16 +253,19 @@ The `config.xml` file's `AutoHideSplashScreen` setting must be `false`. To delay hiding the splash screen for two seconds, add a timer such as the following in the `deviceready` event handler: - setTimeout(function() { - navigator.splashscreen.hide(); - }, 2000); +```js +setTimeout(function() { + navigator.splashscreen.hide(); +}, 2000); +``` ## splashscreen.show Displays the splash screen. - navigator.splashscreen.show(); - +```js +navigator.splashscreen.show(); +``` Your application cannot call `navigator.splashscreen.show()` until the app has started and the `deviceready` event has fired. But since typically the splash @@ -144,7 +273,7 @@ screen is meant to be visible before your app has started, that would seem to defeat the purpose of the splash screen. Providing some configuration in `config.xml` will automatically `show` the splash screen immediately after your app launch and before it has fully started and received the `deviceready` -event. See [Icons and Splash Screens](http://cordova.apache.org/docs/en/edge/config_ref_images.md.html) -for more information on doing this configuration. For this reason, it is -unlikely you need to call `navigator.splashscreen.show()` to make the splash +event. For this reason, it is unlikely you need to call `navigator.splashscreen.show()` to make the splash screen visible for app startup. + +[Apache Cordova issue tracker]: https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20%22Plugin%20Splashscreen%22%20ORDER%20BY%20priority%20DESC%2C%20summary%20ASC%2C%20updatedDate%20DESC |