@tent-official/react-walkthrough 1.2.0 → 1.3.0

package/README.md

@@ -92,6 +92,7 @@ Hook to register a walkthrough tour.
 | `displayTotal` | `number` | — | Override the total step count displayed in the step counter (display-only, does not affect logic) |
 | `displayStepOffset` | `number` | `0` | Offset added to the displayed current step number (display-only, does not affect logic). e.g. `displayStepOffset: 3` with 3 real steps shows 4/total → 5/total → 6/total |
 | `isClearLastPositionOnEnd` | `boolean` | `false` | When `true`, clears the saved last highlight position when the tour ends. This prevents the next tour from animating its highlight from this tour's last position |
+| `onStepNext` | `Record<number, () => void>` | — | Callbacks fired when the user clicks "Next" on a specific step. The key is the original step index (0-based). Called right before advancing to the next step |
 
 **Returns:** `{ start: () => void }`
 
@@ -113,6 +114,9 @@ Hook to register a walkthrough tour.
 | `nextLabel` | `string` | — | Override tour-level `nextLabel` for this step |
 | `prevLabel` | `string` | — | Override tour-level `prevLabel` for this step |
 | `skipLabel` | `string` | — | Override tour-level `skipLabel` for this step |
+| `displayStep` | `number` | — | Override the displayed current step number for this step (display-only, does not affect logic) |
+| `displayTotal` | `number` | — | Override the displayed total step count for this step (display-only, does not affect logic) |
+| `forceRecompute` | `boolean` | `false` | When `true`, forces a recompute of valid steps after advancing from this step. Useful when the next step's element is hidden/conditional and needs DOM changes to become visible |
 
 ### `IStepDescription`
 
@@ -254,6 +258,45 @@ The popover automatically positions itself to stay within the viewport:
 
 The popover also waits for the target element to be scrolled into view before appearing.
 
+## Step-Level Callbacks (`onStepNext`)
+
+Use `onStepNext` to fire a custom function when the user clicks "Next" on a specific step. The key is the original step index (0-based):
+
+```jsx
+useWalkthrough({
+  name: "setup-tour",
+  steps: [
+    { el: "print-side", title: "Print Side", description: [{ description: "Select print side" }] },
+    { el: "print-system", title: "Print System", description: [{ description: "Select print system" }] },
+    { el: "print-color", title: "Print Color", description: [{ description: "Select color" }] },
+  ],
+  onStepNext: {
+    0: () => openPrintSystemDropdown(),   // fired when leaving step 0
+    1: () => fetchColorOptions(),          // fired when leaving step 1
+  },
+});
+```
+
+## Force Recompute (`forceRecompute`)
+
+When a step's next element is conditionally rendered (hidden until some action), use `forceRecompute` to wait for it to appear before advancing:
+
+```jsx
+steps: [
+  {
+    el: "print-side",
+    title: "Print Side",
+    forceRecompute: true, // wait for next element to appear after advancing
+    description: [{ description: "Select print side — the next section will appear after selection" }],
+  },
+  {
+    el: "print-system", // this element is hidden until print-side is selected
+    title: "Print System",
+    description: [{ description: "Now select the print system" }],
+  },
+]
+```
+
 ## License
 
 MIT

package/dist/index.d.mts

@@ -103,6 +103,8 @@ interface IUseWalkthroughOptions {
     displayStepOffset?: number;
     /** When true, clears the saved last highlight position when the tour ends. This prevents the next tour from animating its highlight FROM this tour's last position. Default: false */
     isClearLastPositionOnEnd?: boolean;
+    /** Callbacks fired when the user clicks "Next" on a specific step. The key is the original step index (0-based). Called right before advancing to the next step. Example: `onStepNext: { 0: () => openDropdown(), 2: () => fetchData() }` */
+    onStepNext?: Record<number, () => void>;
 }
 /**
  * Return value of the useWalkthrough hook.

package/dist/index.d.ts

@@ -103,6 +103,8 @@ interface IUseWalkthroughOptions {
     displayStepOffset?: number;
     /** When true, clears the saved last highlight position when the tour ends. This prevents the next tour from animating its highlight FROM this tour's last position. Default: false */
     isClearLastPositionOnEnd?: boolean;
+    /** Callbacks fired when the user clicks "Next" on a specific step. The key is the original step index (0-based). Called right before advancing to the next step. Example: `onStepNext: { 0: () => openDropdown(), 2: () => fetchData() }` */
+    onStepNext?: Record<number, () => void>;
 }
 /**
  * Return value of the useWalkthrough hook.

package/dist/index.js

@@ -222,11 +222,13 @@ var useWalkthrough = ({
   animationSpeed = 350,
   displayTotal,
   displayStepOffset,
-  isClearLastPositionOnEnd = false
+  isClearLastPositionOnEnd = false,
+  onStepNext
 }) => {
   const started = react.useRef(false);
   const onCompleteRef = react.useRef(onWalkthroughComplete);
   const handleWhenLastStepRef = react.useRef(handleWhenLastStep);
+  const onStepNextRef = react.useRef(onStepNext);
   const conditionMet = startWhenCondition === void 0 ? true : typeof startWhenCondition === "function" ? startWhenCondition() : !!startWhenCondition;
   react.useEffect(() => {
     onCompleteRef.current = onWalkthroughComplete;
@@ -234,6 +236,9 @@ var useWalkthrough = ({
   react.useEffect(() => {
     handleWhenLastStepRef.current = handleWhenLastStep;
   }, [handleWhenLastStep]);
+  react.useEffect(() => {
+    onStepNextRef.current = onStepNext;
+  }, [onStepNext]);
   const start = react.useCallback(() => {
     if (isDone(storageSuffix, name) || started.current) return;
     started.current = true;
@@ -257,7 +262,8 @@ var useWalkthrough = ({
         animationSpeed,
         displayTotal,
         displayStepOffset,
-        isClearLastPositionOnEnd
+        isClearLastPositionOnEnd,
+        onStepNext: onStepNextRef.current
       }
     });
   }, [
@@ -983,6 +989,12 @@ var WalkthroughOverlay = ({
     }
   };
   const next = () => {
+    var _a2;
+    const currentOrigIdx = validSteps[currentValidPos]._originalIdx;
+    const stepNextCb = (_a2 = activeTour.onStepNext) == null ? void 0 : _a2[currentOrigIdx];
+    if (typeof stepNextCb === "function") {
+      stepNextCb();
+    }
     const hasTrigger = !!step.triggerElOnNext;
     if (hasTrigger) {
       setPopoverHidden(true);
@@ -995,8 +1007,8 @@ var WalkthroughOverlay = ({
         triggerTarget.dispatchEvent(new MouseEvent("mouseup", { bubbles: true, cancelable: true, button: 0 }));
         triggerTarget.click();
       }
-      const currentOrigIdx = validSteps[currentValidPos]._originalIdx;
-      const nextOrigIdx = currentOrigIdx + 1;
+      const currentOrigIdx2 = validSteps[currentValidPos]._originalIdx;
+      const nextOrigIdx = currentOrigIdx2 + 1;
       const nextStepDef = activeTour.steps[nextOrigIdx];
       if (nextStepDef) {
         const nextElId = resolveElId(nextStepDef.el);