react-native-splashscreens
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

react-native-splashscreens

Download PRs Welcome react-native-splashscreens release 语言 中文 License MIT 原理 解析 Flutter

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

Content

Changes

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

Examples

react-native-splashscreens-Android react-native-splashscreens-iOS

Installation

First step(Download):

Run npm i react-native-splashscreens --save

Second step(Plugin Installation):

Automatic installation

react-native link react-native-splashscreens or rnpm link react-native-splashscreens

Manual installation

Android:

  1. In your android/settings.gradle file, make the following additions:
include ':react-native-splashscreens'
project(':react-native-splashscreens').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-splashscreens/android')
  1. In your android/app/build.gradle file, add the :react-native-splashscreens project as a compile-time dependency:
...
dependencies {
    ...
    implementation project(':react-native-splashscreens')
}
  1. Update the MainApplication.java file to use react-native-splashscreens via the following changes:
// react-native-splashscreens >= 0.3.1 
import org.devio.rn.splashscreens.splashscreensReactPackage;
// react-native-splashscreens < 0.3.1 
import com.cboy.rn.splashscreens.splashscreensReactPackage;
 
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 splashscreensReactPackage()  //here 
            );
        }
    };
 
    @Override
    public ReactNativeHost getReactNativeHost() {
        return mReactNativeHost;
    }
}

iOS:

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

  2. Go to node_modulesreact-native-splashscreens and add splashscreens.xcodeproj

  3. In XCode, in the project navigator, select your project. Add libsplashscreens.a to your project's Build PhasesLink Binary With Libraries

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

    $(SRCROOT)/../node_modules/react-native-splashscreens/ios

Third step(Plugin Configuration):

Android:

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

import android.os.Bundle; // here 
import com.facebook.react.ReactActivity;
// react-native-splashscreens >= 0.3.1 
import org.devio.rn.splashscreens.splashscreens; // here 
// react-native-splashscreens < 0.3.1 
import com.cboy.rn.splashscreens.splashscreens; // here 
 
public class MainActivity extends ReactActivity {
   @Override
    protected void onCreate(Bundle savedInstanceState) {
        splashscreens.show(this);  // here 
        super.onCreate(savedInstanceState);
    }
    // ...other code 
}

iOS:

Update AppDelegate.m with the following additions:

#import "AppDelegate.h"
 
#import <React/RCTBundleURLProvider.h>
#import <React/RCTRootView.h>
#import "RNsplashscreens.h"  // here
 
@implementation AppDelegate
 
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    // ...other code
 
    [RNsplashscreens show];  // here
    // or
    //[RNsplashscreens showSplash:@"LaunchScreen" inRootView:rootView];
    return YES;
}
 
@end
 

Getting started

Import react-native-splashscreens in your JS file.

import splashscreens from 'react-native-splashscreens'

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:

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

<resources>
    <!-- Base application theme. -->
    <style name="AppTheme" parent="Theme.AppCompat.Light.NoActionBar">
        <!-- Customize your theme here. -->
        <!--设置透明背景-->
        <item name="android:windowIsTranslucent">true</item>
    </style>
</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

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

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

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <style name="splashscreensTheme" parent="splashscreens_SplashTheme">
        <item name="colorPrimaryDark">@color/status_bar_color</item>
    </style>
</resources>

Change your show method to include your custom style:

splashscreens.show(this, R.style.splashscreensTheme);

iOS

Customize your splash screen via LaunchImage or LaunchScreen.xib,

Learn more to see examples

Usage

Use like so:

import splashscreens from 'react-native-splashscreens';
 
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
    splashscreens.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-splashscreens.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

Package Sidebar

Install

npm i react-native-splashscreens

Weekly Downloads

1

Version

1.0.1

License

MIT

Unpacked Size

39.5 kB

Total Files

21

Last publish

Collaborators

  • faisalali19