react-native-bootsplash 4.7.5 → 5.0.0-beta.0

package/src/index.ts

@@ -1,18 +1,215 @@
-import NativeModule, { VisibilityStatus } from "./NativeRNBootSplash";
+import { useCallback, useEffect, useMemo, useRef } from "react";
+import {
+  ImageProps,
+  ImageRequireSource,
+  Platform,
+  StyleSheet,
+  ViewProps,
+  ViewStyle,
+  useColorScheme,
+} from "react-native";
+import NativeModule from "./NativeRNBootSplash";
 
-export type { VisibilityStatus } from "./NativeRNBootSplash";
-export type Config = { fade?: boolean; duration?: number };
+export type Config = {
+  fade?: boolean;
+};
+
+export type Manifest = {
+  background: string;
+  darkBackground?: string;
+  logo: {
+    width: number;
+    height: number;
+  };
+  brand?: {
+    bottom: number;
+    width: number;
+    height: number;
+  };
+};
+
+export type UseHideAnimationConfig = {
+  manifest: Manifest;
+
+  logo: ImageRequireSource;
+  darkLogo?: ImageRequireSource;
+  brand?: ImageRequireSource;
+  darkBrand?: ImageRequireSource;
+
+  animate: () => void;
+
+  statusBarTranslucent?: boolean;
+  navigationBarTranslucent?: boolean;
+};
+
+export type UseHideAnimation = {
+  container: ViewProps;
+  logo: ImageProps;
+  brand?: ImageProps;
+};
 
 export function hide(config: Config = {}): Promise<void> {
-  const { fade = false, duration = 0 } = config;
-  return NativeModule.hide(fade ? Math.max(duration, 220) : 0).then(() => {});
+  const { fade = false } = config;
+  return NativeModule.hide(fade).then(() => {});
+}
+
+export function isVisible(): Promise<boolean> {
+  return NativeModule.isVisible();
 }
 
-export function getVisibilityStatus(): Promise<VisibilityStatus> {
-  return NativeModule.getVisibilityStatus();
+export function useHideAnimation(config: UseHideAnimationConfig) {
+  const {
+    manifest,
+
+    logo: logoSrc,
+    darkLogo: darkLogoSrc,
+    brand: brandSrc,
+    darkBrand: darkBrandSrc,
+
+    animate,
+
+    statusBarTranslucent = false,
+    navigationBarTranslucent = false,
+  } = config;
+
+  const hasBrand = manifest.brand != null && brandSrc != null;
+  const logoWidth = manifest.logo.width;
+  const logoHeight = manifest.logo.height;
+  const brandBottom = manifest.brand?.bottom;
+  const brandWidth = manifest.brand?.width;
+  const brandHeight = manifest.brand?.height;
+
+  const colorScheme = useColorScheme();
+
+  const backgroundColor: string =
+    colorScheme === "dark" && manifest.darkBackground != null
+      ? manifest.darkBackground
+      : manifest.background;
+
+  const logoFinalSrc: ImageRequireSource =
+    colorScheme === "dark" && darkLogoSrc != null ? darkLogoSrc : logoSrc;
+
+  const brandFinalSrc: ImageRequireSource | undefined = hasBrand
+    ? colorScheme === "dark" && darkBrandSrc != null
+      ? darkBrandSrc
+      : brandSrc
+    : undefined;
+
+  const animateFn = useRef(animate);
+  const layoutReady = useRef(false);
+  const logoReady = useRef(false);
+  const brandReady = useRef(!hasBrand);
+  const animateHasBeenCalled = useRef(false);
+
+  useEffect(() => {
+    animateFn.current = animate;
+  });
+
+  const maybeRunAnimate = useCallback(() => {
+    if (
+      layoutReady.current &&
+      logoReady.current &&
+      brandReady.current &&
+      !animateHasBeenCalled.current
+    ) {
+      animateHasBeenCalled.current = true;
+
+      hide({ fade: false })
+        .then(() => animateFn.current())
+        .catch(() => {});
+    }
+  }, []);
+
+  return useMemo<UseHideAnimation>(() => {
+    const containerStyle: ViewStyle = {
+      ...StyleSheet.absoluteFillObject,
+      backgroundColor,
+      alignItems: "center",
+      justifyContent: "center",
+    };
+
+    const container: ViewProps = {
+      style: containerStyle,
+      onLayout: () => {
+        layoutReady.current = true;
+        maybeRunAnimate();
+      },
+    };
+
+    const logo: ImageProps = {
+      fadeDuration: 0,
+      resizeMode: "contain",
+      source: logoFinalSrc,
+      style: {
+        width: logoWidth,
+        height: logoHeight,
+      },
+      onLoadEnd: () => {
+        logoReady.current = true;
+        maybeRunAnimate();
+      },
+    };
+
+    const brand: ImageProps | undefined =
+      brandFinalSrc != null
+        ? {
+            fadeDuration: 0,
+            resizeMode: "contain",
+            source: brandFinalSrc,
+            style: {
+              position: "absolute",
+              bottom: brandBottom,
+              width: brandWidth,
+              height: brandHeight,
+            },
+            onLoadEnd: () => {
+              brandReady.current = true;
+              maybeRunAnimate();
+            },
+          }
+        : undefined;
+
+    if (Platform.OS !== "android") {
+      return { container, logo, brand };
+    }
+
+    const { statusBarHeight, navigationBarHeight } =
+      NativeModule.getConstants();
+
+    return {
+      container: {
+        ...container,
+        style: {
+          ...containerStyle,
+          marginTop: statusBarTranslucent ? undefined : -statusBarHeight,
+          marginBottom: navigationBarTranslucent
+            ? undefined
+            : -navigationBarHeight,
+        },
+      },
+      logo,
+      brand,
+    };
+  }, [
+    maybeRunAnimate,
+
+    logoWidth,
+    logoHeight,
+    brandBottom,
+    brandWidth,
+    brandHeight,
+
+    backgroundColor,
+    logoFinalSrc,
+    brandFinalSrc,
+
+    statusBarTranslucent,
+    navigationBarTranslucent,
+  ]);
 }
 
 export default {
   hide,
-  getVisibilityStatus,
+  isVisible,
+  useHideAnimation,
 };

package/RNBootSplash.res

@@ -1,29 +0,0 @@
-type config = {fade: bool}
-
-@module("react-native-bootsplash") @scope("default")
-external hide: config => Js.Promise.t<unit> = "hide"
-
-// Note that this binding requires BuckleScript >= 8.2.0
-type visibilityStatus = [#visible | #hidden | #transitioning]
-
-@module("react-native-bootsplash") @scope("default")
-external getVisibilityStatus: unit => Js.Promise.t<visibilityStatus> = "getVisibilityStatus"
-/*
-## Usage
-
-```rescript
- RNBootSplash.hide({fade: true})->ignore
-```
-
-Or
-
- ```rescript
-RNBootSplash.hide({fade: true})->Js.Promise.then_(() => {
-  Js.log("RN BootSplash: fading is over")
-  Js.Promise.resolve()
-}, _)->Js.Promise.catch(error => {
-  Js.log(("RN BootSplash: cannot hide splash", error))
-  Js.Promise.resolve()
-}, _)->ignore
-```
-*/

package/bsconfig.json

@@ -1,14 +0,0 @@
-{
-  "name": "react-native-bootsplash",
-  "package-specs": {
-    "module": "es6",
-    "in-source": true
-  },
-  "suffix": ".bs.js",
-  "sources": [
-    {
-      "dir": ".",
-      "subdirs": false
-    }
-  ]
-}