Show a bootsplash during app startup. Hide it when you are ready.
version | react-native version |
---|---|
1.0.0+ | 0.60.0+ |
For 0.59-, you should use jetify -r
react-native-navigation
and it's a non-goal for now.
$ npm install --save react-native-bootsplash
# --- or ---
$ yarn add react-native-bootsplash
Don't forget going into the ios
directory to execute a pod install
.
Because this package targets React Native 0.60.0+, you will probably don't need to link it manually. Otherwise if it's not the case, follow this additional instructions:
👀 See manual linking instructions
Add this line to your ios/Podfile
file, then run pod install
.
target 'YourAwesomeProject' do
# …
pod 'RNBootSplash', :path => '../node_modules/react-native-bootsplash'
end
- Add the following lines to
android/settings.gradle
:
include ':react-native-bootsplash'
project(':react-native-bootsplash').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-bootsplash/android')
- Add the implementation line to the dependencies in
android/app/build.gradle
:
dependencies {
// ...
implementation project(':react-native-bootsplash')
}
- Add the import and link the package in
MainApplication.java
:
import com.zoontek.rnbootsplash.RNBootSplashPackage; // <- add the RNBootSplashPackage import
public class MainApplication extends Application implements ReactApplication {
// …
@Override
protected List<ReactPackage> getPackages() {
@SuppressWarnings("UnnecessaryLocalVariable")
List<ReactPackage> packages = new PackageList(this).getPackages();
// …
packages.add(new RNBootSplashPackage());
return packages;
}
// …
}
.xib
are supported (no .storyboard
or .launchImages
).
Edit the ios/YourProjectName/AppDelegate.m
file:
#import "AppDelegate.h"
#import <React/RCTBridge.h>
#import <React/RCTBundleURLProvider.h>
#import <React/RCTRootView.h>
#import "RNBootSplash.h" // <- add the header import
@implementation AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
// …
[self.window makeKeyAndVisible];
[RNBootSplash show:@"LaunchScreen" inView:rootView]; // <- display the "LaunchScreen" xib view over our rootView
return YES;
}
- Create a
bootsplash.xml
file inandroid/app/src/main/res/layout
(create the folder if necessary). You can customize this as you want.
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
android:orientation="vertical" android:layout_width="match_parent"
android:layout_height="match_parent"
android:gravity="center_vertical"
android:background="@android:color/white"
>
<!-- Change the background color of the splash screen with android:background. It can be a system color or a custom one defined in colors.xml -->
<ImageView
android:id="@+id/imageView"
android:layout_width="match_parent"
android:layout_height="wrap_content"
app:srcCompat="@mipmap/ic_launcher" />
<!-- Change "@mipmap/ic_launcher" to "@mipmap/bootsplash_logo" if you have used the image asset generator -->
</LinearLayout>
- Edit the
android/app/src/main/java/com/yourprojectname/MainActivity.java
file:
import android.os.Bundle; // <- add necessary import
import com.facebook.react.ReactActivity;
import com.zoontek.rnbootsplash.RNBootSplash; // <- add necessary import
public class MainActivity extends ReactActivity {
// …
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
RNBootSplash.show(R.layout.bootsplash, MainActivity.this); // <- display the "bootsplash" xml view over our MainActivity
}
import React, { useEffect } from "react";
import { Text } from "react-native";
import RNBootSplash from "react-native-bootsplash";
function App() {
let init = async () => {
// …do multiple async tasks
};
useEffect(() => {
init().finally(() => {
// without fadeout: RNBootSplash.hide()
RNBootSplash.hide({ duration: 250 });
});
}, []);
return <Text>My awesome app</Text>;
}
🤙 A more complex example is available in the /example
folder.
You can automatically updates your project assets to use a consistent looking icon!
$ npx generate-bootsplash-assets
# --- or ---
$ yarn generate-bootsplash-assets
This tool currently relies on the naming conventions that are used in the /example
project, and will therefore create the following files:
<path/to/project>/assets/bootsplash_logo.png
<path/to/project>/assets/bootsplash_logo@1,5x.png
<path/to/project>/assets/bootsplash_logo@2x.png
<path/to/project>/assets/bootsplash_logo@3x.png
<path/to/project>/assets/bootsplash_logo@4x.png
<path/to/project>/android/app/src/main/res/mipmap-mdpi/bootsplash_logo.png
<path/to/project>/android/app/src/main/res/mipmap-hdpi/bootsplash_logo.png
<path/to/project>/android/app/src/main/res/mipmap-xhdpi/bootsplash_logo.png
<path/to/project>/android/app/src/main/res/mipmap-xxhdpi/bootsplash_logo.png
<path/to/project>/android/app/src/main/res/mipmap-xxxhdpi/bootsplash_logo.png
<path/to/project>/ios/RNBootSplashExample/Images.xcassets/BootSplashLogo.imageset/bootsplash_logo.png
<path/to/project>/ios/RNBootSplashExample/Images.xcassets/BootSplashLogo.imageset/bootsplash_logo@2x.png
<path/to/project>/ios/RNBootSplashExample/Images.xcassets/BootSplashLogo.imageset/bootsplash_logo@3x.png
🕵️♂️ Comparison with react-native-splash-screen
-
If
react-native-splash-screen
encourages you to display an image over your application,react-native-bootsplash
way-to-go is to design your launch screen using platforms tools (Xcode layout editor and Android drawable resource). -
Instead of displaying the launch screen over the main
UIView
/Activity
, it will be displayed inside it. This prevents "jump" during transition (like in the example: horizontal & vertical centering using iOS auto layout or android gravity params will match perfectly the mounted component which uses{ alignItems: "center"; justifyContent: "center" }
to center its logo). -
It should not prevents you from seeing red screen errors.
-
Hiding the launch screen is configurable: fade it out with a custom duration or hide it without any animation at all (no fade needed if you want to animate it out!).