cordova-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [cordova-docs] erisu commented on a change in pull request #989: Update Splashscreen Plugin Doc for Cordova 9.x
Date Wed, 05 Aug 2020 12:13:38 GMT

erisu commented on a change in pull request #989:
URL: https://github.com/apache/cordova-docs/pull/989#discussion_r465681716



##########
File path: www/docs/en/9.x/reference/cordova-plugin-splashscreen/index.md
##########
@@ -47,12 +64,96 @@ This plugin is required to work with splash screens. This plugin displays
and hi
 
 - Android
 - iOS
-- Windows (`cordova-windows` version >= 4.4.0 is required)
+- 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.
 - Browser
 
-__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.
+## Platform Splash Screen Image Configuration
 
-### iOS-specific information
+### Example Configuration
+
+In the top-level `config.xml` file (not the one in `platforms`), add configuration elements
like those specified here.
+
+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 file whatever
you like. The internal name in the application is automatically determined by Cordova.
+
+Directory structure:
+
+```
+projectRoot
+    hooks
+    platforms
+    plugins
+    www
+        css
+        img
+        js
+    res
+        screen
+            android
+            ios
+            windows
+```
+
+```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"/>
+    <splash src="res/screen/android/splash-land-xxhdpi.png" density="land-xxhdpi"/>
+
+    <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"/>
+</platform>
+
+<platform name="ios">
+    <!-- There are two mechanisms for showing launch images.
+      -- Legacy method (supports all devices except iPad Pro 12.9):
+      -- Note: 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"/>

Review comment:
       This is Cordova 9 docs which should still reference this.
   Dev & Cordova 10 should have it removed remove it when pulled.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org


Mime
View raw message