diff --git a/README.md b/README.md index 65d25fe..36f56c1 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,7 @@ 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](#dark-mode) - [Example Android Configuration](#example-android-configuration) - [iOS-specific Information](#ios-specific-information) - [Launch Storyboard Images](#launch-storyboard-images) @@ -47,6 +48,7 @@ This plugin displays and hides a splash screen while your web application is lau - [Size classes](#size-classes) - [Single-image launch screen](#single-image-launch-screen) - [Multi-image launch screen](#multi-image-launch-screen) + - [Dark Mode](#dark-mode-1) - [Quirks and Known Issues](#quirks-and-known-issues) - [Windows-specific Information](#windows-specific-information) - [Preferences](#preferences) @@ -177,6 +179,13 @@ 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 @@ -194,6 +203,21 @@ If not all DPI images are considered, some devices might not show a SplashScreen + + + + + + + + + + + + + + + ``` @@ -343,6 +367,23 @@ The above looks like the following in `config.xml`: ``` +##### Dark Mode + +Since [Cordova-iOS@6.1.0](https://github.com/apache/cordova-ios), it is now possible to optionally specify different SplashScreen images to use when the app is running in dark mode. The luminosity of SplashScreen images can be defined in `config.xml` using the `~dark` and `~light` suffixes. + +```xml + + + + + + + + +``` + +**Note:** This works since iOS 13. iOS 12 and below will use the default SplashScreen without a luminosity suffix specified. + ##### Quirks and Known Issues 1. **App on target may not reflect changes to images**