react-native-splash-screen

A splash screen API for react-native which can programatically hide and show the splash screen. Works on iOS and Android.

Content

• Changes
• Installation
• Examples
• Getting started
• API
• Testing
• Troubleshooting
• Contribution

Changes

For React Native >= 0.47.0 use v3.+, for React Native < 0.47.0 use v2.1.0

Examples

• Examples

Installation

First step(Download):

Run npm i react-native-splash-screen --save

Second step(Plugin Installation):

Automatic installation

react-native link react-native-splash-screen or rnpm link react-native-splash-screen

Manual installation

Android:

1. In your android/settings.gradle file, make the following additions:

1include ':react-native-splash-screen'   
2project(':react-native-splash-screen').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-splash-screen/android')

2. In your android/app/build.gradle file, add the :react-native-splash-screen project as a compile-time dependency:

1...
2dependencies {
3    ...
4    implementation project(':react-native-splash-screen')
5}

3. Update the MainApplication.java file to use react-native-splash-screen via the following changes:

1// react-native-splash-screen >= 0.3.1
2import org.devio.rn.splashscreen.SplashScreenReactPackage;
3// react-native-splash-screen < 0.3.1
4import com.cboy.rn.splashscreen.SplashScreenReactPackage;
5
6public class MainApplication extends Application implements ReactApplication {
7
8    private final ReactNativeHost mReactNativeHost = new ReactNativeHost(this) {
9        @Override
10        public boolean getUseDeveloperSupport() {
11            return BuildConfig.DEBUG;
12        }
13
14        @Override
15        protected List<ReactPackage> getPackages() {
16            return Arrays.<ReactPackage>asList(
17                    new MainReactPackage(),
18            new SplashScreenReactPackage()  //here
19            );
20        }
21    };
22
23    @Override
24    public ReactNativeHost getReactNativeHost() {
25        return mReactNativeHost;
26    }
27}

iOS:

1. cd ios
2. run pod install

OR

1. In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project's name]

2. Go to node_modules ➜ react-native-splash-screen and add SplashScreen.xcodeproj

3. In XCode, in the project navigator, select your project. Add libSplashScreen.a to your project's Build Phases ➜ Link Binary With Libraries

4. To fix 'RNSplashScreen.h' file not found, you have to select your project → Build Settings → Search Paths → Header Search Paths to add:

   $(SRCROOT)/../node_modules/react-native-splash-screen/ios

Third step(Plugin Configuration):

Android:

Update the MainActivity.java to use react-native-splash-screen via the following changes:

1import android.os.Bundle; // here
2import com.facebook.react.ReactActivity;
3// react-native-splash-screen >= 0.3.1
4import org.devio.rn.splashscreen.SplashScreen; // here
5// react-native-splash-screen < 0.3.1
6import com.cboy.rn.splashscreen.SplashScreen; // here
7
8public class MainActivity extends ReactActivity {
9   @Override
10    protected void onCreate(Bundle savedInstanceState) {
11        SplashScreen.show(this);  // here
12        super.onCreate(savedInstanceState);
13    }
14    // ...other code
15}

iOS:

Update AppDelegate.m with the following additions:

1#import "AppDelegate.h"
2
3#import <React/RCTBundleURLProvider.h>
4#import <React/RCTRootView.h>
5#import "RNSplashScreen.h"  // here
6
7@implementation AppDelegate
8
9- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
10{
11    // ...other code
12
13    [RNSplashScreen show];  // here
14    // or
15    //[RNSplashScreen showSplash:@"LaunchScreen" inRootView:rootView];
16    return YES;
17}
18
19@end
20

Getting started

Import react-native-splash-screen in your JS file.

import SplashScreen from 'react-native-splash-screen'

Android:

Create a file called launch_screen.xml in app/src/main/res/layout (create the layout-folder if it doesn't exist). The contents of the file should be the following:

1<?xml version="1.0" encoding="utf-8"?>
2<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
3    android:orientation="vertical" android:layout_width="match_parent"
4    android:layout_height="match_parent">
5    <ImageView android:layout_width="match_parent" android:layout_height="match_parent" android:src="@drawable/launch_screen" android:scaleType="centerCrop" />
6</RelativeLayout>

Customize your launch screen by creating a launch_screen.png-file and placing it in an appropriate drawable-folder. Android automatically scales drawable, so you do not necessarily need to provide images for all phone densities. You can create splash screens in the following folders:

• drawable-ldpi
• drawable-mdpi
• drawable-hdpi
• drawable-xhdpi
• drawable-xxhdpi
• drawable-xxxhdpi

Add a color called primary_dark in app/src/main/res/values/colors.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <color name="primary_dark">#000000</color>
</resources>

Optional steps：

If you want the splash screen to be transparent, follow these steps.

Open android/app/src/main/res/values/styles.xml and add <item name="android:windowIsTranslucent">true</item> to the file. It should look like this:

1<resources>
2    <!-- Base application theme. -->
3    <style name="AppTheme" parent="Theme.AppCompat.Light.NoActionBar">
4        <!-- Customize your theme here. -->
5        <!--设置透明背景-->
6        <item name="android:windowIsTranslucent">true</item>
7    </style>
8</resources>

To learn more see examples

If you want to customize the color of the status bar when the splash screen is displayed:

Create android/app/src/main/res/values/colors.xml and add

1<?xml version="1.0" encoding="utf-8"?>
2<resources>
3    <color name="status_bar_color"><!-- Colour of your status bar here --></color>
4</resources>

Create a style definition for this in android/app/src/main/res/values/styles.xml:

1<?xml version="1.0" encoding="utf-8"?>
2<resources>
3    <style name="SplashScreenTheme" parent="SplashScreen_SplashTheme">
4        <item name="colorPrimaryDark">@color/status_bar_color</item>
5    </style>
6</resources>

Change your show method to include your custom style:

1SplashScreen.show(this, R.style.SplashScreenTheme);

iOS

Customize your splash screen via LaunchScreen.storyboard or LaunchScreen.xib。

Learn more to see examples

• via LaunchScreen.storyboard Tutorial

Usage

Use like so:

1import SplashScreen from 'react-native-splash-screen'
2
3export default class WelcomePage extends Component {
4
5    componentDidMount() {
6    	// do stuff while splash screen is shown
7        // After having done stuff (such as async tasks) hide the splash screen
8        SplashScreen.hide();
9    }
10}

API

Method	Type	Optional	Description
show()	function	false	Open splash screen (Native Method )
show(final Activity activity, final boolean fullScreen)	function	false	Open splash screen (Native Method )
hide()	function	false	Close splash screen

Testing

Jest

For Jest to work you will need to mock this component. Here is an example:

// __mocks__/react-native-splash-screen.js
export default {
  show: jest.fn().mockImplementation( () => { console.log('show splash screen'); } ),
  hide: jest.fn().mockImplementation( () => { console.log('hide splash screen'); } ),
}

Troubleshooting

Splash screen always appears stretched/distorted

Add the ImageView with a scaleType in the launch_screen.xml, e.g.:

<?xml version="1.0" encoding="utf-8"?>
<FrameLayout
  xmlns:android="http://schemas.android.com/apk/res/android"
  android:layout_width="match_parent"
  android:layout_height="match_parent"
  android:orientation="vertical"
>
  <ImageView 
    android:src="@drawable/launch_screen"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:scaleType="centerCrop"
  >
  </ImageView>
</FrameLayout>

Contribution

Issues are welcome. Please add a screenshot of you bug and a code snippet. Quickest way to solve issue is to reproduce it in one of the examples.

Pull requests are welcome. If you want to change the API or do something big it is best to create an issue and discuss it first.

---

MIT Licensed