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

rnpm link react-native-splash-screen

Manual installation

Android:

1. In your

   android/settings.gradle

   file, make the following additions:

   java
   include ':react-native-splash-screen'   
   project(':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:

...
dependencies {
    ...
    implementation project(':react-native-splash-screen')
}

1. Update the MainApplication.java file to use

   react-native-splash-screen

   via the following changes:
   

// react-native-splash-screen >= 0.3.1
import org.devio.rn.splashscreen.SplashScreenReactPackage;
// react-native-splash-screen < 0.3.1
import com.cboy.rn.splashscreen.SplashScreenReactPackage;

public class MainApplication extends Application implements ReactApplication {
private final ReactNativeHost mReactNativeHost = new ReactNativeHost(this) {
    @Override
    public boolean getUseDeveloperSupport() {
        return BuildConfig.DEBUG;
    }

    @Override
    protected List<reactpackage> getPackages() {
        return Arrays.<reactpackage>asList(
                new MainReactPackage(),
        new SplashScreenReactPackage()  //here
        );
    }
};

@Override
public ReactNativeHost getReactNativeHost() {
    return mReactNativeHost;
}
}

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

react-native-splash-screen

import android.os.Bundle; // here
import com.facebook.react.ReactActivity;
// react-native-splash-screen >= 0.3.1
import org.devio.rn.splashscreen.SplashScreen; // here
// react-native-splash-screen < 0.3.1
import com.cboy.rn.splashscreen.SplashScreen; // here

public class MainActivity extends ReactActivity {
   @Override
    protected void onCreate(Bundle savedInstanceState) {
        SplashScreen.show(this);  // here
        super.onCreate(savedInstanceState);
    }
    // ...other code
}

iOS:

Update

AppDelegate.m

#import "AppDelegate.h"

#import 
#import 
#import "RNSplashScreen.h"  // here
@implementation AppDelegate

(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  // ...other code
  [RNSplashScreen show];  // here
  // or
  //[RNSplashScreen showSplash:@"LaunchScreen" inRootView:rootView];
  return YES;
}


@end

Getting started

Import

react-native-splash-screen

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

Android:

Create a file called

launch_screen.xml

app/src/main/res/layout

layout

Customize your launch screen by creating a

launch_screen.png

drawable

drawable-ldpi

drawable-mdpi

drawable-hdpi

drawable-xhdpi

drawable-xxhdpi

drawable-xxxhdpi

Add a color called

primary_dark

app/src/main/res/values/colors.xml

    #000000

Optional steps：

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

Open

android/app/src/main/res/values/styles.xml

true

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

xml


    

Create a style definition for this in

android/app/src/main/res/values/styles.xml

xml


    

Change your

show

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

iOS

Customize your splash screen via

LaunchScreen.storyboard

LaunchScreen.xib

Learn more to see examples

• via LaunchScreen.storyboard Tutorial

Usage

Use like so:

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

export default class WelcomePage extends Component {
componentDidMount() {
    // do stuff while splash screen is shown
    // After having done stuff (such as async tasks) hide the splash screen
    SplashScreen.hide();
}
}

API

| Method | Type | Optional | Description | |--------|----------|----------|-------------------------------------| | show() | 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

<ImageView android:src="@drawable/launchscreen" android:layoutwidth="matchparent" android:layoutheight="match_parent" android:scaleType="centerCrop"

```

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