fixed the tour now closing when a custom onClose function is provid…

…ed. `onClose` now allows you to return a boolean to prevent the tour from closing if you wish.
EitanElbaz · Jul 6, 2023 · ad9c125 · ad9c125
1 parent 729a53a
commit ad9c125
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/src/Context.ts b/src/Context.ts
@@ -5,7 +5,7 @@ const ReactGrandTourContext = createContext<ReactGrandTourContextType>({
     open: () => {},
     openWith: () => {},
     steps: [],
-    close: () => {},
+    close: () => true,
     isOpen: false,
     goToStep: () => {},
     goBack: () => {},

diff --git a/src/ReactGrandTour.tsx b/src/ReactGrandTour.tsx
@@ -79,12 +79,13 @@ const ReactGrandTour: React.FC<Props> = ({
             if (reason === 'escape' && disableCloseOnEscape) return;
             if (reason === 'backdrop' && disableCloseOnBackdropClick) return;
 
-            if (onClose) {
-                onClose(reason);
-            } else {
+            const shouldClose = onClose ? onClose(reason) : true;
+            if (shouldClose) {
                 setOpen(false);
+                setSteps(defaultSteps);
             }
-            setSteps(defaultSteps);
+
+            return true;
         },
         [
             onClose,

diff --git a/src/types.ts b/src/types.ts
@@ -4,7 +4,8 @@ export type ReactGrandTourProps = ComponentVisibility &
     Partial<ComponentOverrides> & {
         open?: boolean;
         onOpen?: () => void;
-        onClose?: (reason?: ReactGrandTourCloseReason) => void;
+        // returning false will prevent the tour from closing
+        onClose?: (reason?: ReactGrandTourCloseReason) => boolean;
         onStepChange?: (props: OnStepChangeProps) => void;
         openAt?: number;
         steps?: ReactGrandTourStep[];