Skip to content
Documentation

TourOptions

Defined in: tour.ts:48

The options for the tour

Properties

Section titled “Properties”

classPrefix?

Section titled “classPrefix?”

optional classPrefix?: string

Defined in: tour.ts:66

The prefix to add to the shepherd-enabled and shepherd-target class names as well as the data-shepherd-step-id.

Only those apply. The popup keeps its own unprefixed shepherd-enabled class, and shepherd-target-click-disabled is never prefixed either, since shepherd.css keys click blocking on it and cannot know the runtime prefix.

confirmCancel?

Section titled “confirmCancel?”

optional confirmCancel?: TourConfirmCancel

Defined in: tour.ts:54

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.

confirmCancelMessage?

Section titled “confirmCancelMessage?”

optional confirmCancelMessage?: string

Defined in: tour.ts:58

The message to display in the window.confirm dialog.

defaultStepOptions?

Section titled “defaultStepOptions?”

optional defaultStepOptions?: StepOptions

Defined in: tour.ts:73

Default options for Steps (Step#constructor), created through addStep. A step’s own value replaces the default for that option, even for objects such as cancelIcon and arrays such as buttons. Only classes and positionOptions combine, positionOptions key by key.

exitOnEsc?

Section titled “exitOnEsc?”

optional exitOnEsc?: boolean

Defined in: tour.ts:78

Exiting the tour with the escape key will be enabled unless this is explicitly set to false.

id?

Section titled “id?”

optional id?: string

Defined in: tour.ts:82

Explicitly set the id for the tour. If not set, the id will be a generated uuid.

keyboardNavigation?

Section titled “keyboardNavigation?”

optional keyboardNavigation?: boolean

Defined in: tour.ts:87

Navigating the tour via left and right arrow keys will be enabled unless this is explicitly set to false.

modalContainer?

Section titled “modalContainer?”

optional modalContainer?: HTMLElement

Defined in: tour.ts:92

An optional container element for the modal. If not set, the modal will be appended to document.body.

steps?

Section titled “steps?”

optional steps?: Step[] | StepOptions[]

Defined in: tour.ts:101

An array of step options objects or Step instances to initialize the tour with.

stepsContainer?

Section titled “stepsContainer?”

optional stepsContainer?: HTMLElement

Defined in: tour.ts:97

An optional container element for the steps. If not set, the steps will be appended to document.body.

tourName?

Section titled “tourName?”

optional tourName?: string

Defined in: tour.ts:106

An optional “name” for the tour. This will be appended to the the tour’s dynamically generated id property.

useModalOverlay?

Section titled “useModalOverlay?”

optional useModalOverlay?: boolean

Defined in: tour.ts:114

Set this on the tour, not on a step. 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. The opening glides between steps for the transition-duration set on the overlay’s path, unless the user prefers reduced motion.