refactor: added forceClose and remove force param from close method

gorhom · Aug 21, 2021 · 3dd5796
1 parent 8e002e1
commit 3dd5796
Show file tree

Hide file tree

Showing 3 changed files with 68 additions and 9 deletions.
diff --git a/src/components/bottomSheet/BottomSheet.tsx b/src/components/bottomSheet/BottomSheet.tsx
@@ -833,10 +833,7 @@ const BottomSheetComponent = forwardRef<BottomSheet, BottomSheetProps>(
     );
     const handleClose = useCallback(
       function handleClose(
-        animationConfigs?:
-          | Animated.WithSpringConfig
-          | Animated.WithTimingConfig,
-        force?: boolean
+        animationConfigs?: Animated.WithSpringConfig | Animated.WithTimingConfig
       ) {
         print({
           component: BottomSheet.name,
@@ -862,10 +859,53 @@ const BottomSheetComponent = forwardRef<BottomSheet, BottomSheetProps>(
          */
         isInTemporaryPosition.value = false;
 
+        runOnUI(animateToPosition)(
+          nextPosition,
+          ANIMATION_SOURCE.USER,
+          0,
+          animationConfigs
+        );
+      },
+      [
+        animateToPosition,
+        isForcedClosing,
+        isInTemporaryPosition,
+        animatedNextPosition,
+        animatedClosedPosition,
+      ]
+    );
+    const handleForceClose = useCallback(
+      function handleForceClose(
+        animationConfigs?: Animated.WithSpringConfig | Animated.WithTimingConfig
+      ) {
+        print({
+          component: BottomSheet.name,
+          method: handleForceClose.name,
+        });
+
+        const nextPosition = animatedClosedPosition.value;
+
+        /**
+         * exit method if :
+         * - already animating to next position.
+         * - sheet is forced closing.
+         */
+        if (
+          nextPosition === animatedNextPosition.value ||
+          isForcedClosing.value
+        ) {
+          return;
+        }
+
+        /**
+         * reset temporary position variable.
+         */
+        isInTemporaryPosition.value = false;
+
         /**
          * set force closing variable.
          */
-        isForcedClosing.value = force === undefined ? false : force;
+        isForcedClosing.value = true;
 
         runOnUI(animateToPosition)(
           nextPosition,
@@ -980,6 +1020,7 @@ const BottomSheetComponent = forwardRef<BottomSheet, BottomSheetProps>(
       expand: handleExpand,
       collapse: handleCollapse,
       close: handleClose,
+      forceClose: handleForceClose,
     }));
     //#endregion
 
@@ -1075,6 +1116,7 @@ const BottomSheetComponent = forwardRef<BottomSheet, BottomSheetProps>(
         expand: handleExpand,
         collapse: handleCollapse,
         close: handleClose,
+        forceClose: handleForceClose,
       }),
       [
         animatedIndex,
@@ -1084,6 +1126,7 @@ const BottomSheetComponent = forwardRef<BottomSheet, BottomSheetProps>(
         handleExpand,
         handleCollapse,
         handleClose,
+        handleForceClose,
       ]
     );
     //#endregion

diff --git a/src/components/bottomSheetModal/BottomSheetModal.tsx b/src/components/bottomSheetModal/BottomSheetModal.tsx
@@ -150,6 +150,12 @@ const BottomSheetModalComponent = forwardRef<
     }
     bottomSheetRef.current?.close(...args);
   }, []);
+  const handleForceClose = useCallback((...args) => {
+    if (minimized.current) {
+      return;
+    }
+    bottomSheetRef.current?.forceClose(...args);
+  }, []);
   //#endregion
 
   //#region bottom sheet modal methods
@@ -197,7 +203,7 @@ const BottomSheetModalComponent = forwardRef<
       }
       willUnmountSheet(key);
       forcedDismissed.current = true;
-      bottomSheetRef.current?.close(animationConfigs, true);
+      bottomSheetRef.current?.forceClose(animationConfigs);
     },
     [willUnmountSheet, unmount, key, enablePanDownToClose]
   );
@@ -325,8 +331,9 @@ const BottomSheetModalComponent = forwardRef<
     expand: handleExpand,
     collapse: handleCollapse,
     close: handleClose,
-    dismiss: handleDismiss,
+    forceClose: handleForceClose,
     // modal methods
+    dismiss: handleDismiss,
     present: handlePresent,
     // internal
     minimize: handleMinimize,

diff --git a/src/types.d.ts b/src/types.d.ts
@@ -67,8 +67,17 @@ export interface BottomSheetMethods {
    * @see {Animated.WithTimingConfig}
    */
   close: (
-    animationConfigs?: Animated.WithSpringConfig | Animated.WithTimingConfig,
-    force?: boolean
+    animationConfigs?: Animated.WithSpringConfig | Animated.WithTimingConfig
+  ) => void;
+  /**
+   * Force close the bottom sheet, this prevent any interruptions till the sheet is closed.
+   * @param animationConfigs snap animation configs.
+   *
+   * @see {Animated.WithSpringConfig}
+   * @see {Animated.WithTimingConfig}
+   */
+  forceClose: (
+    animationConfigs?: Animated.WithSpringConfig | Animated.WithTimingConfig
   ) => void;
 }
 export interface BottomSheetModalMethods extends BottomSheetMethods {