@jobber/components-native 0.93.0 → 0.94.0

package/dist/types/src/BottomSheet/BottomSheet.d.ts

@@ -1,6 +1,5 @@
 import type { ReactNode } from "react";
 import React from "react";
-import type { Modalize } from "react-native-modalize";
 export interface BottomSheetProps {
     readonly children: ReactNode;
     /**
@@ -24,5 +23,10 @@ export interface BottomSheetProps {
      */
     readonly onClose?: () => void;
 }
-export declare const BottomSheet: React.ForwardRefExoticComponent<BottomSheetProps & React.RefAttributes<import("react-native-modalize/lib/options").IHandles | undefined>>;
-export type BottomSheetRef = Modalize | undefined;
+export interface BottomSheetRef {
+    open: () => void;
+    close: () => void;
+}
+export declare function BottomSheet({ children, showCancel, loading, heading, onOpen, onClose, ref, }: BottomSheetProps & {
+    readonly ref?: React.Ref<BottomSheetRef>;
+}): React.JSX.Element;

package/dist/types/src/BottomSheet/BottomSheet.style.d.ts

@@ -1,23 +1,13 @@
 export declare const useStyles: () => {
-    overlayModalize: {
+    backdrop: {
         backgroundColor: string;
     };
-    overlay: {
-        backgroundColor: string;
-        height: number;
-        position: "absolute";
-        left: 0;
-        right: 0;
-        top: 0;
-        bottom: 0;
-    };
-    modal: {
+    background: {
         borderTopLeftRadius: number;
         borderTopRightRadius: number;
-        paddingTop: number;
     };
-    children: {
-        paddingBottom: number;
+    footerContainer: {
+        backgroundColor: string;
     };
     header: {
         paddingHorizontal: number;
@@ -29,4 +19,7 @@ export declare const useStyles: () => {
         marginTop: number;
         marginBottom: number;
     };
+    handle: {
+        display: "none";
+    };
 };

package/dist/types/src/BottomSheet/hooks/useBottomSheetBackHandler.d.ts

@@ -0,0 +1,8 @@
+import type BottomSheet from "@gorhom/bottom-sheet";
+/**
+ * Hook that closes the bottom sheet on the hardware back button press if it is visible
+ * @param bottomSheetRef ref to the bottom sheet component
+ */
+export declare function useBottomSheetBackHandler(bottomSheetRef: React.RefObject<BottomSheet | null>): {
+    handleSheetPositionChange: (index: number) => void;
+};

package/dist/types/src/InputText/InputText.d.ts

@@ -77,7 +77,7 @@ export interface InputTextProps extends Pick<InputFieldWrapperProps, "toolbar" |
     /**
      * Callback that is called when the text input is blurred
      */
-    readonly onBlur?: () => void;
+    readonly onBlur?: (event?: FocusEvent) => void;
     /**
      * VoiceOver will read this string when a user selects the associated element
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jobber/components-native",
-  "version": "0.93.0",
+  "version": "0.94.0",
   "license": "MIT",
   "description": "React Native implementation of Atlantis",
   "repository": {
@@ -53,6 +53,7 @@
     "ts-xor": "^1.1.0"
   },
   "devDependencies": {
+    "@gorhom/bottom-sheet": "^5.2.8",
     "@react-native-community/datetimepicker": "^8.4.5",
     "@react-native/babel-preset": "^0.82.1",
     "@storybook/addon-a11y": "^9.1.2",
@@ -78,6 +79,7 @@
   },
   "peerDependencies": {
     "@babel/core": "^7.4.5",
+    "@gorhom/bottom-sheet": "^5.2.8",
     "@jobber/design": "*",
     "@react-native-community/datetimepicker": ">=6.7.0",
     "date-fns": "^2.30.0",
@@ -94,5 +96,5 @@
     "react-native-safe-area-context": "^5.4.0",
     "react-native-svg": ">=12.0.0"
   },
-  "gitHead": "a84b7d122f13b650fd7f77cda794d71f1d25317b"
+  "gitHead": "c781bba08e241b32046afba42dff63d213e4a7fd"
 }

package/src/BottomSheet/BottomSheet.stories.tsx

@@ -0,0 +1,128 @@
+import React, { useRef } from "react";
+import type { Meta, StoryObj } from "@storybook/react-native-web-vite";
+import { View } from "react-native";
+import { SafeAreaProvider } from "react-native-safe-area-context";
+import { Button, Heading, Text } from "@jobber/components-native";
+import { BottomSheet } from "./BottomSheet";
+import type { BottomSheetRef } from "./BottomSheet";
+import { BottomSheetOption } from "./components/BottomSheetOption";
+
+const meta = {
+  title: "Components/Selections/BottomSheet",
+  component: BottomSheet,
+} satisfies Meta<typeof BottomSheet>;
+
+export default meta;
+type Story = StoryObj<typeof meta>;
+
+const BasicTemplate = () => {
+  const bottomSheetRef = useRef<BottomSheetRef>(null);
+
+  const openBottomSheet = () => {
+    bottomSheetRef.current?.open();
+  };
+
+  const closeBottomSheet = () => {
+    bottomSheetRef.current?.close();
+  };
+
+  return (
+    <SafeAreaProvider>
+      <View style={{ display: "flex", flexDirection: "column", gap: 16 }}>
+        <Heading>Basic BottomSheet</Heading>
+        <Text>
+          Note that due to the differences between React Native Web and React
+          Native, this does not render 100% properly
+        </Text>
+        <Button label="Open Bottom Sheet" onPress={openBottomSheet} />
+        <Button label="Close Bottom Sheet" onPress={closeBottomSheet} />
+      </View>
+      <BottomSheet
+        ref={bottomSheetRef}
+        onClose={() => console.log("closed bottom sheet")}
+        onOpen={() => console.log("opened bottom sheet")}
+      >
+        <BottomSheetOption
+          icon="sendMessage"
+          iconColor="greyBlue"
+          text="Send message"
+          onPress={() => alert("send message")}
+        />
+        <BottomSheetOption
+          icon="phone"
+          iconColor="greyBlue"
+          text="Call a friend"
+          onPress={() => alert("Calling a friend")}
+        />
+        <BottomSheetOption
+          destructive={true}
+          icon="trash"
+          text="Remove"
+          onPress={() => alert("Removed")}
+        />
+      </BottomSheet>
+    </SafeAreaProvider>
+  );
+};
+
+const HeaderFooterInputTextTemplate = () => {
+  const bottomSheetRef = useRef<BottomSheetRef>(null);
+
+  const openBottomSheet = () => {
+    bottomSheetRef.current?.open();
+  };
+
+  const closeBottomSheet = () => {
+    bottomSheetRef.current?.close();
+  };
+
+  return (
+    <SafeAreaProvider>
+      <View style={{ display: "flex", flexDirection: "column", gap: 16 }}>
+        <Heading>Basic BottomSheet</Heading>
+        <Text>
+          Note that due to the differences between React Native Web and React
+          Native, this does not render 100% properly
+        </Text>
+        <Button label="Open Bottom Sheet" onPress={openBottomSheet} />
+        <Button label="Close Bottom Sheet" onPress={closeBottomSheet} />
+      </View>
+      <BottomSheet
+        ref={bottomSheetRef}
+        showCancel={true}
+        heading="BottomSheet Header"
+        onClose={() => console.log("closed bottom sheet")}
+        onOpen={() => console.log("opened bottom sheet")}
+      >
+        <BottomSheetOption
+          icon="sendMessage"
+          iconColor="greyBlue"
+          text="Send message"
+          onPress={() => alert("send message")}
+        />
+        <BottomSheetOption
+          icon="phone"
+          iconColor="greyBlue"
+          text="Call a friend"
+          onPress={() => alert("Calling a friend")}
+        />
+        <BottomSheetOption
+          destructive={true}
+          icon="trash"
+          text="Remove"
+          onPress={() => alert("Removed")}
+        />
+      </BottomSheet>
+    </SafeAreaProvider>
+  );
+};
+
+export const Basic: Story = {
+  render: BasicTemplate,
+  args: {} as Story["args"],
+};
+
+export const HeaderFooterInputText: Story = {
+  render: HeaderFooterInputTextTemplate,
+  args: {} as Story["args"],
+};

package/src/BottomSheet/BottomSheet.style.ts

@@ -1,28 +1,18 @@
-import { Dimensions, StyleSheet } from "react-native";
 import { buildThemedStyles } from "../AtlantisThemeContext";
 
-const { height } = Dimensions.get("window");
-
 export const useStyles = buildThemedStyles(tokens => {
   const modalBorderRadius = tokens["radius-larger"];
 
   return {
-    overlayModalize: {
-      backgroundColor: "transparent",
-    },
-
-    overlay: {
-      ...StyleSheet.absoluteFillObject,
+    backdrop: {
       backgroundColor: tokens["color-overlay"],
-      height,
     },
-    modal: {
+    background: {
       borderTopLeftRadius: modalBorderRadius,
       borderTopRightRadius: modalBorderRadius,
-      paddingTop: tokens["space-small"],
     },
-    children: {
-      paddingBottom: tokens["space-small"],
+    footerContainer: {
+      backgroundColor: tokens["color-surface"],
     },
     header: {
       paddingHorizontal: tokens["space-base"],
@@ -34,5 +24,8 @@ export const useStyles = buildThemedStyles(tokens => {
       marginTop: tokens["space-small"],
       marginBottom: tokens["space-smaller"],
     },
+    handle: {
+      display: "none",
+    },
   };
 });

package/src/BottomSheet/BottomSheet.test.tsx

@@ -1,7 +1,6 @@
 import React, { createRef } from "react";
-import { act, fireEvent, render, waitFor } from "@testing-library/react-native";
+import { act, render, userEvent, waitFor } from "@testing-library/react-native";
 import { AccessibilityInfo, View } from "react-native";
-import { Host, Portal } from "react-native-portalize";
 import { BottomSheet } from ".";
 import type { BottomSheetRef } from "./BottomSheet";
 import { waitForUntestableRender } from "../utils/test/wait";
@@ -23,22 +22,18 @@ function setup({
   loading?: boolean;
 }) {
   return render(
-    <Host>
-      <Portal>
-        <BottomSheet
-          ref={ref}
-          heading={heading}
-          showCancel={showCancel}
-          loading={loading}
-          onClose={mockOnClose}
-          onOpen={mockOnOpen}
-        >
-          <View>
-            <Text>BottomSheet</Text>
-          </View>
-        </BottomSheet>
-      </Portal>
-    </Host>,
+    <BottomSheet
+      ref={ref}
+      heading={heading}
+      showCancel={showCancel}
+      loading={loading}
+      onClose={mockOnClose}
+      onOpen={mockOnOpen}
+    >
+      <View>
+        <Text>BottomSheet</Text>
+      </View>
+    </BottomSheet>,
   );
 }
 
@@ -78,7 +73,8 @@ it("BottomSheet can be closed with the cancel action", async () => {
     ref.current?.open();
   });
 
-  fireEvent.press(await findByLabelText("Cancel"));
+  const cancelButton = await findByLabelText("Cancel");
+  await userEvent.press(cancelButton);
 
   await waitFor(() => {
     expect(queryByText("BottomSheet")).toBeNull();
@@ -134,15 +130,14 @@ describe("when there is a screen reader enabled", () => {
 
     const { findByLabelText, queryByText } = setup({});
 
-    await waitForUntestableRender(
-      "Wait for AccessibilityInfo.isScreenReaderEnabled to resolve",
-    );
-
     await act(async () => {
       ref.current?.open();
     });
 
-    fireEvent.press(await findByLabelText("Cancel"));
+    const cancelButton = await findByLabelText("Cancel");
+    expect(cancelButton).toBeDefined();
+
+    await userEvent.press(cancelButton);
 
     await waitFor(() => {
       expect(queryByText("BottomSheet")).toBeNull();

package/src/BottomSheet/BottomSheet.tsx

@@ -1,14 +1,19 @@
-import type { ReactNode, Ref, RefObject } from "react";
-import React, { forwardRef, useState } from "react";
-import type { Modalize } from "react-native-modalize";
-import { useSafeAreaInsets } from "react-native-safe-area-context";
+import type { ReactNode } from "react";
+import React, { useCallback, useImperativeHandle, useRef } from "react";
 import { Keyboard, View } from "react-native";
-import { BottomSheetOption } from "./components/BottomSheetOption";
+import { useSafeAreaInsets } from "react-native-safe-area-context";
+import RNBottomSheet, {
+  BottomSheetBackdrop,
+  BottomSheetView,
+} from "@gorhom/bottom-sheet";
+import type { BottomSheetBackdropProps } from "@gorhom/bottom-sheet";
+import { tokens } from "@jobber/design";
 import { useStyles } from "./BottomSheet.style";
-import { UNSAFE_WrappedModalize } from "../ContentOverlay/UNSAFE_WrappedModalize";
-import { useIsScreenReaderEnabled } from "../hooks";
+import { BottomSheetOption } from "./components/BottomSheetOption";
+import { useBottomSheetBackHandler } from "./hooks/useBottomSheetBackHandler";
 import { Divider } from "../Divider";
 import { Heading } from "../Heading";
+import { useIsScreenReaderEnabled } from "../hooks";
 import { useAtlantisI18n } from "../hooks/useAtlantisI18n";
 
 export interface BottomSheetProps {
@@ -40,71 +45,89 @@ export interface BottomSheetProps {
   readonly onClose?: () => void;
 }
 
-export const BottomSheet = forwardRef(BottomSheetInternal);
-
-export type BottomSheetRef = Modalize | undefined;
-
-function BottomSheetInternal(
-  {
-    children,
-    showCancel,
-    loading = false,
-    heading,
-    onOpen,
-    onClose,
-  }: BottomSheetProps,
-  ref: Ref<BottomSheetRef>,
-) {
-  const isScreenReaderEnabled = useIsScreenReaderEnabled();
-  const [open, setOpen] = useState<boolean>(false);
+export interface BottomSheetRef {
+  open: () => void;
+  close: () => void;
+}
+
+export function BottomSheet({
+  children,
+  showCancel,
+  loading = false,
+  heading,
+  onOpen,
+  onClose,
+  ref,
+}: BottomSheetProps & { readonly ref?: React.Ref<BottomSheetRef> }) {
   const styles = useStyles();
+  const isScreenReaderEnabled = useIsScreenReaderEnabled();
+
+  const cancellable = (showCancel && !loading) || isScreenReaderEnabled;
+
+  const { t } = useAtlantisI18n();
+  const insets = useSafeAreaInsets();
+  const previousIndexRef = useRef(-1);
+  const bottomSheetRef = useRef<RNBottomSheet>(null);
+  const { handleSheetPositionChange } =
+    useBottomSheetBackHandler(bottomSheetRef);
+
+  useImperativeHandle(ref, () => ({
+    open: () => {
+      bottomSheetRef.current?.expand();
+    },
+    close: () => {
+      close();
+    },
+  }));
+
+  const close = useCallback(() => {
+    bottomSheetRef.current?.close();
+  }, []);
+
+  const handleChange = (index: number) => {
+    // Handle Android back button
+    handleSheetPositionChange(index);
+
+    const previousIndex = previousIndexRef.current;
+
+    if (previousIndex === -1 && index >= 0) {
+      // Transitioned from closed to open
+      dismissKeyboard();
+      onOpen?.();
+    } else if (previousIndex >= 0 && index === -1) {
+      // Transitioned from open to closed
+      dismissKeyboard();
+      onClose?.();
+    }
+
+    previousIndexRef.current = index;
+  };
 
   return (
-    <>
-      {open && <Overlay styles={styles} />}
-      <UNSAFE_WrappedModalize
-        ref={ref}
-        adjustToContentHeight={true}
-        modalStyle={styles.modal}
-        overlayStyle={styles.overlayModalize}
-        HeaderComponent={
-          heading && <Header heading={heading} styles={styles} />
-        }
-        FooterComponent={
-          <Footer
-            cancellable={(showCancel && !loading) || isScreenReaderEnabled}
-            onCancel={() => {
-              (ref as RefObject<BottomSheetRef>)?.current?.close();
-            }}
-            styles={styles}
-          />
-        }
-        withHandle={false}
-        withReactModal={isScreenReaderEnabled}
-        onOpen={openModal}
-        onClose={closeModal}
+    <RNBottomSheet
+      ref={bottomSheetRef}
+      index={-1}
+      backdropComponent={Backdrop}
+      backgroundStyle={styles.background}
+      enablePanDownToClose={true}
+      onChange={handleChange}
+      keyboardBlurBehavior="restore"
+      handleStyle={styles.handle}
+    >
+      <BottomSheetView
+        style={{
+          paddingBottom: insets.bottom + tokens["space-small"],
+          paddingTop: tokens["space-small"],
+        }}
       >
-        <View
-          style={
-            !showCancel && !isScreenReaderEnabled ? styles.children : undefined
-          }
-        >
-          {children}
-        </View>
-      </UNSAFE_WrappedModalize>
-    </>
+        {heading && <Header heading={heading} styles={styles} />}
+        {children}
+        {cancellable && (
+          <Footer styles={styles} close={close} cancelLabel={t("cancel")} />
+        )}
+      </BottomSheetView>
+    </RNBottomSheet>
   );
-
-  function openModal() {
-    onOpen?.();
-    setOpen(true);
-    dismissKeyboard();
-  }
-
-  function closeModal() {
-    onClose?.();
-    setOpen(false);
-  }
 }
 
 function Header({
@@ -122,31 +145,21 @@ function Header({
 }
 
 function Footer({
-  cancellable,
-  onCancel,
   styles,
+  close,
+  cancelLabel,
 }: {
-  readonly cancellable: boolean;
-  readonly onCancel: () => void;
   readonly styles: ReturnType<typeof useStyles>;
+  readonly close: () => void;
+  readonly cancelLabel: string;
 }) {
-  const insets = useSafeAreaInsets();
-  const { t } = useAtlantisI18n();
-
   return (
-    <View style={{ marginBottom: insets.bottom }}>
-      {cancellable && (
-        <View style={styles.children}>
-          <View style={styles.footerDivider}>
-            <Divider />
-          </View>
-          <BottomSheetOption
-            text={t("cancel")}
-            icon={"remove"}
-            onPress={onCancel}
-          />
-        </View>
-      )}
+    <View>
+      <View style={styles.footerDivider}>
+        <Divider />
+      </View>
+
+      <BottomSheetOption text={cancelLabel} icon="remove" onPress={close} />
     </View>
   );
 }
@@ -157,10 +170,16 @@ function dismissKeyboard() {
   Keyboard.dismiss();
 }
 
-function Overlay({
-  styles,
-}: {
-  readonly styles: ReturnType<typeof useStyles>;
-}) {
-  return <View style={styles.overlay} />;
+function Backdrop(bottomSheetBackdropProps: BottomSheetBackdropProps) {
+  const styles = useStyles();
+
+  return (
+    <BottomSheetBackdrop
+      {...bottomSheetBackdropProps}
+      appearsOnIndex={0}
+      disappearsOnIndex={-1}
+      style={styles.backdrop}
+      opacity={1}
+    />
+  );
 }

package/src/BottomSheet/hooks/useBottomSheetBackHandler.test.ts

@@ -0,0 +1,90 @@
+import { createRef } from "react";
+import type { RefObject } from "react";
+import { act, renderHook } from "@testing-library/react-native";
+import { BackHandler } from "react-native";
+import type BottomSheet from "@gorhom/bottom-sheet";
+import { useBottomSheetBackHandler } from "./useBottomSheetBackHandler";
+
+describe("useBottomSheetBackHandler", () => {
+  let mockRemove: jest.Mock;
+  let mockAddEventListener: jest.SpyInstance;
+
+  beforeEach(() => {
+    mockRemove = jest.fn();
+    mockAddEventListener = jest.spyOn(BackHandler, "addEventListener");
+    mockAddEventListener.mockReturnValue({ remove: mockRemove });
+  });
+
+  afterEach(() => {
+    mockAddEventListener.mockRestore();
+  });
+
+  it("should register BackHandler listener when sheet becomes visible", async () => {
+    const bottomSheetRef = createRef<BottomSheet | null>();
+    const { result } = renderHook(() =>
+      useBottomSheetBackHandler(bottomSheetRef),
+    );
+
+    await act(async () => {
+      result.current.handleSheetPositionChange(0);
+    });
+
+    expect(mockAddEventListener).toHaveBeenCalledWith(
+      "hardwareBackPress",
+      expect.any(Function),
+    );
+  });
+
+  it("should call close() when back button is pressed", async () => {
+    const mockClose = jest.fn();
+    const bottomSheetRef = {
+      current: {
+        close: mockClose,
+      } as unknown as BottomSheet,
+    } as RefObject<BottomSheet | null>;
+
+    const { result } = renderHook(() =>
+      useBottomSheetBackHandler(bottomSheetRef),
+    );
+
+    await act(async () => {
+      result.current.handleSheetPositionChange(0);
+    });
+
+    const registeredCallback = mockAddEventListener.mock.calls[0][1];
+    const returnValue = registeredCallback();
+
+    expect(mockClose).toHaveBeenCalled();
+    expect(returnValue).toBe(true);
+  });
+
+  it("should remove listener when sheet is dismissed", async () => {
+    const bottomSheetRef = createRef<BottomSheet | null>();
+    const { result } = renderHook(() =>
+      useBottomSheetBackHandler(bottomSheetRef),
+    );
+
+    await act(async () => {
+      result.current.handleSheetPositionChange(0);
+    });
+
+    await act(async () => {
+      result.current.handleSheetPositionChange(-1);
+    });
+
+    expect(mockRemove).toHaveBeenCalled();
+  });
+
+  it("should not register listener when index is negative", async () => {
+    const bottomSheetRef = createRef<BottomSheet | null>();
+    const { result } = renderHook(() =>
+      useBottomSheetBackHandler(bottomSheetRef),
+    );
+
+    await act(async () => {
+      result.current.handleSheetPositionChange(-1);
+    });
+
+    expect(mockAddEventListener).not.toHaveBeenCalled();
+  });
+});