fix: SpotlightPopoverTour bugs (#1826)

razorpay · Nov 28, 2023 · 0d0e72e · 0d0e72e
1 parent bda6e34
commit 0d0e72e
Show file tree

Hide file tree

Showing 14 changed files with 651 additions and 111 deletions.
diff --git a/.changeset/three-glasses-complain.md b/.changeset/three-glasses-complain.md
@@ -0,0 +1,9 @@
+---
+"@razorpay/blade": patch
+---
+
+fix(blade): fixed SpotlightPopoverTour bugs
+
+- Safari body-scroll-lock causing the page to get clipped because storybook doesn't set width/height on body - fixed by setting width/height
+- Initial delay of opening the mask - fixed by immediately updating the mask size on initial render
+- Delay of transitioning between steps which occurs because we need to wait for the animation to finish before scrolling otherwise the scroll gets interrupted - fixed by reduced this to 100ms
diff --git a/packages/blade/.storybook/react/global.css b/packages/blade/.storybook/react/global.css
@@ -2,3 +2,8 @@
   /* Need this to ensure mdx stories don't break visually */
   box-sizing: border-box;
 }
+
+body {
+  width: 100%;
+  height: 100%;
+}
diff --git a/packages/blade/docs/guides/Usage.stories.mdx b/packages/blade/docs/guides/Usage.stories.mdx
@@ -45,6 +45,20 @@ function AppWrapper(): JSX.Element {
 export default AppWrapper;
 ```
 
+## iOS Safari Specific Setup
+
+When using BottomSheet or SpotlightPopoverTour, 
+Make sure to set a width/height to the `body` otherwise when they open, the page will get clipped. 
+
+This happens due to a bug in iOS safari where it won't compute the height of the body correctly.
+
+```css
+body {
+  width: 100%;
+  height: 100%;
+}
+```
+
 ## Mapping Components from Figma to Blade in your code
 
 Blade is built with **"What you see in Figma is what you get on Code" ** philosophy.

diff --git a/packages/blade/src/components/BottomSheet/BottomSheet.stories.tsx b/packages/blade/src/components/BottomSheet/BottomSheet.stories.tsx
@@ -47,6 +47,7 @@ import { Link } from '~components/Link';
 import { Sandbox } from '~utils/storybook/Sandbox';
 import StoryPageWrapper from '~utils/storybook/StoryPageWrapper';
 import { isReactNative } from '~utils';
+import { SandboxHighlighter } from '~utils/storybook/Sandbox/SandpackEditor';
 
 const Page = (): React.ReactElement => {
   return (
@@ -134,6 +135,20 @@ const Page = (): React.ReactElement => {
           export default App;
         `}
       </Sandbox>
+      <Title>iOS Safari Specific Setup</Title>
+      <Text marginTop="spacing.4">
+        When using BottomSheet or SpotlightPopoverTour, Make sure to set a width/height to the
+        `body` otherwise when they open, the page will get clipped. This happens due to a bug in iOS
+        safari where it won't compute the height of the body correctly.
+      </Text>
+      <SandboxHighlighter showLineNumbers={false} theme="light">
+        {`
+          body {
+            width: 100%;
+            height: 100%;
+          }
+        `}
+      </SandboxHighlighter>
     </StoryPageWrapper>
   );
 };
@@ -225,6 +240,51 @@ const BottomSheetTemplate: ComponentStory<typeof BottomSheetComponent> = ({ ...a
   return (
     <BaseBox>
       <Button onClick={() => setIsOpen(true)}>{isOpen ? 'close' : 'open'}</Button>
+      <Text marginY="spacing.11">
+        Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has
+        been the industry's standard dummy text ever since the 1500s, when an unknown printer took a
+        galley of type and scrambled it to make a type specimen book. It has survived not only five
+        centuries, but also the leap into electronic typesetting, remaining essentially unchanged.
+        It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum
+        passages, and more recently with desktop publishing software like Aldus PageMaker including
+        versions of Lorem Ipsum.
+      </Text>
+      <Text marginY="spacing.11">
+        Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has
+        been the industry's standard dummy text ever since the 1500s, when an unknown printer took a
+        galley of type and scrambled it to make a type specimen book. It has survived not only five
+        centuries, but also the leap into electronic typesetting, remaining essentially unchanged.
+        It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum
+        passages, and more recently with desktop publishing software like Aldus PageMaker including
+        versions of Lorem Ipsum.
+      </Text>
+      <Text marginY="spacing.11">
+        Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has
+        been the industry's standard dummy text ever since the 1500s, when an unknown printer took a
+        galley of type and scrambled it to make a type specimen book. It has survived not only five
+        centuries, but also the leap into electronic typesetting, remaining essentially unchanged.
+        It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum
+        passages, and more recently with desktop publishing software like Aldus PageMaker including
+        versions of Lorem Ipsum.
+      </Text>
+      <Text marginY="spacing.11">
+        Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has
+        been the industry's standard dummy text ever since the 1500s, when an unknown printer took a
+        galley of type and scrambled it to make a type specimen book. It has survived not only five
+        centuries, but also the leap into electronic typesetting, remaining essentially unchanged.
+        It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum
+        passages, and more recently with desktop publishing software like Aldus PageMaker including
+        versions of Lorem Ipsum.
+      </Text>
+      <Text marginY="spacing.11">
+        Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has
+        been the industry's standard dummy text ever since the 1500s, when an unknown printer took a
+        galley of type and scrambled it to make a type specimen book. It has survived not only five
+        centuries, but also the leap into electronic typesetting, remaining essentially unchanged.
+        It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum
+        passages, and more recently with desktop publishing software like Aldus PageMaker including
+        versions of Lorem Ipsum.
+      </Text>
       <BottomSheetComponent
         {...args}
         isOpen={isOpen}

diff --git a/packages/blade/src/components/SpotlightPopoverTour/Tour.web.tsx b/packages/blade/src/components/SpotlightPopoverTour/Tour.web.tsx
@@ -37,10 +37,11 @@ const SpotlightPopoverTour = ({
   });
 
   // delayed state is used to let the transition finish before reacting to the state changes
-  const delayedActiveStep = useDelayedState(activeStep, transitionDelay);
-  const delayedSize = useDelayedState(size, transitionDelay);
+  const [delayedActiveStep] = useDelayedState(activeStep, transitionDelay);
+  const [delayedSize, setDelayedSize] = useDelayedState(size, transitionDelay);
   // keep track of when we are transitioning between steps
   const isTransitioning = useIsTransitioningBetweenSteps(activeStep, transitionDelay);
+  const [isScrolling, setIsScrolling] = useState(false);
 
   const currentStepRef = refIdMap.get(steps[activeStep]?.name);
   const intersection = useIntersectionObserver(currentStepRef!, {
@@ -96,18 +97,29 @@ const SpotlightPopoverTour = ({
     });
   }, []);
 
-  const updateMaskSize = useCallback(() => {
-    const ref = refIdMap.get(steps[activeStep]?.name);
-    if (!ref?.current) return;
+  const updateMaskSize = useCallback(
+    (shouldSkipDelay = false) => {
+      const ref = refIdMap.get(steps[activeStep]?.name);
+      if (!ref?.current) return;
 
-    const rect = ref.current.getBoundingClientRect();
-    setSize({
-      x: rect.x,
-      y: rect.y,
-      width: rect.width,
-      height: rect.height,
-    });
-  }, [activeStep, refIdMap, steps]);
+      const rect = ref.current.getBoundingClientRect();
+      setSize({
+        x: rect.x,
+        y: rect.y,
+        width: rect.width,
+        height: rect.height,
+      });
+      if (shouldSkipDelay) {
+        setDelayedSize({
+          x: rect.x,
+          y: rect.y,
+          width: rect.width,
+          height: rect.height,
+        });
+      }
+    },
+    [activeStep, refIdMap, setDelayedSize, steps],
+  );
 
   const scrollToStep = useCallback(() => {
     const ref = refIdMap.get(steps[delayedActiveStep]?.name);
@@ -116,39 +128,44 @@ const SpotlightPopoverTour = ({
     // If the element is already in view, don't scroll
     if (intersection?.isIntersecting) return;
 
+    setIsScrolling(true);
     smoothScroll(ref.current, {
       behavior: 'smooth',
       block: 'center',
       inline: 'center',
     })
       .then(() => {
-        updateMaskSize();
+        // wait for the scroll to finish before updating the mask size
+        // We also don't want to delay the size update since its already delayed by the scroll
+        updateMaskSize(true);
       })
       .finally(() => {
-        // do nothing
+        setIsScrolling(false);
       });
   }, [delayedActiveStep, refIdMap, steps, updateMaskSize, intersection?.isIntersecting]);
 
   // Update the size of the mask when the active step changes
   useIsomorphicLayoutEffect(() => {
     updateMaskSize();
-  }, [isOpen, activeStep, refIdMap, steps, updateMaskSize]);
+  }, [activeStep, updateMaskSize]);
 
   // Scroll into view when the active step changes
   useIsomorphicLayoutEffect(() => {
+    // We need to wait for the transition to finish before scrolling
+    // Otherwise the browser sometimes interrupts the scroll
+    const scrollDelay = 100;
     setTimeout(() => {
       if (!isOpen) return;
       if (isTransitioning) return;
       scrollToStep();
-    }, transitionDelay);
+    }, scrollDelay);
   }, [isOpen, scrollToStep, isTransitioning]);
 
-  useLockBodyScroll(isOpen);
-
   // reset the mask size when the tour is closed
-  React.useEffect(() => {
+  useIsomorphicLayoutEffect(() => {
     if (isOpen) {
-      updateMaskSize();
+      // on initial mount, we don't want to delay the size update
+      updateMaskSize(true);
       onOpenChange?.({ isOpen });
     }
     if (!isOpen) {
@@ -162,6 +179,8 @@ const SpotlightPopoverTour = ({
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [isOpen]);
 
+  useLockBodyScroll(isOpen);
+
   const contextValue = useMemo(() => {
     return { attachStep, removeStep };
   }, [attachStep, removeStep]);
@@ -171,7 +190,7 @@ const SpotlightPopoverTour = ({
       <FloatingPortal>
         {isOpen ? (
           <SpotlightPopoverTourMask
-            isTransitioning={isTransitioning}
+            isTransitioning={isTransitioning || isScrolling}
             padding={theme.spacing[4]}
             size={delayedSize}
           />

diff --git a/packages/blade/src/components/SpotlightPopoverTour/TourPopover.web.tsx b/packages/blade/src/components/SpotlightPopoverTour/TourPopover.web.tsx
@@ -12,7 +12,6 @@ import {
   useTransitionStyles,
   autoUpdate,
   useClick,
-  useDismiss,
   FloatingFocusManager,
 } from '@floating-ui/react';
 import React from 'react';
@@ -108,10 +107,9 @@ const TourPopover = ({
   // remove click handler if popover is controlled
   const isControlled = isOpen !== undefined;
   const click = useClick(context, { enabled: !isControlled });
-  const dismiss = useDismiss(context);
   const role = useRole(context);
 
-  const { getFloatingProps } = useInteractions([click, dismiss, role]);
+  const { getFloatingProps } = useInteractions([click, role]);
 
   const contextValue = React.useMemo(() => {
     return {

diff --git a/...s/blade/src/components/SpotlightPopoverTour/_KitchenSink.SpotlightPopoverTour.stories.tsx b/...s/blade/src/components/SpotlightPopoverTour/_KitchenSink.SpotlightPopoverTour.stories.tsx
@@ -1,11 +1,11 @@
 import { composeStories } from '@storybook/react';
-import * as tourStories from './Tour.stories';
+import * as tourStories from './docs/Tour.stories';
 import { Box } from '~components/Box';
 import { Heading } from '~components/Typography';
 
 const allStories = Object.values(composeStories(tourStories));
 
-export const Tour = (): JSX.Element => {
+export const SpotlightPopoverTour = (): JSX.Element => {
   return (
     <Box display="flex" flexDirection="column" gap="spacing.4">
       {allStories.map((Story) => {
@@ -21,8 +21,8 @@ export const Tour = (): JSX.Element => {
 };
 
 export default {
-  title: 'Components/KitchenSink/Tour',
-  component: Tour,
+  title: 'Components/KitchenSink/SpotlightPopoverTour',
+  component: SpotlightPopoverTour,
   parameters: {
     // enable Chromatic's snapshotting only for kitchensink
     chromatic: { disableSnapshot: false },

diff --git a/packages/blade/src/components/SpotlightPopoverTour/docs/Tour.stories.mdx b/packages/blade/src/components/SpotlightPopoverTour/docs/Tour.stories.mdx
@@ -0,0 +1,6 @@
+import { Meta } from '@storybook/addon-docs';
+import { TourDocs } from './TourDocs.stories';
+
+<Meta title="Components/SpotlightPopoverTour/Docs" />
+
+<TourDocs />