SeleniumBase Website Tours
Creating a new tour:
By default, Shepherd JS is used when creating a tour with:
You can also do:
create_shepherd_tour() methods, you can pass a default theme to change the look & feel of the tour steps. Valid themes for Shepherd Tours are
To create a tour utilizing the Bootstrap Tour Library, you can use either of the following:
To create a tour utilizing the Intro JS Library, you can use either of the following:
To create a tour utilizing the Hopscotch JS Library, you can use either of the following:
Adding a step to a tour:
To add a tour step, use the following: (Only
message is required. The other args are optional.)
self.add_tour_step(message, css_selector, title, alignment, theme)
self.add_tour_step() method, you must first pass a message to display. You can then specify a web element to attach to (by using CSS selectors). If no element is specified, the tour step will tether to the top of the screen by default. You can also add an optional title above the message to display with the tour step, as well as change the theme for that step (Shepherd tours only), and even specify the alignment (which is the side of the element that you want the tour message to tether to).
Playing a tour:
You can play a tour by calling:
If you specify an interval (optional), the tour will automatically walk through each step after that many seconds have passed.
All methods have the optional
name argument, which is only needed if you're creating multiple tours at once. Then, when you're adding a step or playing a tour, SeleniumBase knows which tour you're referring too. You can avoid using the
name arg for multiple tours if you play a tour before creating a new one.
Here's an example of using SeleniumBase Tours:
from seleniumbase import BaseCase class MyTourClass(BaseCase): def test_google_tour(self): self.open('https://google.com') self.wait_for_element('input[title="Search"]') self.create_tour(theme="dark") self.add_tour_step( "Click to begin the Google Tour!", title="SeleniumBase Tours") self.add_tour_step( "Type in your search query here.", 'input[title="Search"]') self.play_tour() self.highlight_update_text('input[title="Search"]', "Google") self.wait_for_element('[role="listbox"]') # Wait for autocomplete self.create_tour(theme="light") self.add_tour_step( "Then click here to search.", 'input[value="Google Search"]') self.add_tour_step( "Or press [ENTER] after typing a query here.", '[title="Search"]') self.play_tour()
google_tour.py, which you can run from the
This example was taken from
examples/tour_examples folder with the following command:
Exporting a Tour:
name is optional, needed only if you were creating multiple tours at once.