Tours provide users an introduction to new interfaces or new use cases they may not be familiar with. A tour will take users step by step, pointing out specific areas of the interface. Each step of a tour will include the step number, name, and description of what is being highlighted.
- When a tour is available, a button or link should be displayed for users to manually start it. Labels should be specific if there are multiple tours available.
Tours can include any number of steps, but the recommendation is to stay between 3-15 steps.
- Every step displays a Bubble with the step number, name, description of highlighted area and button bar.
- Top Bar: A light grey bar sits across the top of the Tour Bubble and includes the following items vertically aligned:
- A Step Number to denote where the user currently is along the tour.
- A Step Name to highlight the topic of the particular step.
- A Cancel or Close button, to allow the user to end the tour at any point.
- Pointer: The pointer is used to identify a specific area in the UI.
- Description: The description should include key details pertaining to the highlighted area.
- Users should always be able to go back to previous steps using the back button and move onto next steps using the next button. The first step will not have a back button.
- At the end of the tour, the Next button should turn into a “Done” button to signify the tour has ended.
Provide a way for new users to start a tour of the UI:
Click Next to move on to the next step in the tour:
Click Back or Next to continue through the tour:
- In some cases, a tour may be customizable by admin users, allowing access to overwrite step names and descriptions.
- Tours can be automatically triggered for new users to step through the UI on their initial login. Automatic tours are recommended for first time use only.
- In some cases, more than one tour may exist.
- Step numbers are dynamic. In some cases, users may not have access to view all steps or all areas of the UI, so the numbers should update accordingly for each tour instance.
Add guided tours to the Help menu in the Masthead when available.
PatternFly Core Example Not Available
There is no PatternFly-Core code available for this pattern at this time. Links to the JS framework implementations can be seen above.
Visit the Contributing to PatternFly documentation to learn how to contribute the code.