Update Tour Mode

Author: mdmintz

help_docs/method_summary.md

@@ -654,8 +654,8 @@ self.set_introjs_colors(theme_color=None, hover_color=None)
 self.add_tour_step(message, selector=None, name=None,
                    title=None, theme=None, alignment=None)
 
-self.play_tour(name=None, interval=0, pgkeys=False)
-# Duplicates: self.start_tour(name=None, interval=0, pgkeys=False):
+self.play_tour(name=None, interval=0)
+# Duplicates: self.start_tour(name=None, interval=0):
 
 self.export_tour(name=None, filename="my_tour.js", url=None)
 

seleniumbase/core/tour_helper.py

@@ -14,14 +14,12 @@
 EXPORTED_TOURS_FOLDER = constants.Tours.EXPORTED_TOURS_FOLDER
 
 
-def activate_bootstrap(driver, pgkeys=False):
+def activate_bootstrap(driver):
     """Allows you to use Bootstrap Tours with SeleniumBase
     http://bootstraptour.com/
     """
     bootstrap_tour_css = constants.BootstrapTour.MIN_CSS
     bootstrap_tour_js = constants.BootstrapTour.MIN_JS
-    if pgkeys:
-        bootstrap_tour_js = constants.BootstrapTour.MIN_JS_SB
 
     verify_script = """// Verify Bootstrap Tour activated
                      var tour2 = new Tour({
@@ -58,15 +56,13 @@ def is_bootstrap_activated(driver):
         return False
 
 
-def activate_driverjs(driver, pgkeys=False):
+def activate_driverjs(driver):
     """Allows you to use DriverJS Tours with SeleniumBase
     https://kamranahmed.info/driver.js/
     """
     backdrop_style = style_sheet.get_dt_backdrop_style()
     driverjs_css = constants.DriverJS.MIN_CSS
     driverjs_js = constants.DriverJS.MIN_JS
-    if pgkeys:
-        driverjs_js = constants.DriverJS.MIN_JS_SB
 
     verify_script = """// Verify DriverJS activated
                      var driverjs2 = Driver.name;
@@ -148,14 +144,12 @@ def is_hopscotch_activated(driver):
         return False
 
 
-def activate_introjs(driver, pgkeys=False):
+def activate_introjs(driver):
     """Allows you to use IntroJS Tours with SeleniumBase
     https://introjs.com/
     """
     intro_css = constants.IntroJS.MIN_CSS
     intro_js = constants.IntroJS.MIN_JS
-    if pgkeys:
-        intro_js = constants.IntroJS.MIN_JS_SB
 
     theme_color = sb_config.introjs_theme_color
     hover_color = sb_config.introjs_hover_color
@@ -269,6 +263,13 @@ def play_shepherd_tour(driver, tour_steps, msg_dur, name=None, interval=0):
         // Start the tour
         tour.start();
         $tour = tour;"""
+    instructions += """
+        document.body.addEventListener('keyup', function (event) {
+        if (event.key === 'PageUp' || event.key === 'ArrowLeft') {
+            Shepherd.activeTour.back(); }
+        if (event.key === 'PageDown' || event.key === 'ArrowRight') {
+            Shepherd.activeTour.next(); }
+        })"""
     autoplay = False
     if interval and interval > 0:
         autoplay = True
@@ -302,6 +303,16 @@ def play_shepherd_tour(driver, tour_steps, msg_dur, name=None, interval=0):
                 "" % selector
             )
     driver.execute_script(instructions)
+    try:
+        page_actions.wait_for_element_visible(
+            driver, "a.tour-button-right", by="css selector", timeout=1.2
+        )
+    except Exception:
+        pass
+    try:
+        driver.execute_script('document.activeElement.blur();')
+    except Exception:
+        pass
     tour_on = True
     if autoplay:
         start_ms = time.time() * 1000.0
@@ -389,13 +400,7 @@ def play_shepherd_tour(driver, tour_steps, msg_dur, name=None, interval=0):
 
 
 def play_bootstrap_tour(
-    driver,
-    tour_steps,
-    browser,
-    msg_dur,
-    name=None,
-    interval=0,
-    pgkeys=False,
+    driver, tour_steps, browser, msg_dur, name=None, interval=0
 ):
     """Plays a Bootstrap tour on the current website."""
     instructions = ""
@@ -410,18 +415,15 @@ def play_bootstrap_tour(
         tour.restart();
         // Save for later
         $tour = tour;"""
-
     if interval and interval > 0:
         if interval < 1:
             interval = 1
         interval = str(float(interval) * 1000.0)
         instructions = instructions.replace(
             "duration: 0,", "duration: %s," % interval
         )
-
     if not is_bootstrap_activated(driver):
-        activate_bootstrap(driver, pgkeys)
-
+        activate_bootstrap(driver)
     if len(tour_steps[name]) > 1:
         try:
             if "element: " in tour_steps[name][1]:
@@ -447,7 +449,6 @@ def play_bootstrap_tour(
                 "Exiting due to failure on first tour step!"
                 "" % selector
             )
-
     driver.execute_script(instructions)
     tour_on = True
     try:
@@ -497,13 +498,7 @@ def play_bootstrap_tour(
 
 
 def play_driverjs_tour(
-    driver,
-    tour_steps,
-    browser,
-    msg_dur,
-    name=None,
-    interval=0,
-    pgkeys=False,
+    driver, tour_steps, browser, msg_dur, name=None, interval=0
 ):
     """Plays a DriverJS tour on the current website."""
     instructions = ""
@@ -514,6 +509,11 @@ def play_driverjs_tour(
         // Start the tour!
         tour.start();
         $tour = tour;"""
+    instructions += """
+        document.body.addEventListener('keyup', function (event) {
+        if (event.key === 'PageUp') { $tour.movePrevious(); }
+        if (event.key === 'PageDown') { $tour.moveNext(); }
+        })"""
     autoplay = False
     if interval and interval > 0:
         autoplay = True
@@ -522,7 +522,7 @@ def play_driverjs_tour(
             interval = 0.5
 
     if not is_driverjs_activated(driver):
-        activate_driverjs(driver, pgkeys)
+        activate_driverjs(driver)
 
     if len(tour_steps[name]) > 1:
         try:
@@ -641,6 +641,13 @@ def play_hopscotch_tour(
         // Start the tour!
         hopscotch.startTour(tour);
         $tour = hopscotch;"""
+    instructions += """
+        document.body.addEventListener('keyup', function (event) {
+        if (event.key === 'PageUp' || event.key === 'ArrowLeft') {
+            $tour.prevStep(); }
+        if (event.key === 'PageDown' || event.key === 'ArrowRight') {
+            $tour.nextStep(); }
+        })"""
     autoplay = False
     if interval and interval > 0:
         autoplay = True
@@ -678,6 +685,16 @@ def play_hopscotch_tour(
             )
 
     driver.execute_script(instructions)
+    try:
+        page_actions.wait_for_element_visible(
+            driver, "button.hopscotch-next", by="css selector", timeout=1.2
+        )
+    except Exception:
+        pass
+    try:
+        driver.execute_script('document.activeElement.blur();')
+    except Exception:
+        pass
     tour_on = True
     if autoplay:
         start_ms = time.time() * 1000.0
@@ -749,13 +766,7 @@ def play_hopscotch_tour(
 
 
 def play_introjs_tour(
-    driver,
-    tour_steps,
-    browser,
-    msg_dur,
-    name=None,
-    interval=0,
-    pgkeys=False,
+    driver, tour_steps, browser, msg_dur, name=None, interval=0
 ):
     """Plays an IntroJS tour on the current website."""
     instructions = ""
@@ -779,6 +790,11 @@ def play_introjs_tour(
         // Start the tour
         startIntro();
         """
+    instructions += """
+        document.body.addEventListener('keyup', function (event) {
+        if (event.key === 'PageUp') { $tour.previousStep(); }
+        if (event.key === 'PageDown') { $tour.nextStep(); }
+        })"""
     autoplay = False
     if interval and interval > 0:
         autoplay = True
@@ -787,7 +803,7 @@ def play_introjs_tour(
             interval = 0.5
 
     if not is_introjs_activated(driver):
-        activate_introjs(driver, pgkeys)
+        activate_introjs(driver)
 
     if len(tour_steps[name]) > 1:
         try:

seleniumbase/fixtures/base_case.py

@@ -11695,17 +11695,13 @@ def __add_introjs_tour_step(
         )
         self._tour_steps[name].append(step)
 
-    def play_tour(self, name=None, interval=0, pgkeys=False):
+    def play_tour(self, name=None, interval=0):
         """Plays a tour on the current website.
         @Params
         name - If creating multiple tours at the same time,
                use this to select the tour you wish to add steps to.
         interval - The delay time between autoplaying tour steps. (Seconds)
-                   If set to 0 (default), the tour is fully manual control.
-        pgkeys - Lets you control tours using the page-up / page-down keys.
-                 This only works on Bootstrap, DriverJS, and IntroJS tours.
-                 If the tour is part of a presentation that uses a clicker,
-                 then you'll need this enabled for the clicker to work."""
+                   If set to 0 (default), the tour is fully manual control."""
         from seleniumbase.core import tour_helper
 
         if self.headless or self.headless2 or self.xvfb:
@@ -11727,7 +11723,6 @@ def play_tour(self, name=None, interval=0, pgkeys=False):
                 self.message_duration,
                 name=name,
                 interval=interval,
-                pgkeys=pgkeys,
             )
         elif "DriverJS" in self._tour_steps[name][0]:
             tour_helper.play_driverjs_tour(
@@ -11737,7 +11732,6 @@ def play_tour(self, name=None, interval=0, pgkeys=False):
                 self.message_duration,
                 name=name,
                 interval=interval,
-                pgkeys=pgkeys,
             )
         elif "Hopscotch" in self._tour_steps[name][0]:
             tour_helper.play_hopscotch_tour(
@@ -11756,7 +11750,6 @@ def play_tour(self, name=None, interval=0, pgkeys=False):
                 self.message_duration,
                 name=name,
                 interval=interval,
-                pgkeys=pgkeys,
             )
         else:
             tour_helper.play_shepherd_tour(
@@ -11767,9 +11760,9 @@ def play_tour(self, name=None, interval=0, pgkeys=False):
                 interval=interval,
             )
 
-    def start_tour(self, name=None, interval=0, pgkeys=False):
+    def start_tour(self, name=None, interval=0):
         """Same as self.play_tour()"""
-        self.play_tour(name=name, interval=interval, pgkeys=pgkeys)
+        self.play_tour(name=name, interval=interval)
 
     def export_tour(self, name=None, filename="my_tour.js", url=None):
         """Exports a tour as a JS file.

seleniumbase/fixtures/constants.py

@@ -240,19 +240,15 @@ class BootstrapTour:
     LIB = "https://cdnjs.cloudflare.com/ajax/libs/bootstrap-tour"
     VER = "0.12.0"
     MIN_CSS = "%s/%s/css/bootstrap-tour-standalone.min.css" % (LIB, VER)
-    MIN_JS = "%s/%s/js/bootstrap-tour-standalone.min.js" % (LIB, VER)
-    MIN_JS_SB = (
-        "https://seleniumbase.github.io/cdn/js/"
-        "bootstrap-tour-standalone.min.js"
-    )
+    # MIN_JS = "%s/%s/js/bootstrap-tour-standalone.min.js" % (LIB, VER)
+    MIN_JS = "https://seleniumbase.github.io/cdn/js/bootstraptour.min.js"
 
 
 class DriverJS:
     LIB = "https://cdn.jsdelivr.net/npm/driver.js"
     VER = "0.9.8"
     MIN_CSS = "%s@%s/dist/driver.min.css" % (LIB, VER)
     MIN_JS = "%s@%s/dist/driver.min.js" % (LIB, VER)
-    MIN_JS_SB = "https://seleniumbase.github.io/cdn/js/driver.min.js"
 
 
 class Hopscotch:
@@ -269,7 +265,6 @@ class IntroJS:
         "intro.js@%s/minified/introjs.min.css" % VER
     )
     MIN_JS = "https://cdn.jsdelivr.net/npm/intro.js@%s/intro.min.js" % VER
-    MIN_JS_SB = "https://seleniumbase.github.io/cdn/js/intro.min.js"
 
 
 class TourColor: