TourOptions

Defined in: docs-src/node_modules/shepherd.js/src/tour.ts:32

The options for the tour

Properties

classPrefix?

optional classPrefix: string

Defined in: docs-src/node_modules/shepherd.js/src/tour.ts:46

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

confirmCancel?

optional confirmCancel: TourConfirmCancel

Defined in: docs-src/node_modules/shepherd.js/src/tour.ts:38

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?

optional confirmCancelMessage: string

Defined in: docs-src/node_modules/shepherd.js/src/tour.ts:42

The message to display in the window.confirm dialog.

defaultStepOptions?

optional defaultStepOptions: StepOptions

Defined in: docs-src/node_modules/shepherd.js/src/tour.ts:50

Default options for Steps (Step#constructor), created through addStep.

exitOnEsc?

optional exitOnEsc: boolean

Defined in: docs-src/node_modules/shepherd.js/src/tour.ts:55

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

id?

optional id: string

Defined in: docs-src/node_modules/shepherd.js/src/tour.ts:59

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

keyboardNavigation?

optional keyboardNavigation: boolean

Defined in: docs-src/node_modules/shepherd.js/src/tour.ts:64

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

modalContainer?

optional modalContainer: HTMLElement

Defined in: docs-src/node_modules/shepherd.js/src/tour.ts:69

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

steps?

optional steps: StepOptions[] | Step[]

Defined in: docs-src/node_modules/shepherd.js/src/tour.ts:78

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

stepsContainer?

optional stepsContainer: HTMLElement

Defined in: docs-src/node_modules/shepherd.js/src/tour.ts:74

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

tourName?

optional tourName: string

Defined in: docs-src/node_modules/shepherd.js/src/tour.ts:83

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

useModalOverlay?

optional useModalOverlay: boolean

Defined in: docs-src/node_modules/shepherd.js/src/tour.ts:89

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