Add disableScroll to types (#522)

shipshapecode · Aug 19, 2019 · 44683c3 · 44683c3
1 parent dbb5578
commit 44683c3
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/types/tour.d.ts b/src/types/tour.d.ts
@@ -110,6 +110,12 @@ declare namespace Tour {
      */
     defaultStepOptions?: Step.StepOptions;
 
+    /**
+     * When set to true, will keep the user from scrolling with the scrollbar,
+     * mousewheel, arrow keys, etc. You may want to use this to ensure you are driving the scroll position with the tour.
+     */
+    disableScroll?: boolean;
+
     /**
      * Exiting the tour with the escape key will be enabled unless this is explicitly
      * set to false.