Pendo updated their Guide experience to the Visual Design Studio as of February 18th, 2019. This article is to help users understand the Visual Design Studio’s nomenclature.
To start your Guide creation process, select Guides in the left-hand navigation menu.
Themes & Layouts
Themes and Layouts can help you manage your Guide branding by giving Pendo Administrators the ability to set up certain themes and layouts Guide creators can use.
Themes are used to style your default Themes for your Guide containers, typography, and buttons. To edit your default themes, choose the dropdown option in the upper right-hand corner of the Guides section and select "Edit Default Theme." You will then be promoted to open the Designer, where you will see options to edit your default theme:
Layouts are Guide templates that you can save to reuse the same structure in a Guide step as needed. Once you save a Guide layout, you will see it in your options. Here is an example of what options you might see:
Learn more in the Layouts article
When you first open the Visual Design Studio, the Guide Designer launches on top of your application. It includes multiple tools, as well as a Guide preview. The Designer is accessible to any Pendo user, with the exception of those who are "Read Only."
The Action Bar appears at the top of the Guide Designer. It contains the following:
- Title of your guide (1)
- View Steps (2) - Step Tray Access
- Save Layout (3) - Save Guide as new layout or update an existing layout
- Activation (4) - Change Guide activation
- Navigation mode (5) - Navigate to another page or open a modal
- Preview (6) - Preview your Guide
- Exit (7) - Exit designer
- Save current work (8) - Save and exit Designer
- Any applicable alerts (9) - Errors will be yellow when present
- Move (10) - Move the navigation bar to top/ bottom of the designer, if you have elements in your application behind the Action Bar at the top of your page
- Guide Step Preview (11)
The Step Tray can be accessed by clicking on the arrow at the center of the Action Bar. In the Step Tray, you will see options to customize your activation method and add additional steps to your Guide.
Activation refers to how your Guide appears to users. You can access your Guide’s Activation options from the button on the Action Bar, or by opening the Step Tray and clicking on the Activation box on the left-hand side:
There are three Activation options to choose from:
- Automatic: Guide appears once automatically until dismissed or advanced.
- Badge: Guide appears after a visitor clicks or hovers over a badge icon.
- Target Element: Guide appears after a visitor clicks on a targeted element.
In addition, a Guide can simultaneously utilize different activation methods to achieve a desired behavior. For instance, you can set a Guide to appear both automatically and with a badge.
Learn more in the Guide Activation Options article.
The Guide Container refers to the blue border that appears when you hover over the edge of a Guide. Click on this to open the Edit Container menu, where you can change the style, location, and behavior of your Guide.
Edit Container menu
The Edit Container menu contains multiple options for styling your Guide, editing its location, and controlling its behavior. The following is a breakdown of each element in this menu, which you can make any required changes to:
Note: If you are editing your guide using a Theme, you will have to change the Theme to "Custom" to see these options.
- Step Name
- Background color
- Dimensions (Guide Width in px)
- Padding (px)
- Border - Color, Width (px) & Radius (for rounded corners)
- Drop Shadow - Color and size (shadow around guide container)
- Caret - (if applicable) Width (px) & Height (px) (pointer on tooltips)
- Close Button (allows users to X out of a guide)
- Backdrop - Color and Opacity (if using a tooltip guide, be sure to check "Show target element above backdrop")
- Z-index (only edit this if your guide is being hidden by something such as a modal with a higher z-index. Higher z-index means it will be the most "in-front" element.)
- Position on Page
- Element Location (if applicable)
- Page Location - Sitewide or Only on this page
- Settings - Filter Dynamic Elements on Target - Toggle on this setting to filter out any dynamic elements on a feature element. For example, in some elements, there are user-specific strings, which constantly change as each user navigates through the app. Filtering out these strings ensures better performance when tagging a feature, or element, and gives a more accurate tag. It also ensures there is no duplication of data.
- Anchor to Element:
- Suggested Match. This is the automatic rule created by Pendo. Sometimes, this doesn’t ideally capture what you need it to, isn’t a unique match on the page, also exists on other pages, or isn’t static, which is why we’ve created the following additional options for creating rules.
- Parent Element. This is useful when the red bounding box used to highlight and select an area in your application doesn’t cover the entire clickable area. This option selects the next largest container (the entire button) for the originally selected element (text within the button).
- Custom CSS. If you’re comfortable with using Inspect in Google Chrome to investigate the HTML and CSS of your application, this option allows you to add a custom rule based on the elements and attributes available in the area you selected.
- Close Button
- Add Action
A Guide is comprised of Building Blocks. Each Building Block will offer you an option to add:
- Horizontal Line
- Multi Button
- YouTube Video
- Open Text Poll
- Yes/No Poll
- Number Scale Poll
- Multi Choice Poll
- Custom Code Block
You can access the Building Blocks menu by placing your cursor inside a Guide and clicking on the blue horizontal line that appears. It will look like this:
Learn more in the Building Blocks article.
Frequently asked questions
What Pendo user permissions will I need to use the Visual Design Studio?
To use the Visual Design Studio, Pendo users will need either one of these permissions:
- Pendo Administrator Permissions
- Pendo User Permissions
- Manage Published Guides
- Create Guides & Templates from Scratch
- Create Guides from templates
Take a look at the User Roles (Matrix View) to learn more about what each specific permission will allow you to do in Pendo.
Now that you’re accommodated with the new Terminology, take a look at how to create a Guide in Visual Design Studio: