@glowhop/core-tour 1.0.2 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @glowhop/core-tour
 
+## 1.1.0
+
+### Minor Changes
+
+- 165797b: `allowScroll` now defaults to `true`: the page stays scrollable while a tour runs. Pass `allowScroll: false` to keep the previous scroll-lock behaviour.
+
 ## 1.0.2
 
 ### Patch Changes

package/index.js

@@ -2983,7 +2983,7 @@ class ActiveStep {
     this.props = createStepPropsStore(this.initialProps, reportSubscriberError, path);
     this.behavior = mergeStepBehavior(defaults.behavior, definition.behavior);
     this.animated = defaults.animated;
-    this.allowScroll = defaults.allowScroll === true;
+    this.allowScroll = defaults.allowScroll !== false;
   }
   reset() {
     this.props.set(this.initialProps);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glowhop/core-tour",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Framework-agnostic tour controller and DOM runtime for GlowTour.js.",
   "license": "MIT",
   "homepage": "https://github.com/Glowhop/GlowTour.js#readme",

package/types/index.d.ts

@@ -186,10 +186,10 @@ export interface StartOptions<T> {
     /** Allow users to cancel the tour. @default true */
     cancellable?: boolean;
     /**
-     * Locks page scroll while the tour is active, restoring it on finish,
-     * cancel, error, or dispose.
+     * Leaves page scroll available while the tour is active. Set `false` to lock
+     * scroll instead, restoring it on finish, cancel, error, or dispose.
      *
-     * @default false
+     * @default true
      */
     allowScroll?: boolean;
     /** Default overlay options for all steps. */