- 文档
- Architectural overview of Cordova platform
- 创建你的第一个App
- Cordova平台支持
- Android平台指南
- Blackberry 10 Guides
- iOS Platform Guide
- OS X 平台指南
- Ubuntu Platform Guide
- Windows Platform Guide
- WP8 Guides
- 平台和插件版本管理
- 自定义app图标(Icon)
- 存储(Storage)
- 隐私指南
- 安全指南
- 白名单指南
- Plugin Development Guide
- Android Plugins
- BlackBerry 10 Plugins
- iOS Plugin Development Guide
- Windows Plugins
- Windows Phone 8 Plugins
- Using Plugman to Manage Plugins
- Embedding WebViews
- Next Steps
- Config.xml
- 事件
- CLI Reference
- Hooks Guide
- Plugin.xml reference documentation
- Battery Status
- Camera
- Console
- Contacts
- Device
- Device Motion
- Device Orientation
- Dialogs
- File
- File Transfer
- Geolocation
- Globalization
- Inappbrowser
- Media
- Media Capture
- Network Information
- Splashscreen
- Vibration
- Statusbar
- Whitelist
- Legacy Whitelist
Splashscreen
This plugin is required to work with splash screens. This plugin displays and hides a splash screen during application launch.
Report issues with this plugin on the Apache Cordova issue tracker.
Installation
// npm hosted (new) id
cordova plugin add cordova-plugin-splashscreen
// you may also install directly from this repo
cordova plugin add https://github.com/apache/cordova-plugin-splashscreen.git
Supported Platforms
- Amazon Fire OS
- Android
- BlackBerry 10
- iOS
- Windows Phone 7 and 8
- Windows 8
- Windows
- Browser
Example Configuration
In the top-level config.xml
file (not the one in platforms
), add configuration elements like those specified here.
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.
Directory structure:
projectRoot
hooks
platforms
plugins
www
css
img
js
res
screen
android
ios
windows
<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"/>
<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>
<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>
<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>
<preference name="SplashScreenDelay" value="10000" />
Preferences
config.xml
- AutoHideSplashScreen (boolean, default to
true
). Indicates whether to hide splash screen automatically or not. Splash screen hidden after amount of time specified in theSplashScreenDelay
preference.
<preference name="AutoHideSplashScreen" value="true" />
- SplashScreenDelay (number, default to 3000). Amount of time in milliseconds to wait before automatically hide splash screen.
<preference name="SplashScreenDelay" value="3000" />
FadeSplashScreen
(boolean, defaults totrue
): Set tofalse
to prevent the splash screen from fading in and out when its display state changes.
<preference name="FadeSplashScreen" value="false"/>
FadeSplashScreenDuration
(float, defaults to3000
): Specifies the number of milliseconds for the splash screen fade effect to execute.
<preference name="FadeSplashScreenDuration" value="3000"/>
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:
navigator.splashscreen.show();
window.setTimeout(function () {
navigator.splashscreen.hide();
}, splashDuration - fadeDuration);
ShowSplashScreenSpinner
(boolean, defaults totrue
): Set tofalse
to hide the splash-screen spinner.
<preference name="ShowSplashScreenSpinner" value="false"/>
Android Quirks
In your config.xml
, you need to add the following preferences:
<preference name="SplashScreenDelay" value="3000" />
<preference name="SplashMaintainAspectRatio" value="true|false" />
<preference name="SplashShowOnlyFirstTime" value="true|false" />
The first parameter represents how long the splashscreen will appear in milliseconds. It defaults to 3000 ms.
"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
:
<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.<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.<preference name="SplashScreenBackgroundColor" value="0xFFFFFFFF"/>
Methods
- splashscreen.show
- splashscreen.hide
splashscreen.hide
Dismiss the splash screen.
navigator.splashscreen.hide();
BlackBerry 10, WP8, iOS Quirk
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);
splashscreen.show
Displays the splash screen.
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 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. For this reason, it is unlikely you need to call navigator.splashscreen.show()
to make the splash screen visible for app startup.
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论