react-native-bootsplash-cli-fork

This is a fork of react-native-bootsplash CLI. Fork allows generating dark mode splash screens. Fork is based on original react-native-bootsplash CLI with following changes:

• New parameter: --dark-logo [path], allows to specify different logo for dark mode themes
• New parameter: --dark-background-color [color], allows to specify different background color for dark mode themes

Note: this is NOT a fork/replacement of react-native-bootsplash itself! You still need to install and configure react-native-bootsplash according to instructions. This library could be used as a replacement of Assets generation step.

Installation

1$ npm install --save-dev react-native-bootsplash-cli-fork
2# --- or ---
3$ yarn add -D react-native-bootsplash-cli-fork

Usage

CLI could generate assets, create the Android Drawable XML file and the iOS Storyboard file automatically ✨.

1$ npx react-native generate-bootsplash-fork --help
2# --- or ---
3$ yarn react-native generate-bootsplash-fork --help

The command can take multiple arguments:

1yarn react-native generate-bootsplash-fork <logoPath>
2
3Generate a launch screen using an original logo file
4
5Options:
6  --background-color <color>       color used as launch screen background (in hexadecimal format) (default: "#fff")
7  --logo-width <width>             logo width at @1x (in dp - we recommend approximately ~100) (default: 100)
8  --assets-path [path]             path to your static assets directory (useful to require the logo file in JS)
9  --flavor <flavor>                [android only] flavor build variant (outputs in an android resource directory other than "main")
10  --dark-logo [path]          [optional] if specified, will be used for splashscreen that is shown when phone is in dark mode
11  --dark-background-color <color>  [optional] color used as launch screen background when phone is in dark mode (in hexadecimal format) (default: "#000"). Only used if --dark-logo-path is set!
12  -h, --help                  output usage information

Full command usage example

1yarn react-native generate-bootsplash assets/bootsplash_logo_original.png \
2  --background-color=F5FCFF \
3  --dark-logo=assets/bootsplash_logo_dark.png \
4  --logo-width=100 \
5  --assets-path=assets \
6  --flavor=main

This tool generates assets that could later be used by react-native-bootsplash:

1# Only if --assets-path was specified
2assets/bootsplash_logo.png
3assets/bootsplash_logo@1,5x.png
4assets/bootsplash_logo@2x.png
5assets/bootsplash_logo@3x.png
6assets/bootsplash_logo@4x.png
7# if dark logo is specified
8assets/bootsplash_logo_dark.png
9assets/bootsplash_logo_dark@1,5x.png
10assets/bootsplash_logo_dark@2x.png
11assets/bootsplash_logo_dark@3x.png
12assets/bootsplash_logo_dark@4x.png
13
14android/app/src/main/res/values/colors.xml (creation and addition)
15android/app/src/main/res/values-night/colors.xml
16android/app/src/main/res/mipmap-hdpi/bootsplash_logo.png
17android/app/src/main/res/mipmap-mdpi/bootsplash_logo.png
18android/app/src/main/res/mipmap-xhdpi/bootsplash_logo.png
19android/app/src/main/res/mipmap-xxhdpi/bootsplash_logo.png
20android/app/src/main/res/mipmap-xxxhdpi/bootsplash_logo.png
21# if dark logo is specified
22android/app/src/main/res/mipmap-hdpi/bootsplash_logo_dark.png
23android/app/src/main/res/mipmap-mdpi/bootsplash_logo_dark.png
24android/app/src/main/res/mipmap-xhdpi/bootsplash_logo_dark.png
25android/app/src/main/res/mipmap-xxhdpi/bootsplash_logo_dark.png
26android/app/src/main/res/mipmap-xxxhdpi/bootsplash_logo_dark.png
27
28
29ios/YourProjectName/BootSplash.storyboard
30ios/YourProjectName/Images.xcassets/BootSplashLogo.imageset/bootsplash_logo.png
31ios/YourProjectName/Images.xcassets/BootSplashLogo.imageset/bootsplash_logo@2x.png
32ios/YourProjectName/Images.xcassets/BootSplashLogo.imageset/bootsplash_logo@3x.png
33# if dark logo is specified
34ios/YourProjectName/Images.xcassets/BootSplashLogo.imageset/bootsplash_logo_dark.png
35ios/YourProjectName/Images.xcassets/BootSplashLogo.imageset/bootsplash_logo_dark@2x.png
36ios/YourProjectName/Images.xcassets/BootSplashLogo.imageset/bootsplash_logo_dark@3x.png

If you want to have different splashscreen in Dark Mode, also create/edit the android/app/src/main/res/values-night/styles.xml:

1<resources>
2  <!-- BootTheme should inherit from Theme.SplashScreen -->
3  <style name="BootTheme" parent="Theme.SplashScreen">
4    <item name="windowSplashScreenAnimatedIcon">@mipmap/bootsplash_logo_dark</item>
5    <item name="windowSplashScreenBackground">@color/bootsplash_background</item>
6    <item name="postSplashScreenTheme">@style/AppTheme</item>
7  </style>
8
9</resources>