Compare commits

..

23 Commits
6.0.0 ... 6.0.2

Author SHA1 Message Date
Erisu
d2937ad489 Updated version and RELEASENOTES.md for release 6.0.2 (splashscreen-v6.0.2) 2022-07-12 18:27:16 +09:00
エリス
751b4e48c8 doc(ios): remove docs from README (migrated to cordova-docs) (#331) 2022-07-05 16:49:16 +09:00
エリス
40739f24e5 chore(android): update android engine requirement <11.0.0 (#329)
* chore(android): update android engine requirement <11.0.0
* chore(android): use re-worded engine requirement
2022-07-05 16:08:10 +09:00
Niklas Merz
144c21673d docs: fixup spaces for releasnotes (#327) 2022-04-05 13:04:16 +02:00
Niklas Merz
74b70ee1ac chore(CI): remove iOS workflow (#326)
As this plugin has no iOS code anymore we can remove the CI workflow.
2022-04-05 08:07:19 +02:00
Niklas Merz
bde626dd0f Incremented plugin version. 2022-04-04 20:08:58 +02:00
Niklas Merz
35c22a8a1a Updated version and RELEASENOTES.md for release 6.0.1 2022-04-04 19:53:13 +02:00
Niklas Merz
d28daa372a chore: update package-lock.json (#325) 2022-04-04 19:46:20 +02:00
Daniel Stone
d780b0d9d6 GH-180 (android): Fixes nav and title bars still appearing when app is fullscreen (#213)
Co-authored-by: Daniel Stone <daniel.stone@powerdms.com>
Co-authored-by: distinctdan <distinctdan@users.noreply.github.com>
2022-04-03 20:04:56 +02:00
エリス
10be9d0aac ci(ios): update workflow w/ iOS 15 (#320) 2021-10-18 22:36:00 +09:00
エリス
4a4b38b1f5 ci: add action-badge (#319) 2021-09-24 21:51:24 +09:00
エリス
1bc42204e7 ci: remove travis & appveyor (#318) 2021-09-24 21:50:15 +09:00
エリス
ea3cbb6079 ci: add gh-actions workflows (#317) 2021-09-16 22:20:29 +09:00
Ivan Koprda
8bdf669a7b fix: autofocus after splashscreen (#312)
simple input with autofocus doesn't get focus on startup on Android > 8
2021-07-28 14:46:56 +09:00
Ken Naito
66d1e00e00 fix: refocus after webview visible (#186) (#314) 2021-07-28 14:43:09 +09:00
エリス
be673a94ac ci: add node-14.x to workflow (#304) 2020-11-28 17:17:58 +09:00
Saninn Salas Diaz
642549590b chore(docs): Update missing default resources for Android #689 (#291) 2020-10-19 09:11:12 -03:00
Mosab A
b0a866cb69 Documentation Enhancement for Android Dark Mode (#293) 2020-10-17 13:59:14 -03:00
Norman Breau
eb0d0e5865 docs: Added iOS notes to supported platforms. (#300) 2020-10-17 13:57:42 -03:00
Raphael von der Grün
43f9138d1f chore(pkg): remove default-valued field "homepage" (#296)
Related to https://github.com/apache/cordova/issues/55
2020-10-04 13:34:13 +02:00
Tim Brust
7e5b4fd93d ci(travis): updates Android API level (#292) 2020-08-21 14:35:18 +00:00
Hans Krywalsky
14d17c5c64 (docs): Add Information about how to use Dark Mode SplashScreens (#286) 2020-08-08 21:13:48 +09:00
Erisu
f41610c2f7 Increment package version to 6.0.1-dev 2020-07-20 14:04:11 +09:00
14 changed files with 2648 additions and 385 deletions

View File

@@ -1,32 +0,0 @@
# appveyor file
# http://www.appveyor.com/docs/appveyor-yml
max_jobs: 1
shallow_clone: true
init:
- git config --global core.autocrlf true
image:
- Visual Studio 2017
environment:
matrix:
- nodejs_version: "10"
- nodejs_version: "12"
platform:
- x86
- x64
install:
- ps: Install-Product node $env:nodejs_version
- node --version
- npm install -g cordova-paramedic@https://github.com/apache/cordova-paramedic.git
- npm install -g cordova
build: off
test_script:
- cordova-paramedic --config pr\windows-10-store --plugin . --justBuild

148
.github/workflows/android.yml vendored Normal file
View File

@@ -0,0 +1,148 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
name: Android Testsuite
on:
push:
paths-ignore:
- '**.md'
- 'LICENSE'
- '.eslint*'
pull_request:
paths-ignore:
- '**.md'
- 'LICENSE'
- '.eslint*'
jobs:
test:
name: Android ${{ matrix.versions.android }} Test
runs-on: macos-latest
# hoist configurations to top that are expected to be updated
env:
# Storing a copy of the repo
repo: ${{ github.event.pull_request.head.repo.full_name || github.repository }}
node-version: 16
# These are the default Java configurations used by most tests.
# To customize these options, add "java-distro" or "java-version" to the strategy matrix with its overriding value.
default_java-distro: adopt
default_java-version: 8
# These are the default Android System Image configurations used by most tests.
# To customize these options, add "system-image-arch" or "system-image-target" to the strategy matrix with its overriding value.
default_system-image-arch: x86_64
default_system-image-target: google_apis # Most system images have a google_api option. Set this as default.
# configurations for each testing strategy (test matrix)
strategy:
matrix:
versions:
- android: 5.1
android-api: 22
- android: 6
android-api: 23
- android: 7
android-api: 24
- android: 7.1
android-api: 25
- android: 8
android-api: 26
- android: 8.1
android-api: 27
system-image-target: default
- android: 9
android-api: 28
- android: 10
android-api: 29
- android: 11
android-api: 30
java-version: 11
timeout-minutes: 60
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: ${{ env.node-version }}
- uses: actions/setup-java@v2
env:
java-version: ${{ matrix.versions.java-version == '' && env.default_java-version || matrix.versions.java-version }}
java-distro: ${{ matrix.versions.java-distro == '' && env.default_java-distro || matrix.versions.java-distro }}
with:
distribution: ${{ env.java-distro }}
java-version: ${{ env.java-version }}
- name: Run Environment Information
run: |
node --version
npm --version
java -version
- name: Run npm install
run: |
export PATH="/usr/local/lib/android/sdk/platform-tools":$PATH
export JAVA_HOME=$JAVA_HOME_11_X64
npm i -g cordova@latest
npm ci
- name: Run paramedic install
if: ${{ endswith(env.repo, '/cordova-paramedic') != true }}
run: npm i -g github:apache/cordova-paramedic
- uses: reactivecircus/android-emulator-runner@5de26e4bd23bf523e8a4b7f077df8bfb8e52b50e
env:
system-image-arch: ${{ matrix.versions.system-image-arch == '' && env.default_system-image-arch || matrix.versions.system-image-arch }}
system-image-target: ${{ matrix.versions.system-image-target == '' && env.default_system-image-target || matrix.versions.system-image-target }}
with:
api-level: ${{ matrix.versions.android-api }}
target: ${{ env.system-image-target }}
arch: ${{ env.system-image-arch }}
force-avd-creation: false
disable-animations: false
emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim
script: echo "Pregenerate the AVD before running Paramedic"
- name: Run paramedic tests
uses: reactivecircus/android-emulator-runner@5de26e4bd23bf523e8a4b7f077df8bfb8e52b50e
env:
system-image-arch: ${{ matrix.versions.system-image-arch == '' && env.default_system-image-arch || matrix.versions.system-image-arch }}
system-image-target: ${{ matrix.versions.system-image-target == '' && env.default_system-image-target || matrix.versions.system-image-target }}
test_config: 'android-${{ matrix.versions.android }}.config.json'
# Generally, this should automatically work for cordova-paramedic & plugins. If the path is unique, this can be manually changed.
test_plugin_path: ${{ endswith(env.repo, '/cordova-paramedic') && './spec/testable-plugin/' || './' }}
paramedic: ${{ endswith(env.repo, '/cordova-paramedic') && 'node main.js' || 'cordova-paramedic' }}
with:
api-level: ${{ matrix.versions.android-api }}
target: ${{ env.system-image-target }}
arch: ${{ env.system-image-arch }}
force-avd-creation: false
disable-animations: false
emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim
script: ${{ env.paramedic }} --config ./pr/local/${{ env.test_config }} --plugin ${{ env.test_plugin_path }}

73
.github/workflows/chrome.yml vendored Normal file
View File

@@ -0,0 +1,73 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
name: Chrome Testsuite
on:
push:
paths-ignore:
- '**.md'
- 'LICENSE'
- '.eslint*'
pull_request:
paths-ignore:
- '**.md'
- 'LICENSE'
- '.eslint*'
jobs:
test:
name: Chrome Latest Test
runs-on: ubuntu-latest
# hoist configurations to top that are expected to be updated
env:
# Storing a copy of the repo
repo: ${{ github.event.pull_request.head.repo.full_name || github.repository }}
node-version: 16
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: ${{ env.node-version }}
- name: Run install xvfb
run: sudo apt-get install xvfb
- name: Run Environment Information
run: |
node --version
npm --version
- name: Run npm install
run: |
npm i -g cordova@latest
npm ci
- name: Run paramedic install
if: ${{ endswith(env.repo, '/cordova-paramedic') != true }}
run: npm i -g github:apache/cordova-paramedic
- name: Run paramedic tests
env:
test_config: 'browser.config.json'
# Generally, this should automatically work for cordova-paramedic & plugins. If the path is unique, this can be manually changed.
test_plugin_path: ${{ endswith(env.repo, '/cordova-paramedic') && './spec/testable-plugin/' || './' }}
paramedic: ${{ endswith(env.repo, '/cordova-paramedic') && 'node main.js' || 'cordova-paramedic' }}
run: xvfb-run --auto-servernum ${{ env.paramedic }} --config ./pr/local/${{ env.test_config }} --plugin ${{ env.test_plugin_path }}

56
.github/workflows/lint.yml vendored Normal file
View File

@@ -0,0 +1,56 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
name: Lint Test
on:
push:
paths:
- '**.js'
- '.eslint*'
- '.github/workflow/lint.yml'
pull_request:
paths:
- '**.js'
- '.eslint*'
- '.github/workflow/lint.yml'
jobs:
test:
name: Lint Test
runs-on: ubuntu-latest
env:
node-version: 16
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: ${{ env.node-version }}
- name: Run Environment Information
run: |
node --version
npm --version
- name: Run npm install
run: |
npm ci
- name: Run lint test
run: |
npm run lint

View File

@@ -1,3 +1,2 @@
.*
appveyor.yml
tests

View File

@@ -1,106 +0,0 @@
# This Travis configuration file is built after a Cordova Paramedic
# specific template with minimal modifications and adaptations:
# https://github.com/apache/cordova-paramedic/blob/master/.travis.yml
sudo: false
addons:
jwt:
# sauce labs key
secure: UmbBQ73ydIzhTCfaTb/g0beTwnOHjYxlILmQYK2Tl9Gna/KbpawiVmbloX1eZakevkeYgzQmAHEF0LyDINy5AUk97azYeP0Sz/IOjIDfXAdc6U6sZb7BScneBMt6ET/hCprG4f3mbmleQ+gx+dmNWez6rlb3Xu+XWfJuwDfAWm0=
env:
global:
- SAUCE_USERNAME=snay
- TRAVIS_NODE_VERSION=12
- ANDROID_API_LEVEL=28
- ANDROID_BUILD_TOOLS_VERSION=28.0.3
language: node_js
node_js: 12
# yaml anchor/alias: https://medium.com/@tommyvn/travis-yml-dry-with-anchors-8b6a3ac1b027
_android: &_android
language: android
os: linux
jdk: oraclejdk8
android:
components:
- tools
- build-tools-$ANDROID_BUILD_TOOLS_VERSION
- android-$ANDROID_API_LEVEL
licenses:
- "android-sdk-preview-license-.+"
- "android-sdk-license-.+"
- "google-gdk-license-.+"
matrix:
include:
# one local test, without saucelabs
- env: PLATFORM=local/browser
os: osx
# many tests with saucelabs
- env: PLATFORM=browser-chrome
- env: PLATFORM=browser-firefox
- env: PLATFORM=browser-safari
- env: PLATFORM=browser-edge
- env: PLATFORM=android-5.1
<<: *_android
- env: PLATFORM=android-6.0
<<: *_android
- env: PLATFORM=android-7.0
<<: *_android
- env: PLATFORM=android-7.1
<<: *_android
- env: PLATFORM=android-8.0
<<: *_android
- env: PLATFORM=android-8.1
<<: *_android
- env: PLATFORM=android-9.0
<<: *_android
before_install:
# manually install Node for `language: android`
- if [[ "$PLATFORM" =~ android ]]; then nvm install $TRAVIS_NODE_VERSION; fi
- node --version
- if [[ "$PLATFORM" =~ android ]]; then gradle --version; fi
- npm install -g cordova
# install paramedic if not running on paramedic repo
- if ! [[ "$TRAVIS_REPO_SLUG" =~ cordova-paramedic ]]; then npm install -g github:apache/cordova-paramedic; fi
install:
- npm install
before_script:
- |
if [[ "$TRAVIS_REPO_SLUG" =~ cordova-paramedic ]]; then
# when used in the cordova-paramedic repo
TEST_COMMAND="npm run eslint"
PARAMEDIC_PLUGIN_TO_TEST="./spec/testable-plugin/"
PARAMEDIC_COMMAND="node main.js"
else
# when used in any other (plugin) repo
TEST_COMMAND="npm test"
PARAMEDIC_PLUGIN_TO_TEST=$(pwd)
PARAMEDIC_COMMAND="cordova-paramedic"
fi
- PARAMEDIC_BUILDNAME=travis-$TRAVIS_REPO_SLUG-$TRAVIS_JOB_NUMBER
- |
echo "Variables now are set to:"
echo "TEST_COMMAND=$TEST_COMMAND"
echo "ADDITIONAL_TESTS=$ADDITIONAL_TESTS"
echo "PARAMEDIC_COMMAND=$PARAMEDIC_COMMAND"
echo "PLATFORM=$PLATFORM"
echo "PARAMEDIC_PLUGIN_TO_TEST=$PARAMEDIC_PLUGIN_TO_TEST"
echo "PARAMEDIC_BUILDNAME=$PARAMEDIC_BUILDNAME"
script:
- $TEST_COMMAND
- |
if [[ "$ADDITIONAL_TESTS_DIR" != "" ]]; then
cd $ADDITIONAL_TESTS_DIR && npm install && npm test;
else
$PARAMEDIC_COMMAND --config ./pr/$PLATFORM --plugin $PARAMEDIC_PLUGIN_TO_TEST --buildName $PARAMEDIC_BUILDNAME;
fi

249
README.md
View File

@@ -21,12 +21,10 @@ description: Control the splash screen for your app.
# under the License.
-->
|AppVeyor|Travis CI|
|:-:|:-:|
|[![Build status](https://ci.appveyor.com/api/projects/status/github/apache/cordova-plugin-splashscreen?branch=master)](https://ci.appveyor.com/project/ApacheSoftwareFoundation/cordova-plugin-splashscreen)|[![Build Status](https://travis-ci.org/apache/cordova-plugin-splashscreen.svg?branch=master)](https://travis-ci.org/apache/cordova-plugin-splashscreen)|
# cordova-plugin-splashscreen
[![Android Testsuite](https://github.com/apache/cordova-plugin-splashscreen/actions/workflows/android.yml/badge.svg)](https://github.com/apache/cordova-plugin-splashscreen/actions/workflows/android.yml) [![Chrome Testsuite](https://github.com/apache/cordova-plugin-splashscreen/actions/workflows/chrome.yml/badge.svg)](https://github.com/apache/cordova-plugin-splashscreen/actions/workflows/chrome.yml) [![Lint Test](https://github.com/apache/cordova-plugin-splashscreen/actions/workflows/lint.yml/badge.svg)](https://github.com/apache/cordova-plugin-splashscreen/actions/workflows/lint.yml)
This plugin displays and hides a splash screen while your web application is launching. Using its methods you can also show and hide the splash screen manually.
- [cordova-plugin-splashscreen](#cordova-plugin-splashscreen)
@@ -38,27 +36,17 @@ This plugin displays and hides a splash screen while your web application is lau
- [Image Layout](#image-layout)
- [`density`](#density)
- [Image Sizing Table](#image-sizing-table)
- [Dark Mode (API 28+)](#dark-mode-api-28)
- [Example Android Configuration](#example-android-configuration)
- [iOS-specific Information](#ios-specific-information)
- [Launch Storyboard Images](#launch-storyboard-images)
- [Designing Launch Storyboard Images](#designing-launch-storyboard-images)
- [Scale](#scale)
- [Idioms](#idioms)
- [Size classes](#size-classes)
- [Single-image launch screen](#single-image-launch-screen)
- [Multi-image launch screen](#multi-image-launch-screen)
- [Quirks and Known Issues](#quirks-and-known-issues)
- [Windows-specific Information](#windows-specific-information)
- [Preferences](#preferences)
- [config.xml](#configxml)
- [Quirks](#quirks)
- [Android Quirks](#android-quirks)
- [Browser Quirks](#browser-quirks)
- [iOS Quirks](#ios-quirks)
- [Windows Quirks](#windows-quirks)
- [Methods](#methods)
- [splashscreen.hide](#splashscreenhide)
- [iOS Quirk](#ios-quirk)
- [splashscreen.show](#splashscreenshow)
## Installation
@@ -72,9 +60,11 @@ This plugin displays and hides a splash screen while your web application is lau
## Supported Platforms
- Android
- iOS
__Note__: Android implementation has been moved to the core framework.
If using `cordova-android@10.x` or earlier, use `cordova-plugin-splashscreen@6.x`
If using `cordova-android@11.x` or later and exclusively developing for Android, this plugin can be uninstalled.
- Windows (`cordova-windows` version >= 4.4.0 is required)
__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.
__Note__: Extended splashscreen does not require the plugin on Windows (as opposed to Android) in case you don't use the plugin API, i.e. programmatic hide/show.
- Browser
## Platform Splash Screen Image Configuration
@@ -99,7 +89,6 @@ projectRoot
res
screen
android
ios
windows
```
@@ -120,18 +109,6 @@ projectRoot
<splash src="res/screen/android/splash-port-xxxhdpi.png" density="port-xxxhdpi" />
</platform>
<platform name="ios">
<!-- Storyboard (supports all devices):
-- Note: images are determined by scale, idiom, and size traits. The following
-- are suggested based on current device form factors -->
<splash src="res/screen/ios/Default@2x~universal~anyany.png" />
<splash src="res/screen/ios/Default@2x~universal~comany.png" />
<splash src="res/screen/ios/Default@2x~universal~comcom.png" />
<splash src="res/screen/ios/Default@3x~universal~anyany.png" />
<splash src="res/screen/ios/Default@3x~universal~anycom.png" />
<splash src="res/screen/ios/Default@3x~universal~comany.png" />
</platform>
<!-- Configuration using MRT concept (Recommended, see "Windows-specific information" section for details): -->
<platform name="windows">
<splash src="res/screen/windows/splashscreen.png" target="SplashScreen"/>
@@ -177,10 +154,30 @@ If not all DPI images are considered, some devices might not show a SplashScreen
| xxhdpi | 960x1600 | 1600x960 |
| xxxhdpi | 1280x1920 | 1920x1280 |
#### Dark Mode (API 28+)
You can optionally provide an extra SplashScreen image to be used in dark/night mode when enabled on supported devices.
To do this, add the `-night` keyword in between the **layout** and **size** keywords of the image's `density` attribute value. E.g.: `land-night-hdpi`
For more examples, please see [the Example Configuration](#example-android-configuration) section.
#### Example Android Configuration
```xml
<platform name="android">
<!-- Default
Note: You should specify default resources for each density.
-- For instance, if the device(hdpi) is in landscape orientation and [density="land-hdpi"]
-- does not exists, [density="hdpi"] will be selected
If you do not declare this you will get MissingDefaultResource lint check errors.
-->
<splash src="res/screen/android/splash-port-hdpi.png" density="hdpi"/>
<splash src="res/screen/android/splash-port-ldpi.png" density="ldpi"/>
<splash src="res/screen/android/splash-port-mdpi.png" density="mdpi"/>
<splash src="res/screen/android/splash-port-xhdpi.png" density="xhdpi"/>
<splash src="res/screen/android/splash-port-xxhdpi.png" density="xxhdpi"/>
<!-- Landscape -->
<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" />
@@ -188,172 +185,31 @@ If not all DPI images are considered, some devices might not show a SplashScreen
<splash src="res/screen/android/splash-land-xxhdpi.png" density="land-xxhdpi" />
<splash src="res/screen/android/splash-land-xxxhdpi.png" density="land-xxxhdpi" />
<!-- Portrait -->
<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" />
<splash src="res/screen/android/splash-port-xxhdpi.png" density="port-xxhdpi" />
<splash src="res/screen/android/splash-port-xxxhdpi.png" density="port-xxxhdpi" />
<!-- Dark Mode -->
<splash src="res/screen/android/splash-land-night-hdpi.png" density="land-night-hdpi" />
<splash src="res/screen/android/splash-land-night-ldpi.png" density="land-night-ldpi" />
<splash src="res/screen/android/splash-land-night-mdpi.png" density="land-night-mdpi" />
<splash src="res/screen/android/splash-land-night-xhdpi.png" density="land-night-xhdpi" />
<splash src="res/screen/android/splash-land-night-xxhdpi.png" density="land-night-xxhdpi" />
<splash src="res/screen/android/splash-land-night-xxxhdpi.png" density="land-night-xxxhdpi" />
<splash src="res/screen/android/splash-port-night-hdpi.png" density="port-night-hdpi" />
<splash src="res/screen/android/splash-port-night-ldpi.png" density="port-night-ldpi" />
<splash src="res/screen/android/splash-port-night-mdpi.png" density="port-night-mdpi" />
<splash src="res/screen/android/splash-port-night-xhdpi.png" density="port-night-xhdpi" />
<splash src="res/screen/android/splash-port-night-xxhdpi.png" density="port-night-xxhdpi" />
<splash src="res/screen/android/splash-port-night-xxxhdpi.png" density="port-night-xxxhdpi" />
</platform>
```
### iOS-specific Information
Launch storyboard images are sized based on scale, idiom, and size classes. It supports all devices, and can be used with split-screen/slide-over multitasking.
There is no official support for providing a native-resolution launch image for the iPad Pro 12.9 or for providing launch images that work with split-screen multitasking or slide-over.
**Note:** Since iOS 11, for iPhone X devices and greater (with notch screen), make sure to add `viewport-fit=cover` to the viewport meta tag in your `index.html` file to display the app correctly like so: `<meta name="viewport" content="user-scalable=no, initial-scale=1, width=device-width, viewport-fit=cover">` and make some modification to your app style by adding: `padding: env(safe-area-inset-top)` to your `index.css` file to avoid the unsafe areas behind notches in the screen.
#### Launch Storyboard Images
To support newer form factors and split-screen/slide-over multitasking, launch storyboard images are used.
- images are not specific to a given device.
- images are scaled to fill the available viewport (while maintaining the aspect ratio).
- the outer edges of the images will be cropped, and the amount will vary based on device an viewport.
- there is no need to provide an image for each possible device, viewport, and orientation; iOS will choose the best image for the situation automatically.
##### Designing Launch Storyboard Images
The key to designing a launch storyboard image is understanding that the edges of the image will almost certainly be cropped. Therefore, one should not place any important information near the edges of any images provided to the launch storyboard. Only the center is a safe area, and this all but guarantees that following Apple's advice of presenting an unpopulated user interface will not work well.
Instead, the following tips should enable you to create a launch image that works across a multitude of form factors, viewports, and orientations:
- Important graphics (logos, icons, titles) should be centered. The safe bounding region will vary, so you will need to test to ensure that the important graphics are never cropped. Better yet, don't supply any important graphics in the first place.
- You _can_ fine-tune the placement and size of these graphics.
- Use a simple color wash. If you use two colors, you'll want one color to fill the top half of the image, and the second to fill the bottom half. If you use a gradient, you'll probably want to ensure that the middle of the gradient lines up with the center of the image.
- Don't worry about pixel perfection -- because the images are scaled, there's almost no chance the images will be perfectly fit to the pixel grid. Since all supported iOS devices use retina screens, users will be hard pressed to notice it anyway.
It is important to understand the concept of scale, idiom, and size class traits in order to use launch storyboard images effectively. Of the images supplied to the launch storyboard, iOS will choose the image that best matches the device and viewport and render that image. It is possible to supply only one launch image if so desired, but it is also possible to fine-tune the displayed launch image based on traits. When fine-tuning, one can ignore traits that aren't targeted or supported by the app.
##### Scale
| scale | devices |
|:-----------:|:----------------------:|
| 1x | All non-retina devices |
| 2x | Most retina devices |
| 3x | iPhone 6+/6s+,7s+ |
In general, you'll want to supply 2x and 3x images. Cordova only supports retina devices now, so there's no point in supplying 1x images.
##### Idioms
| idiom | devices |
|:-----------:|:-------------:|
| ipad | All iPads |
| iphone | All iPhones and iPod Touches |
| universal | All devices |
You only need to provide universal images unless you need to fine-tune for a specific device idiom.
##### Size classes
There are two size classes applies to both screen axes. Narrow viewports are considered to be the "compact" size class, and remaining viewports are considered "regular". When supplying images to Xcode, however, one must choose between "any & compact" and "any & regular". To stay consistent with the native terminology, this feature will match based on "any" and "compact". `any` will match regular-sized viewports.
Note: this feature uses `com` as an abbreviation for "compact" classes.
The following classes are supported by this feature:
| width | height | orientation |
|:-----------:|:------------:|:-----------------:|
| any | any | any |
| com | any | portrait |
| any | com | landscape (wide) |
| com | com | landscape (narrow)|
To see the complete list of size classes associated with devices and viewports, see <http://www.sizeclasses.com>.
##### Single-image launch screen
If your launch image is simple, you may be able to avoid creating a lot of different launch images and supply only one. The launch image needs to meet the following requirements:
- the image should be square
- the image should be large enough to fit on an iPad Pro 12.9": 2732x2732
- anything important should fit within the center
Keep in mind that the image will be cropped, possibly quite severely, depending upon the viewport.
Once the image is created, you can include it in your project by adding the following to `config.xml`:
```xml
<splash src="res/screen/ios/Default@2x~universal~anyany.png" />
```
Because only one image is provided, iOS will utilize it in every context.
##### Multi-image launch screen
If a single launch image won't meet your needs, you will probably need to supply at least six images, if not more. Furthermore, keep in mind that it will not be possible to fine tune the image to a specific device, but only to a device class, display factor, and viewport size.
If you don't need to target images to a specific idiom, you should create six images, as follows:
| scale | idiom | width | height | size | filename |
|:-----------:|:-----------:|:-----------:|:------------:|:----------:|:--------------:|
| 2x* | universal | any | any | 2732x2732 | `Default@2x~universal~anyany.png` |
| 2x | universal | com | any | 1278x2732 | `Default@2x~universal~comany.png` |
| 2x | universal | com | com | 1334x750 | `Default@2x~universal~comcom.png` |
| 3x* | universal | any | any | 2208x2208 | `Default@3x~universal~anyany.png` |
| 3x | universal | any | com | 2208x1242 | `Default@3x~universal~anycom.png` |
| 3x | universal | com | any | 1242x2208 | `Default@3x~universal~comany.png` |
\* this image is required in order for iOS utilize the other images within this scale and idiom.
> Note: If the 3x sizes look small too you, that's because there's only one device class that currently has a 3x density: the iPhone 6+/6s+/7+.
The above looks like the following snippet when present in `config.xml`:
```xml
<splash src="res/screen/ios/Default@2x~universal~anyany.png" />
<splash src="res/screen/ios/Default@2x~universal~comany.png" />
<splash src="res/screen/ios/Default@2x~universal~comcom.png" />
<splash src="res/screen/ios/Default@3x~universal~anyany.png" />
<splash src="res/screen/ios/Default@3x~universal~anycom.png" />
<splash src="res/screen/ios/Default@3x~universal~comany.png" />
```
Should one need to further fine tune based upon device idiom, one can do so. This might look like so:
| scale | idiom | width | height | size | filename |
|:-----------:|:-----------:|:-----------:|:------------:|:----------:|:--------------:|
| 2x* | iphone | any | any | 1334x1334 | `Default@2x~iphone~anyany.png` |
| 2x | iphone | com | any | 750x1334 | `Default@2x~iphone~comany.png` |
| 2x | iphone | com | com | 1334x750 | `Default@2x~iphone~comcom.png` |
| 3x* | iphone | any | any | 2208x2208 | `Default@3x~iphone~anyany.png` |
| 3x | iphone | any | com | 2208x1242 | `Default@3x~iphone~anycom.png` |
| 3x | iphone | com | any | 1242x2208 | `Default@3x~iphone~comany.png` |
| 2x* | ipad | any | any | 2732x2732 | `Default@2x~ipad~anyany.png` |
| 2x | ipad | com | any | 1278x2732 | `Default@2x~ipad~comany.png` |
\* this image is required in order for iOS utilize the other images within this scale and idiom.
The above looks like the following in `config.xml`:
```xml
<splash src="res/screen/ios/Default@2x~iphone~anyany.png" />
<splash src="res/screen/ios/Default@2x~iphone~comany.png" />
<splash src="res/screen/ios/Default@2x~iphone~comcom.png" />
<splash src="res/screen/ios/Default@3x~iphone~anyany.png" />
<splash src="res/screen/ios/Default@3x~iphone~anycom.png" />
<splash src="res/screen/ios/Default@3x~iphone~comany.png" />
<splash src="res/screen/ios/Default@2x~ipad~anyany.png" />
<splash src="res/screen/ios/Default@2x~ipad~comany.png" />
```
##### Quirks and Known Issues
1. **App on target may not reflect changes to images**
Once you run the app on a target, iOS caches the launch image. Unfortunately, when you change the image, iOS does _not_ invalidate the cache, which means you'll still see the old launch image. You should either: delete the app, or reset content & settings (simulator).
2. **Simulator may not show expected images when launched from CLI**
When Xcode deploys to a specific simulator, it only copies the assets that match the simulator's characteristics. For example, if you try to run an app on the iPhone 6s Plus simulator, only @3x launch images are copied. When compiling from the CLI, however, the default is to assume an iPhone 5s, which means only @2x launch images are copied. Unless your launch images are markedly different, chances are good the difference would go unnoticed, but this does mean that the only accurate method of testing is to test on a physical device.
3. **`anyany` must be provided for other variations to be used**
If you don't provide an `anyany` version of the launch image for a specific scale and idiom, the other variations (like `anycom`, `comany`, and `comcom`) will ignored.
### Windows-specific Information
Splash screen images can be defined using the [MRT](https://cordova.apache.org/docs/en/dev/config_ref/images.html#windows) concept.
@@ -405,8 +261,6 @@ __Note__: You may need to reopen Visual Studio solution after changing the image
**Windows Quirk**: You should disable the splashscreen in case you are updating the entire document body dynamically (f.e. with a SPA router) to avoid affecting UI/controls.
Note that you should also directly reference `WinJS/base.js` in the page HTML in this case to avoid the issues with activation context ([CB-11658](https://issues.apache.org/jira/browse/CB-11658)).
**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.
@@ -486,10 +340,6 @@ You can use the following preferences in your `config.xml`:
__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 splash screen 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.
@@ -519,19 +369,6 @@ Dismiss the splash screen.
navigator.splashscreen.hide();
```
#### 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:
```js
setTimeout(function() {
navigator.splashscreen.hide();
}, 2000);
```
### splashscreen.show
Displays the splash screen.

View File

@@ -20,6 +20,30 @@
-->
# Release Notes
### 6.0.2 (Jul 12, 2022)
* [GH-331](https://github.com/apache/cordova-plugin-splashscreen/pull/331) doc(ios): remove docs from `README` (migrated to cordova-docs)
* [GH-329](https://github.com/apache/cordova-plugin-splashscreen/pull/329) chore(android): update **Android** engine requirement `<11.0.0`
* [GH-327](https://github.com/apache/cordova-plugin-splashscreen/pull/327) docs: fixup spaces for releasnotes
* [GH-326](https://github.com/apache/cordova-plugin-splashscreen/pull/326) chore(CI): remove **iOS** workflow
### 6.0.1 (Apr 04, 2022)
* [GH-325](https://github.com/apache/cordova-plugin-splashscreen/pull/325) chore: update package-lock.json
* [GH-213](https://github.com/apache/cordova-plugin-splashscreen/pull/213) GH-180 (android): Fixes nav and title bars still appearing when app is fullscreen
* [GH-320](https://github.com/apache/cordova-plugin-splashscreen/pull/320) ci(ios): update workflow w/ **iOS** 15
* [GH-319](https://github.com/apache/cordova-plugin-splashscreen/pull/319) ci: add action-badge
* [GH-318](https://github.com/apache/cordova-plugin-splashscreen/pull/318) ci: remove travis & appveyor
* [GH-317](https://github.com/apache/cordova-plugin-splashscreen/pull/317) ci: add gh-actions workflows
* [GH-312](https://github.com/apache/cordova-plugin-splashscreen/pull/312) fix: autofocus after splashscreen
* [GH-314](https://github.com/apache/cordova-plugin-splashscreen/pull/314) fix: refocus after webview visible (#186)
* [GH-304](https://github.com/apache/cordova-plugin-splashscreen/pull/304) ci: add node-14.x to workflow
* [GH-291](https://github.com/apache/cordova-plugin-splashscreen/pull/291) chore(docs): Update missing default resources for **Android** #689
* [GH-293](https://github.com/apache/cordova-plugin-splashscreen/pull/293) Documentation Enhancement for **Android** Dark Mode
* [GH-300](https://github.com/apache/cordova-plugin-splashscreen/pull/300) docs: Added **iOS** notes to supported platforms.
* [GH-296](https://github.com/apache/cordova-plugin-splashscreen/pull/296) chore(pkg): remove default-valued field "homepage"
* [GH-292](https://github.com/apache/cordova-plugin-splashscreen/pull/292) ci(travis): updates **Android** API level
* [GH-286](https://github.com/apache/cordova-plugin-splashscreen/pull/286) (docs): Add Information about how to use Dark Mode SplashScreens
### 6.0.0 (Jul 07, 2020)
* [GH-282](https://github.com/apache/cordova-plugin-splashscreen/pull/282) fix: js `clobber` only on supported platforms

2285
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,6 @@
{
"name": "cordova-plugin-splashscreen",
"version": "6.0.0",
"version": "6.0.2",
"description": "Cordova Splashscreen Plugin",
"types": "./types/index.d.ts",
"cordova": {
@@ -34,6 +34,10 @@
"cordova-android": ">=3.6.0",
"cordova-windows": ">=4.4.0"
},
"6.0.2": {
"cordova-android": ">=3.6.0 <11.0.0",
"cordova-windows": ">=4.4.0"
},
"7.0.0": {
"cordova": ">100"
}
@@ -43,6 +47,5 @@
"license": "Apache-2.0",
"devDependencies": {
"@cordova/eslint-config": "^3.0.0"
},
"homepage": "https://github.com/apache/cordova-plugin-splashscreen#readme"
}
}

View File

@@ -20,7 +20,7 @@
<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
id="cordova-plugin-splashscreen"
version="6.0.0">
version="6.0.2">
<name>Splashscreen</name>
<description>Cordova Splashscreen Plugin</description>
<license>Apache 2.0</license>
@@ -29,7 +29,7 @@
<issue>https://github.com/apache/cordova-plugin-splashscreen/issues</issue>
<engines>
<engine name="cordova-android" version=">=3.6.0" /><!-- Requires CordovaPlugin.preferences -->
<engine name="cordova-android" version=">=3.6.0 <11.0.0" /><!-- Requires CordovaPlugin.preferences -->
<engine name="cordova-windows" version=">=4.4.0" />
</engines>

View File

@@ -32,6 +32,7 @@ import android.view.Display;
import android.view.Gravity;
import android.view.View;
import android.view.ViewGroup.LayoutParams;
import android.view.Window;
import android.view.WindowManager;
import android.view.animation.Animation;
import android.view.animation.AlphaAnimation;
@@ -194,6 +195,7 @@ public class SplashScreen extends CordovaPlugin {
} else if ("spinner".equals(id)) {
if ("stop".equals(data.toString())) {
getView().setVisibility(View.VISIBLE);
getView().requestFocus();
}
} else if ("onReceivedError".equals(id)) {
this.spinnerStop();
@@ -314,16 +316,48 @@ public class SplashScreen extends CordovaPlugin {
// Create and show the dialog
splashDialog = new Dialog(context, android.R.style.Theme_Translucent_NoTitleBar);
// check to see if the splash screen should be full screen
if ((cordova.getActivity().getWindow().getAttributes().flags & WindowManager.LayoutParams.FLAG_FULLSCREEN)
== WindowManager.LayoutParams.FLAG_FULLSCREEN) {
splashDialog.getWindow().setFlags(WindowManager.LayoutParams.FLAG_FULLSCREEN,
// Check to see if the splash screen should be full screen.
// On first run, currently cordova hasn't set the window flags yet because it does it in
// onWindowFocusChanged instead of onCreate. If that's the case, we'll fall back to the
// Fullscreen preference. Hopefully it will get fixed so that cordova sets them in onCreate,
// so that this fallback can be removed.
boolean isFullscreen = false;
int mainWindowFlags = cordova.getActivity().getWindow().getAttributes().flags;
boolean flagFullscreen = (mainWindowFlags & WindowManager.LayoutParams.FLAG_FULLSCREEN)
== WindowManager.LayoutParams.FLAG_FULLSCREEN;
boolean flagForceNotFullscreen = (mainWindowFlags & WindowManager.LayoutParams.FLAG_FORCE_NOT_FULLSCREEN)
== WindowManager.LayoutParams.FLAG_FORCE_NOT_FULLSCREEN;
// If cordova has set flags, one of these must be true.
if (flagFullscreen || flagForceNotFullscreen) {
isFullscreen = flagFullscreen;
} else {
// Cordova hasn't set flags, fall back to reading preference.
isFullscreen = preferences.getBoolean("Fullscreen", false);
}
Window dialogWindow = splashDialog.getWindow();
if (isFullscreen) {
dialogWindow.setFlags(WindowManager.LayoutParams.FLAG_FULLSCREEN,
WindowManager.LayoutParams.FLAG_FULLSCREEN);
}
splashDialog.setContentView(splashImageView);
splashDialog.setCancelable(false);
splashDialog.show();
if (isFullscreen) {
// These must be set after .show() is called because they only work on visible views.
// When the splashscreen hides, the app will revert to whatever was set in CordovaActivity
dialogWindow.getDecorView().setSystemUiVisibility(
View.SYSTEM_UI_FLAG_LAYOUT_STABLE
| View.SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION
| View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN
| View.SYSTEM_UI_FLAG_HIDE_NAVIGATION
| View.SYSTEM_UI_FLAG_FULLSCREEN
| View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
}
if (preferences.getBoolean("ShowSplashScreenSpinner", true)) {
spinnerStart();
}

View File

@@ -1,6 +1,6 @@
{
"name": "cordova-plugin-splashscreen-tests",
"version": "6.0.0",
"version": "6.0.2",
"description": "",
"cordova": {
"id": "cordova-plugin-splashscreen-tests",

View File

@@ -20,7 +20,7 @@
<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
id="cordova-plugin-splashscreen-tests"
version="6.0.0">
version="6.0.2">
<name>Cordova Splashscreen Plugin Tests</name>
<license>Apache 2.0</license>