Add option to use the "Page-Up"/"Page-Down" keys for Tours

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)
-# Duplicates: self.start_tour(name=None, interval=0):
+self.play_tour(name=None, interval=0, pgkeys=False)
+# Duplicates: self.start_tour(name=None, interval=0, pgkeys=False):
 
 self.export_tour(name=None, filename="my_tour.js", url=None)
 

seleniumbase/core/tour_helper.py

@@ -1,7 +1,5 @@
-"""
-This module contains methods for running website tours.
-These helper methods SHOULD NOT be called directly from tests.
-"""
+"""This module contains methods for running website tours.
+These helper methods SHOULD NOT be called directly from tests."""
 import os
 import re
 import textwrap
@@ -16,12 +14,14 @@
 EXPORTED_TOURS_FOLDER = constants.Tours.EXPORTED_TOURS_FOLDER
 
 
-def activate_bootstrap(driver):
+def activate_bootstrap(driver, pgkeys=False):
     """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,19 +58,20 @@ def is_bootstrap_activated(driver):
         return False
 
 
-def activate_driverjs(driver):
+def activate_driverjs(driver, pgkeys=False):
     """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;
                      """
 
-    activate_bootstrap(driver)
     js_utils.wait_for_ready_state_complete(driver)
     js_utils.wait_for_angularjs(driver)
     js_utils.add_css_style(driver, backdrop_style)
@@ -115,7 +116,6 @@ def activate_hopscotch(driver):
                      var hops = hopscotch.isActive;
                      """
 
-    activate_bootstrap(driver)
     js_utils.wait_for_ready_state_complete(driver)
     js_utils.wait_for_angularjs(driver)
     js_utils.add_css_style(driver, backdrop_style)
@@ -148,12 +148,14 @@ def is_hopscotch_activated(driver):
         return False
 
 
-def activate_introjs(driver):
+def activate_introjs(driver, pgkeys=False):
     """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
@@ -169,7 +171,6 @@ def activate_introjs(driver):
                      var intro2 = introJs();
                      """
 
-    activate_bootstrap(driver)
     js_utils.wait_for_ready_state_complete(driver)
     js_utils.wait_for_angularjs(driver)
     js_utils.add_css_style(driver, backdrop_style)
@@ -218,7 +219,6 @@ def activate_shepherd(driver):
     sh_style = style_sheet.get_sh_style_test()
     backdrop_style = style_sheet.get_sh_backdrop_style()
 
-    activate_bootstrap(driver)
     js_utils.wait_for_ready_state_complete(driver)
     js_utils.wait_for_angularjs(driver)
     js_utils.add_css_style(driver, backdrop_style)
@@ -389,7 +389,13 @@ 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
+    driver,
+    tour_steps,
+    browser,
+    msg_dur,
+    name=None,
+    interval=0,
+    pgkeys=False,
 ):
     """Plays a Bootstrap tour on the current website."""
     instructions = ""
@@ -414,7 +420,7 @@ def play_bootstrap_tour(
         )
 
     if not is_bootstrap_activated(driver):
-        activate_bootstrap(driver)
+        activate_bootstrap(driver, pgkeys)
 
     if len(tour_steps[name]) > 1:
         try:
@@ -444,14 +450,24 @@ def play_bootstrap_tour(
 
     driver.execute_script(instructions)
     tour_on = True
+    try:
+        page_actions.wait_for_element_visible(
+            driver, ".tour-tour", by="css selector", timeout=1.2
+        )
+    except Exception:
+        pass
+    try:
+        driver.execute_script('document.activeElement.blur();')
+    except Exception:
+        pass
     while tour_on:
         try:
             time.sleep(0.01)
             if browser != "firefox":
                 result = driver.execute_script("return $tour.ended()")
             else:
                 page_actions.wait_for_element_present(
-                    driver, ".tour-tour", by="css selector", timeout=0.65
+                    driver, ".tour-tour", by="css selector", timeout=0.48
                 )
                 result = False
         except Exception:
@@ -467,7 +483,7 @@ def play_bootstrap_tour(
                     result = driver.execute_script("return $tour.ended()")
                 else:
                     page_actions.wait_for_element_present(
-                        driver, ".tour-tour", by="css selector", timeout=0.65
+                        driver, ".tour-tour", by="css selector", timeout=0.48
                     )
                     result = False
                 if result is False:
@@ -481,7 +497,13 @@ def play_bootstrap_tour(
 
 
 def play_driverjs_tour(
-    driver, tour_steps, browser, msg_dur, name=None, interval=0
+    driver,
+    tour_steps,
+    browser,
+    msg_dur,
+    name=None,
+    interval=0,
+    pgkeys=False,
 ):
     """Plays a DriverJS tour on the current website."""
     instructions = ""
@@ -500,7 +522,7 @@ def play_driverjs_tour(
             interval = 0.5
 
     if not is_driverjs_activated(driver):
-        activate_driverjs(driver)
+        activate_driverjs(driver, pgkeys)
 
     if len(tour_steps[name]) > 1:
         try:
@@ -727,7 +749,13 @@ def play_hopscotch_tour(
 
 
 def play_introjs_tour(
-    driver, tour_steps, browser, msg_dur, name=None, interval=0
+    driver,
+    tour_steps,
+    browser,
+    msg_dur,
+    name=None,
+    interval=0,
+    pgkeys=False,
 ):
     """Plays an IntroJS tour on the current website."""
     instructions = ""
@@ -759,7 +787,7 @@ def play_introjs_tour(
             interval = 0.5
 
     if not is_introjs_activated(driver):
-        activate_introjs(driver)
+        activate_introjs(driver, pgkeys)
 
     if len(tour_steps[name]) > 1:
         try:

seleniumbase/fixtures/base_case.py

@@ -11692,13 +11692,17 @@ def __add_introjs_tour_step(
         )
         self._tour_steps[name].append(step)
 
-    def play_tour(self, name=None, interval=0):
+    def play_tour(self, name=None, interval=0, pgkeys=False):
         """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."""
+                   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."""
         from seleniumbase.core import tour_helper
 
         if self.headless or self.headless2 or self.xvfb:
@@ -11720,6 +11724,7 @@ def play_tour(self, name=None, interval=0):
                 self.message_duration,
                 name=name,
                 interval=interval,
+                pgkeys=pgkeys,
             )
         elif "DriverJS" in self._tour_steps[name][0]:
             tour_helper.play_driverjs_tour(
@@ -11729,6 +11734,7 @@ def play_tour(self, name=None, interval=0):
                 self.message_duration,
                 name=name,
                 interval=interval,
+                pgkeys=pgkeys,
             )
         elif "Hopscotch" in self._tour_steps[name][0]:
             tour_helper.play_hopscotch_tour(
@@ -11747,6 +11753,7 @@ def play_tour(self, name=None, interval=0):
                 self.message_duration,
                 name=name,
                 interval=interval,
+                pgkeys=pgkeys,
             )
         else:
             tour_helper.play_shepherd_tour(
@@ -11757,9 +11764,9 @@ def play_tour(self, name=None, interval=0):
                 interval=interval,
             )
 
-    def start_tour(self, name=None, interval=0):
+    def start_tour(self, name=None, interval=0, pgkeys=False):
         """Same as self.play_tour()"""
-        self.play_tour(name=name, interval=interval)
+        self.play_tour(name=name, interval=interval, pgkeys=pgkeys)
 
     def export_tour(self, name=None, filename="my_tour.js", url=None):
         """Exports a tour as a JS file.

seleniumbase/fixtures/constants.py

@@ -241,13 +241,18 @@ class BootstrapTour:
     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"
+    )
 
 
 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:
@@ -264,6 +269,7 @@ 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: