public/cordova-plugin-splashscreen
public/cordova-plugin-splashscreen
8
0
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme

Browse Source 
This closes #116
This commit is contained in:
MartijnW49 2017-09-22 18:23:14 +02:00 committed by Steve Gill
parent c2c3a980e1
commit 7cb318727b
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -436,6 +436,7 @@ In your `config.xml`, you can add the following preferences:
```xml
<preference name="SplashMaintainAspectRatio" value="true|false" />
<preference name="SplashShowOnlyFirstTime" value="true|false" />
<preference name="SplashScreenSpinnerColor" value="white" />
```
"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.
@ -444,6 +445,8 @@ The plugin reloads splash drawable whenever orientation changes, so you can spec
"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).
"SplashScreenSpinnerColor" preference is also optional and is ignored when not set. Setting it to a valid color name or HEX color code will change the color of the spinner on Android 5.0+ devices.
### Browser Quirks
You can use the following preferences in your `config.xml`: