react-native-bootsplash 4.1.2 → 4.1.5

package/README.md

@@ -97,6 +97,8 @@ public class MainApplication extends Application implements ReactApplication {
 
 ## Setup
 
+ℹ️ For `react-native` < `0.68` documentation, check the [`v4.1.3 README.md`](https://github.com/zoontek/react-native-bootsplash/blob/4.1.3/README.md)
+
 ### Assets generation
 
 In order to speed up the setup, we provide a **CLI** to generate assets, create the Android Drawable XML file and the iOS Storyboard file automatically ✨.
@@ -132,6 +134,17 @@ yarn react-native generate-bootsplash assets/bootsplash_logo_original.png \
   --flavor=main
 ```
 
+#### Using an SVG
+
+You might want to use SVG as input file. For that, you can install a CLI tool to convert your logo first:
+
+```bash
+$ brew install librsvg # available on macOS
+$ rsvg-convert -w 3000 bootsplash_logo.svg -o bootsplash_logo.png # create a large PNG with generous leeway for 4x Android xxxhdpi devices
+$ react-native generate-bootsplash bootsplash_logo.png
+$ rm bootsplash_logo.png # optionally, clean up the PNG
+```
+
 ![](https://raw.githubusercontent.com/zoontek/react-native-bootsplash/master/docs/cli_tool.png?raw=true)
 
 This tool relies on the naming conventions that are used in the `/example` project and will therefore create the following files:
@@ -159,24 +172,24 @@ ios/YourProjectName/Images.xcassets/BootSplashLogo.imageset/bootsplash_logo@3x.p
 
 ### iOS
 
-_⚠️ Only `.storyboard` files are supported ([Apple has deprecated other methods in April 2020](https://developer.apple.com/news/?id=01132020b))._
+_⚠️  Only `.storyboard` files are supported ([Apple has deprecated other methods in April 2020](https://developer.apple.com/news/?id=01132020b))._
+
+---
 
-Edit the `ios/YourProjectName/AppDelegate.m` file:
+Edit the `ios/YourProjectName/AppDelegate.mm` file:
 
 ```obj-c
 #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
 {
   // …
+
   rootViewController.view = rootView;
   self.window.rootViewController = rootViewController;
   [self.window makeKeyAndVisible];
@@ -195,12 +208,16 @@ Set the `BootSplash.storyboard` as launch screen file:
 
 ### Android
 
+_⚠️  On Android 12, the splash screen will not appear if you start your app from the terminal / Android Studio. To see it, kill your app and restart it in normal conditions (tap on your app icon in the app launcher)._
+
+---
+
 1. As this library only support Android 6+, you probably have to edit your `android/build.gradle` file:
 
 ```gradle
 buildscript {
   ext {
-    buildToolsVersion = "30.0.2"
+    buildToolsVersion = "31.0.0"
     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
@@ -212,10 +229,9 @@ buildscript {
 
 ```gradle
 dependencies {
-  implementation fileTree(dir: "libs", include: ["*.jar"])
-  //noinspection GradleDynamicVersion
-  implementation "com.facebook.react:react-native:+"  // From node_modules
+  // …
 
+  implementation "androidx.swiperefreshlayout:swiperefreshlayout:1.0.0"
   implementation "androidx.core:core-splashscreen:1.0.0-beta01" // Add this line
 
   // …
@@ -255,18 +271,7 @@ dependencies {
     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>
 
@@ -276,23 +281,23 @@ dependencies {
 
 ```java
 import com.facebook.react.ReactActivity;
-import com.facebook.react.ReactActivityDelegate; // <- add this necessary import
+import com.facebook.react.ReactActivityDelegate;
+import com.facebook.react.ReactRootView;
 import com.zoontek.rnbootsplash.RNBootSplash; // <- add this necessary import
 
 public class MainActivity extends ReactActivity {
 
   // …
 
-  @Override
-  protected ReactActivityDelegate createReactActivityDelegate() {
-    return new ReactActivityDelegate(this, getMainComponentName()) {
-
-      @Override
-      protected void loadApp(String appKey) {
-        RNBootSplash.init(MainActivity.this); // <- initialize the splash screen
-        super.loadApp(appKey);
-      }
-    };
+  public static class MainActivityDelegate extends ReactActivityDelegate {
+
+    // …
+
+    @Override
+    protected void loadApp(String appKey) {
+      RNBootSplash.init(getPlainActivity()); // <- initialize the splash screen
+      super.loadApp(appKey);
+    }
   }
 }
 ```
@@ -316,8 +321,6 @@ RNBootSplash.hide(); // immediate
 RNBootSplash.hide({ fade: true }); // fade
 ```
 
----
-
 ### getVisibilityStatus()
 
 #### Method type
@@ -360,7 +363,25 @@ function App() {
 
 **🤙 A more complex example is available in the [`/example` folder](example).**
 
-### Testing with Jest
+## Using React Navigation
+
+If you are using React Navigation, you can hide the splash screen once the navigation container and all children have finished mounting by using the `onReady` function.
+
+```js
+import React from "react";
+import { NavigationContainer } from "@react-navigation/native";
+import RNBootSplash from "react-native-bootsplash";
+
+function App() {
+  return (
+    <NavigationContainer onReady={() => RNBootSplash.hide()}>
+      {/* content */}
+    </NavigationContainer>
+  );
+}
+```
+
+## Testing with Jest
 
 Testing code which uses this library requires some setup since we need to mock the native methods.
 
@@ -369,7 +390,7 @@ To add the mocks, create a file _jest/setup.js_ (or any other file name) contain
 ```js
 jest.mock("react-native-bootsplash", () => {
   return {
-    show: jest.fn().mockResolvedValueOnce(),
+    hide: jest.fn().mockResolvedValueOnce(),
     getVisibilityStatus: jest.fn().mockResolvedValue("hidden"),
   };
 });
@@ -383,24 +404,6 @@ After that, we need to add the setup file in the jest config. You can add it und
 }
 ```
 
-### Using React Navigation
-
-If you are using React Navigation, you can hide the splash screen once the navigation container and all children have finished mounting by using the `onReady` function.
-
-```js
-import React from "react";
-import { NavigationContainer } from "@react-navigation/native";
-import RNBootSplash from "react-native-bootsplash";
-
-function App() {
-  return (
-    <NavigationContainer onReady={() => RNBootSplash.hide()}>
-      {/* content */}
-    </NavigationContainer>
-  );
-}
-```
-
 ## 🕵️‍♂️ 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.

package/android/.npmignore

@@ -0,0 +1,11 @@
+.gradle/
+.idea/
+build/
+gradle/
+
+.DS_Store
+.npmignore
+gradlew
+gradlew.bat
+*.iml
+local.properties

package/android/build.gradle

@@ -12,7 +12,7 @@ buildscript {
             mavenCentral()
         }
         dependencies {
-            classpath("com.android.tools.build:gradle:4.2.2")
+            classpath("com.android.tools.build:gradle:7.0.4")
         }
     }
 }
@@ -21,7 +21,7 @@ apply plugin: "com.android.library"
 
 android {
     compileSdkVersion safeExtGet("compileSdkVersion", 31)
-    buildToolsVersion safeExtGet("buildToolsVersion", "30.0.2")
+    buildToolsVersion safeExtGet("buildToolsVersion", "31.0.0")
     defaultConfig {
         minSdkVersion safeExtGet("minSdkVersion", 23)
         targetSdkVersion safeExtGet("targetSdkVersion", 31)

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

@@ -12,7 +12,6 @@ import androidx.core.splashscreen.SplashScreen;
 import androidx.core.splashscreen.SplashScreenViewProvider;
 
 import com.facebook.common.logging.FLog;
-import com.facebook.react.bridge.LifecycleEventListener;
 import com.facebook.react.bridge.Promise;
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.bridge.ReactContextBaseJavaModule;
@@ -25,7 +24,7 @@ import java.util.Timer;
 import java.util.TimerTask;
 
 @ReactModule(name = RNBootSplashModule.NAME)
-public class RNBootSplashModule extends ReactContextBaseJavaModule implements LifecycleEventListener {
+public class RNBootSplashModule extends ReactContextBaseJavaModule {
 
   public static final String NAME = "RNBootSplash";
   private static final int ANIMATION_DURATION = 220;
@@ -39,15 +38,13 @@ public class RNBootSplashModule extends ReactContextBaseJavaModule implements Li
   @Nullable
   private static SplashScreen mSplashScreen = null;
 
-  private static final RNBootSplashQueue<RNBootSplashTask> mTaskQueue = new RNBootSplashQueue<>();
+  private static final RNBootSplashQueue<Promise> mPromiseQueue = new RNBootSplashQueue<>();
   private static Status mStatus = Status.HIDDEN;
-  private static boolean mIsAppInForeground = true;
   private static boolean mShouldFade = false;
   private static boolean mShouldKeepOnScreen = true;
 
   public RNBootSplashModule(ReactApplicationContext reactContext) {
     super(reactContext);
-    reactContext.addLifecycleEventListener(this);
   }
 
   @Override
@@ -96,95 +93,66 @@ public class RNBootSplashModule extends ReactContextBaseJavaModule implements Li
     });
   }
 
-  @Override
-  public void onHostDestroy() {
-    mIsAppInForeground = false;
-  }
-
-  @Override
-  public void onHostPause() {
-    mIsAppInForeground = false;
-  }
-
-  @Override
-  public void onHostResume() {
-    mIsAppInForeground = true;
-    shiftNextTask();
-  }
+  private void clearPromiseQueue() {
+    while (!mPromiseQueue.isEmpty()) {
+      Promise promise = mPromiseQueue.shift();
 
-  private void shiftNextTask() {
-    if (mStatus != Status.TRANSITIONING && mIsAppInForeground) {
-      RNBootSplashTask task = mTaskQueue.shift();
-
-      if (task != null) {
-        hideWithTask(task);
-      }
+      if (promise != null)
+        promise.resolve(true);
     }
   }
 
-  private void waitAndRetry() {
-    final Timer timer = new Timer();
-
-    timer.schedule(new TimerTask() {
-      @Override
-      public void run() {
-        shiftNextTask();
-        timer.cancel();
-      }
-    }, 250);
-  }
-
-  private void hideWithTask(final RNBootSplashTask task) {
-    final Activity activity = getReactApplicationContext().getCurrentActivity();
-    final boolean fade = task.getFade();
-    final Promise promise = task.getPromise();
-
+  private void hideAndResolveAll(final boolean fade) {
     if (mSplashScreen == null || mStatus == Status.HIDDEN) {
-      promise.resolve(true);
-      shiftNextTask();
+      clearPromiseQueue();
       return;
     }
 
     UiThreadUtil.runOnUiThread(new Runnable() {
       @Override
       public void run() {
+        final Activity activity = getReactApplicationContext().getCurrentActivity();
+
         if (activity == null || activity.isFinishing()) {
-          waitAndRetry(); // Wait for activity to be ready
-          return;
-        }
+          // Wait for activity to be ready
+          final Timer timer = new Timer();
 
-        if (fade) {
-          mStatus = Status.TRANSITIONING;
-        }
+          timer.schedule(new TimerTask() {
+            @Override
+            public void run() {
+              hideAndResolveAll(fade);
+              timer.cancel();
+            }
+          }, 250);
+        } else {
+          if (fade) {
+            mStatus = Status.TRANSITIONING;
+          }
 
-        mShouldFade = fade;
-        mShouldKeepOnScreen = false;
+          mShouldFade = fade;
+          mShouldKeepOnScreen = false;
 
-        final Timer timer = new Timer();
+          final Timer timer = new Timer();
 
-        // We cannot rely on setOnExitAnimationListener
-        // See https://issuetracker.google.com/issues/197906327
-        timer.schedule(new TimerTask() {
-          @Override
-          public void run() {
-            mStatus = Status.HIDDEN;
-            timer.cancel();
-            promise.resolve(true);
-            shiftNextTask();
-          }
-        }, ANIMATION_DURATION);
+          // We cannot rely on setOnExitAnimationListener
+          // See https://issuetracker.google.com/issues/197906327
+          timer.schedule(new TimerTask() {
+            @Override
+            public void run() {
+              mStatus = Status.HIDDEN;
+              timer.cancel();
+              clearPromiseQueue();
+            }
+          }, ANIMATION_DURATION);
+        }
       }
     });
   }
 
   @ReactMethod
   public void hide(final boolean fade, final Promise promise) {
-    if (mSplashScreen == null || mStatus == Status.HIDDEN) {
-      promise.resolve(true);
-    } else {
-      mTaskQueue.push(new RNBootSplashTask(fade, promise));
-      shiftNextTask();
-    }
+    mPromiseQueue.push(promise);
+    hideAndResolveAll(fade);
   }
 
   @ReactMethod

package/ios/.npmignore

@@ -0,0 +1,8 @@
+Pods/
+build/
+
+*/project.xcworkspace/
+*/xcuserdata/
+
+.DS_Store
+.npmignore

package/ios/RNBootSplash.h

@@ -1,19 +1,9 @@
 #import <React/RCTBridgeModule.h>
 #import <React/RCTRootView.h>
 
-@interface RNBootSplashTask : NSObject
-
-@property (nonatomic, readonly) BOOL fade;
-@property (nonatomic, readonly, strong) RCTPromiseResolveBlock _Nonnull resolve;
-
-- (instancetype _Nonnull)initWithFade:(BOOL)fade
-                             resolver:(RCTPromiseResolveBlock _Nonnull)resolve;
-
-@end
-
 @interface RNBootSplash : NSObject <RCTBridgeModule>
 
 + (void)initWithStoryboard:(NSString * _Nonnull)storyboardName
-                  rootView:(RCTRootView * _Nullable)rootView;
+                  rootView:(UIView * _Nullable)rootView;
 
 @end

package/ios/RNBootSplash.m

@@ -3,24 +3,9 @@
 #import <React/RCTBridge.h>
 #import <React/RCTUtils.h>
 
-static NSMutableArray<RNBootSplashTask *> *_taskQueue = nil;
+static NSMutableArray<RCTPromiseResolveBlock> *_resolverQueue = nil;
 static RCTRootView *_rootView = nil;
 static bool _isTransitioning = false;
-static bool _shouldPreventInit = false;
-
-@implementation RNBootSplashTask
-
-- (instancetype)initWithFade:(BOOL)fade
-                    resolver:(RCTPromiseResolveBlock _Nonnull)resolve {
-  if (self = [super init]) {
-    _fade = fade;
-    _resolve = resolve;
-  }
-
-  return self;
-}
-
-@end
 
 @implementation RNBootSplash
 
@@ -35,11 +20,14 @@ RCT_EXPORT_MODULE();
 }
 
 + (void)initWithStoryboard:(NSString * _Nonnull)storyboardName
-                  rootView:(RCTRootView * _Nullable)rootView {
-  if (rootView == nil || _rootView != nil || RCTRunningInAppExtension())
+                  rootView:(UIView * _Nullable)rootView {
+  if (rootView == nil ||
+      ![rootView isKindOfClass:[RCTRootView class]] ||
+      _rootView != nil ||
+      RCTRunningInAppExtension())
     return;
 
-  _rootView = rootView;
+  _rootView = (RCTRootView *)rootView;
 
   [[NSNotificationCenter defaultCenter] removeObserver:rootView
                                                   name:RCTContentDidAppearNotification
@@ -48,13 +36,13 @@ RCT_EXPORT_MODULE();
   UIStoryboard *storyboard = [UIStoryboard storyboardWithName:storyboardName bundle:nil];
   UIView *loadingView = [[storyboard instantiateInitialViewController] view];
 
-  if (_shouldPreventInit)
-    return;
+  if (_resolverQueue != nil)
+    return; // hide has already been called, abort init
 
   [_rootView setLoadingView:loadingView];
 
   [[NSNotificationCenter defaultCenter] addObserver:self
-                                           selector:@selector(onJavaScriptDidLoad:)
+                                           selector:@selector(onJavaScriptDidLoad)
                                                name:RCTJavaScriptDidLoadNotification
                                              object:nil];
 
@@ -62,21 +50,10 @@ RCT_EXPORT_MODULE();
                                            selector:@selector(onJavaScriptDidFailToLoad)
                                                name:RCTJavaScriptDidFailToLoadNotification
                                              object:nil];
-
-  [[NSNotificationCenter defaultCenter] addObserver:self
-                                           selector:@selector(shiftNextTask)
-                                               name:UIApplicationDidBecomeActiveNotification
-                                             object:nil];
 }
 
-+ (void)onJavaScriptDidLoad:(NSNotification *)notification {
-  [[NSNotificationCenter defaultCenter] removeObserver:self
-                                                  name:RCTJavaScriptDidLoadNotification
-                                                object:nil];
-
-  [[NSNotificationCenter defaultCenter] removeObserver:self
-                                                  name:RCTJavaScriptDidFailToLoadNotification
-                                                object:nil];
++ (void)onJavaScriptDidLoad {
+  [[NSNotificationCenter defaultCenter] removeObserver:self];
 }
 
 + (void)onJavaScriptDidFailToLoad {
@@ -91,39 +68,36 @@ RCT_EXPORT_MODULE();
 + (void)removeLoadingView {
   if (![self isHidden]) {
     _rootView.loadingView.hidden = YES;
+
     [_rootView.loadingView removeFromSuperview];
     _rootView.loadingView = nil;
   }
 }
 
-+ (void)ensureTaskQueue {
-  if (_taskQueue == nil)
-    _taskQueue = [[NSMutableArray alloc] init];
-}
-
-+ (void)shiftNextTask {
-  [self ensureTaskQueue];
+- (void)clearResolverQueue {
+  while ([_resolverQueue count] > 0) {
+    RCTPromiseResolveBlock resolve = [_resolverQueue objectAtIndex:0];
+    [_resolverQueue removeObjectAtIndex:0];
 
-  if ([_taskQueue count] > 0 &&
-      !_isTransitioning &&
-      [[UIApplication sharedApplication] applicationState] != UIApplicationStateBackground) {
-    RNBootSplashTask *task = [_taskQueue objectAtIndex:0];
-    [_taskQueue removeObjectAtIndex:0];
-
-    [self hideWithTask:task];
+    resolve(@(true));
   }
 }
 
-+ (void)hideWithTask:(RNBootSplashTask *)task {
-  if ([self isHidden]) {
-    task.resolve(@(true));
-    return [self shiftNextTask];
-  }
+RCT_REMAP_METHOD(hide,
+                 hideWithFade:(BOOL)fade
+                 resolver:(RCTPromiseResolveBlock)resolve
+                 rejecter:(RCTPromiseRejectBlock)reject) {
+  if (_resolverQueue == nil)
+    _resolverQueue = [[NSMutableArray alloc] init];
+
+  [_resolverQueue addObject:resolve];
 
-  if (!task.fade) {
-    [self removeLoadingView];
-    task.resolve(@(true));
-    return [self shiftNextTask];
+  if ([RNBootSplash isHidden] || RCTRunningInAppExtension())
+    return [self clearResolverQueue];
+
+  if (!fade) {
+    [RNBootSplash removeLoadingView];
+    return [self clearResolverQueue];
   }
 
   dispatch_async(dispatch_get_main_queue(), ^{
@@ -139,31 +113,13 @@ RCT_EXPORT_MODULE();
       [_rootView.loadingView removeFromSuperview];
       _rootView.loadingView = nil;
 
-      task.resolve(@(true));
       _isTransitioning = false;
 
-      return [self shiftNextTask];
+      return [self clearResolverQueue];
     }];
   });
 }
 
-RCT_REMAP_METHOD(hide,
-                 hideWithFade:(BOOL)fade
-                 resolver:(RCTPromiseResolveBlock)resolve
-                 rejecter:(RCTPromiseRejectBlock)reject) {
-  _shouldPreventInit = true;
-
-  if ([RNBootSplash isHidden] || RCTRunningInAppExtension())
-    return resolve(@(true));
-
-  RNBootSplashTask *task = [[RNBootSplashTask alloc] initWithFade:fade
-                                                         resolver:resolve];
-
-  [RNBootSplash ensureTaskQueue];
-  [_taskQueue addObject:task];
-  [RNBootSplash shiftNextTask];
-}
-
 RCT_REMAP_METHOD(getVisibilityStatus,
                  getVisibilityStatusWithResolver:(RCTPromiseResolveBlock)resolve
                  rejecter:(RCTPromiseRejectBlock)reject) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-bootsplash",
-  "version": "4.1.2",
+  "version": "4.1.5",
   "license": "MIT",
   "description": "Display a bootsplash on your app starts. Hide it when you want.",
   "author": "Mathieu Acthernoene <zoontek@gmail.com>",
@@ -60,19 +60,22 @@
   },
   "dependencies": {
     "chalk": "^4.1.2",
-    "fs-extra": "^10.0.0",
+    "fs-extra": "^10.1.0",
     "jimp": "^0.16.1"
   },
+  "resolutions": {
+    "@types/react": "^17"
+  },
   "devDependencies": {
     "@types/fs-extra": "^9.0.13",
-    "@types/react-native": "^0.66.15",
-    "lint-staged": "^12.3.3",
-    "prettier": "^2.5.1",
+    "@types/react-native": "^0.67.6",
+    "lint-staged": "^12.4.0",
+    "prettier": "^2.6.2",
     "prettier-plugin-organize-imports": "^2.3.4",
     "react": "^17.0.2",
-    "react-native": "^0.67.2",
+    "react-native": "^0.68.1",
     "react-native-builder-bob": "^0.18.2",
     "rescript": "^9.1.4",
-    "typescript": "^4.5.5"
+    "typescript": "^4.6.3"
   }
 }

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

@@ -1,25 +0,0 @@
-package com.zoontek.rnbootsplash;
-
-import androidx.annotation.NonNull;
-
-import com.facebook.react.bridge.Promise;
-
-public class RNBootSplashTask {
-
-  private final boolean mFade;
-  @NonNull private final Promise mPromise;
-
-  public RNBootSplashTask(final boolean fade, @NonNull final Promise promise) {
-    mFade = fade;
-    mPromise = promise;
-  }
-
-  public boolean getFade() {
-    return mFade;
-  }
-
-  @NonNull
-  public Promise getPromise() {
-    return mPromise;
-  }
-}