Guides
The options listed below pertain directly to guide behavior, styling, and presentation. Many of the options affect both building block guides and classic guides, while others only affect one or the other. See an example config here.
Available Options
| Option | Description | Default | Type |
|---|---|---|---|
appAutoOrdering | Array of api key strings to set app priority for auto display guides. Eligible guides will auto display sequentially in the order of api keys set here. Takes priority over leaderKey setting and default ordering. | undefined | Array.<string> |
cacheGuides | Reduce the response size of the guide request when possible by reusing guides that have been loaded previously. | false | boolean |
cacheGuidesTimeout | How often to clear the guides cache (in milliseconds) | 600000 | Number |
disableGlobalCSS | If true, this will prevent the agent from downloading your application's global css file as well as the default classic guide css. | false | boolean |
disableGuidePseudoStyles | Building block guides use an inline style tag for various pseudo styles (e.g. hover, carets, animations). These can be turned off using this flag for application's with more restrictive CSP settings but will require custom effort to reach style parity. | false | boolean |
disablePrefetch | Content of badge and target element activated guides will be prefetched on load to improve guide display time unless set to true. | false | boolean |
enableDesignerKeyboardShortcut | If true, the agent will listen for alt+shift+8 on the keyboard and try to launch the designer (). The keyboard shortcut requires the guide launch modal of Engage to be open in another tab showing the shortcut. | false | boolean |
enableGuideTimeout | If true, after trying to display a guide step, a guideTimeout event will be sent if the step does not show within the allotted time. | false | boolean |
guideSeenTimeoutLength | How long to wait in milliseconds before sending a guideTimeout event if enabled. | 10000 | number |
guideValidation | If true, guides will be verified against their saved content hash before display to ensure validity of guide content. | false | boolean |
guides.attachPoint | By default, guides will be attached at the end of the <body>, attachPoint can be used to designate a different place to attach guides to in the DOM. This can be a CSS selector or a function. | undefined | string |
guides.delay | Guides will be loaded, but not displayed. Call pendo.startGuides() to display guides when you choose to do so (this options has been moved from delayGuides). | false | boolean |
guides.disabled | Completely disables guides (this option has been moved from disableGuides). | false | boolean |
guides.ejectOnTimeout | If 'true', guides with slow selectors will be removed from guide display processing. This will improve application performance, but slow guides will not be shown to users. | false | boolean |
guides.globalScripts | An array of functions that can be run for all or a subset of guide steps (without requiring custom code blocks to be enabled). For more information read here. | undefined | Array.<object> |
guides.timeout | How long to wait for guides to load in milliseconds (this option has been moved from guideTimeout). By default guides will not timeout. | undefined | number |
guides.tooltip.arrowSize | The tooltip arrow size (in pixels). This only affects classic guides. | 15 | number |
inlineStyleNonce | If set, the agent will attach the provided value as a nonce onto all inline stylesheets the agent adds. This is used to remove the need for "unsafe-inline" on the "style-src" of your CSP and will support live guides as well as Visual Design Studio users. | undefined | string |
leaderKey | Specify a preferred apiKey to lead the multi-apiKey iframe installations to make decisions about automatic guide display. In installations with more than 2 apiKeys, the leaderKey can be specified as a priority list (e.g. leaderKey: ['key1', 'key2', ...]). Either all frames must agree on the leaderKey setting, or only one frame should specify the leaderKey. If neither of these conditions are met, the default leader determination logic (top frame or earliest to join) will be used. | [] | Array.<string> |
preventCodeInjection | If true, custom code blocks in building block guides will not be allowed to run. Also, classic guides will not be shown at all. | false | boolean |