react-native-bootsplash 4.0.0-beta.1 → 4.0.0-beta.2

package/README.md

@@ -15,9 +15,14 @@ Show a bootsplash during app startup. Hide it when you are ready.
 
 <p>
   <img height="520" src="https://raw.githubusercontent.com/zoontek/react-native-bootsplash/HEAD/docs/ios_demo.gif?raw=true" alt="iOS demo"></img>
-  <img width="300" src="https://raw.githubusercontent.com/zoontek/react-native-bootsplash/HEAD/docs/android_demo.gif?raw=true" alt="android demo"></img>
+  <img height="500" src="https://raw.githubusercontent.com/zoontek/react-native-bootsplash/HEAD/docs/android_demo.gif?raw=true" alt="android demo"></img>
 </p>
 
+**⚠️ You are currently reading the 4.x version documentation, which is still in beta.**<br>
+**For the stable version, check the [`3.2.6` tag `README.md`](https://github.com/zoontek/react-native-bootsplash/tree/3.2.6).**
+
+**For migration from the v3, check the [`MIGRATION.md` file](https://github.com/zoontek/react-native-bootsplash/blob/master/MIGRATION.md).**
+
 ## Support
 
 | version | react-native version |
@@ -28,16 +33,16 @@ Show a bootsplash during app startup. Hide it when you are ready.
 ## Installation
 
 ```bash
-$ npm install --save react-native-bootsplash
+$ npm install --save react-native-bootsplash@next
 # --- or ---
-$ yarn add react-native-bootsplash
+$ yarn add react-native-bootsplash@next
 ```
 
 Don't forget going into the `ios` directory to execute a `pod install`.
 
 ## 🆘 Manual linking
 
-Because this package targets React Native 0.65.0+, you will probably don't need to link it manually. Otherwise if it's not the case, follow this additional instructions:
+Because this package targets React Native 0.65.0+, you probably don't need to link it manually. But if you have a special case, follow these additional instructions:
 
 <details>
   <summary><b>👀 See manual linking instructions</b></summary>
@@ -116,7 +121,7 @@ Generate a launch screen using an original logo file
 
 Options:
   --background-color <color>  color used as launch screen background (in hexadecimal format) (default: "#fff")
-  --logo-width <width>        logo width at @1x (in dp - we recommand approximately ~100) (default: 100)
+  --logo-width <width>        logo width at @1x (in dp - we recommend approximately ~100) (default: 100)
   --assets-path [path]        path to your static assets directory (useful to require the logo file in JS)
   --flavor <flavor>           [android only] flavor build variant (outputs in an android resource directory other than "main")
   -h, --help                  output usage information
@@ -201,65 +206,78 @@ Set the `BootSplash.storyboard` as launch screen file:
 buildscript {
   ext {
     buildToolsVersion = "30.0.2"
-    minSdkVersion = 23 // <- set at least 23
+    minSdkVersion = 23 // <- AndroidX splashscreen has basic support for 21 (only the background color), so 23 is best
     compileSdkVersion = 31 // <- set at least 31
     targetSdkVersion = 31 // <- set at least 31
 
     // …
 ```
 
-2. Edit the `android/app/src/main/res/values/styles.xml` file:
+2. Then edit your `android/app/build.gradle` file:
+
+```gradle
+dependencies {
+  implementation fileTree(dir: "libs", include: ["*.jar"])
+  //noinspection GradleDynamicVersion
+  implementation "com.facebook.react:react-native:+"  // From node_modules
+
+  implementation "androidx.core:core-splashscreen:1.0.0-alpha02" // Add this line
+
+  // …
+```
+
+3. Edit your `android/app/src/main/res/values/styles.xml` file:
 
 ```xml
 <resources>
 
-    <style name="AppTheme" parent="Theme.AppCompat.DayNight.NoActionBar">
-        <!-- Your base theme customization -->
-    </style>
+  <style name="AppTheme" parent="Theme.AppCompat.DayNight.NoActionBar">
+      <!-- Your base theme customization -->
+  </style>
 
-    <!-- BootTheme should inherit from Theme.SplashScreen -->
-    <style name="BootTheme" parent="Theme.SplashScreen">
-        <item name="windowSplashScreenBackground">@color/bootsplash_background</item>
-        <item name="windowSplashScreenAnimatedIcon">@mipmap/bootsplash_logo</item>
-        <item name="postSplashScreenTheme">@style/AppTheme</item>
-    </style>
+  <!-- BootTheme should inherit from Theme.SplashScreen -->
+  <style name="BootTheme" parent="Theme.SplashScreen">
+    <item name="windowSplashScreenBackground">@color/bootsplash_background</item>
+    <item name="windowSplashScreenAnimatedIcon">@mipmap/bootsplash_logo</item>
+    <item name="postSplashScreenTheme">@style/AppTheme</item>
+  </style>
 
 </resources>
 ```
 
-3. Edit the `android/app/src/main/AndroidManifest.xml` file:
+4. Edit your `android/app/src/main/AndroidManifest.xml` file:
 
 ```xml
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
   package="com.rnbootsplashexample">
 
-    <!-- … -->
-
-    <application
-        android:name=".MainApplication"
-        android:label="@string/app_name"
-        android:icon="@mipmap/ic_launcher"
-        android:roundIcon="@mipmap/ic_launcher_round"
-        android:allowBackup="false"
-        android:theme="@style/BootTheme"> <!-- Replace @style/AppTheme with @style/BootTheme -->
-        <activity
-        android:name=".MainActivity"
-        android:label="@string/app_name"
-        android:configChanges="keyboard|keyboardHidden|orientation|screenSize|uiMode"
-        android:launchMode="singleTask"
-        android:windowSoftInputMode="adjustResize"
-        android:exported="true"> <!-- Add android:exported="true" -->
-        <intent-filter>
-            <action android:name="android.intent.action.MAIN" />
-            <category android:name="android.intent.category.LAUNCHER" />
-        </intent-filter>
-        </activity>
-    </application>
+  <!-- … -->
+
+  <application
+    android:name=".MainApplication"
+    android:label="@string/app_name"
+    android:icon="@mipmap/ic_launcher"
+    android:roundIcon="@mipmap/ic_launcher_round"
+    android:allowBackup="false"
+    android:theme="@style/BootTheme"> <!-- Replace @style/AppTheme with @style/BootTheme -->
+    <activity
+    android:name=".MainActivity"
+    android:label="@string/app_name"
+    android:configChanges="keyboard|keyboardHidden|orientation|screenSize|uiMode"
+    android:launchMode="singleTask"
+    android:windowSoftInputMode="adjustResize"
+    android:exported="true"> <!-- Add android:exported="true" -->
+    <intent-filter>
+      <action android:name="android.intent.action.MAIN" />
+      <category android:name="android.intent.category.LAUNCHER" />
+    </intent-filter>
+    </activity>
+  </application>
 </manifest>
 
 ```
 
-4. Finally edit your `android/app/src/main/java/com/yourprojectname/MainActivity.java` file:
+5. Finally edit your `android/app/src/main/java/com/yourprojectname/MainActivity.java` file:
 
 ```java
 import com.facebook.react.ReactActivity;
@@ -349,7 +367,7 @@ function App() {
 
 ### Testing with Jest
 
-Testing code which uses this library required some setup since we need to mock the native methods.
+Testing code which uses this library requires some setup since we need to mock the native methods.
 
 To add the mocks, create a file _jest/setup.js_ (or any other file name) containing the following code:
 
@@ -390,8 +408,6 @@ function App() {
 
 ## 🕵️‍♂️ Comparison with [react-native-splash-screen](https://github.com/crazycodeboy/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](https://developer.apple.com/library/archive/documentation/UserExperience/Conceptual/AutolayoutPG/) and [Android drawable resource](https://developer.android.com/guide/topics/resources/drawable-resource)).
-
+- 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.
 - It should not prevent you from seeing red screen errors.
-
 - Hiding the launch screen is configurable: fade it out or hide it without any animation at all (no fade needed if you want to animate it out!).

package/android/src/main/java/com/zoontek/rnbootsplash/RNBootSplashModule.java

@@ -76,7 +76,7 @@ public class RNBootSplashModule extends ReactContextBaseJavaModule implements Li
 
     mSplashScreen.setOnExitAnimationListener(new SplashScreen.OnExitAnimationListener() {
       @Override
-      public void onSplashScreenExit(@NonNull SplashScreenViewProvider splashScreenViewProvider) {
+      public void onSplashScreenExit(@NonNull final SplashScreenViewProvider splashScreenViewProvider) {
         View splashScreenView = splashScreenViewProvider.getView();
 
         splashScreenView

package/ios/RNBootSplash.m

@@ -1,7 +1,6 @@
 #import "RNBootSplash.h"
 
 #import <React/RCTBridge.h>
-#import <React/RCTLog.h>
 #import <React/RCTUtils.h>
 
 static NSMutableArray<RNBootSplashTask *> *_taskQueue = nil;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-bootsplash",
-  "version": "4.0.0-beta.1",
+  "version": "4.0.0-beta.2",
   "license": "MIT",
   "description": "Display a bootsplash on your app starts. Hide it when you want.",
   "author": "Mathieu Acthernoene <zoontek@gmail.com>",

package/react-native.config.js

@@ -16,7 +16,7 @@ module.exports = {
         {
           name: "--logo-width <width>",
           description:
-            "logo width at @1x (in dp - we recommand approximately ~100)",
+            "logo width at @1x (in dp - we recommend approximately ~100)",
           default: 100,
           parse: (value) => parseInt(value, 10),
         },