TourOptions
The options for the tour
Properties
classPrefix?
optional
classPrefix:string
The prefix to add to the shepherd-enabled
and shepherd-target
class names as well as the data-shepherd-step-id
.
Defined in
tour.ts:44
confirmCancel?
optional
confirmCancel:TourConfirmCancel
If true, will issue a window.confirm
before cancelling.
If it is a function(support Async Function), it will be called and wait for the return value,
and will only be cancelled if the value returned is true.
Defined in
tour.ts:36
confirmCancelMessage?
optional
confirmCancelMessage:string
The message to display in the window.confirm
dialog.
Defined in
tour.ts:40
defaultStepOptions?
optional
defaultStepOptions:StepOptions
Default options for Steps (Step#constructor), created through addStep
.
Defined in
tour.ts:48
exitOnEsc?
optional
exitOnEsc:boolean
Exiting the tour with the escape key will be enabled unless this is explicitly set to false.
Defined in
tour.ts:53
id?
optional
id:string
Explicitly set the id for the tour. If not set, the id will be a generated uuid.
Defined in
tour.ts:57
keyboardNavigation?
optional
keyboardNavigation:boolean
Navigating the tour via left and right arrow keys will be enabled unless this is explicitly set to false.
Defined in
tour.ts:62
modalContainer?
optional
modalContainer:HTMLElement
An optional container element for the modal.
If not set, the modal will be appended to document.body
.
Defined in
tour.ts:67
steps?
optional
steps:StepOptions
[] |Step
[]
An array of step options objects or Step instances to initialize the tour with.
Defined in
tour.ts:76
stepsContainer?
optional
stepsContainer:HTMLElement
An optional container element for the steps.
If not set, the steps will be appended to document.body
.
Defined in
tour.ts:72
tourName?
optional
tourName:string
An optional “name” for the tour. This will be appended to the the tour’s
dynamically generated id
property.
Defined in
tour.ts:81
useModalOverlay?
optional
useModalOverlay:boolean
Whether or not steps should be placed above a darkened modal overlay. If true, the overlay will create an opening around the target element so that it can remain interactive
Defined in
tour.ts:87