Tour

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

Class representing the site tour

Extends

• Evented

Constructors

Constructor

new Tour(options?): Tour

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

Parameters

options?

TourOptions = {}

Returns

Tour

Overrides

Evented.constructor

Properties

bindings

bindings: Bindings

Defined in: docs-src/node_modules/shepherd.js/src/evented.ts:11

Inherited from

Evented.bindings

---

classPrefix

classPrefix: string

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

---

currentStep?

optional currentStep?: Step | null

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

---

focusedElBeforeOpen?

optional focusedElBeforeOpen?: HTMLElement | null

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

---

id?

optional id?: string

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

---

modal?

optional modal?: ShepherdModalAPI | null

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

---

options

options: TourOptions

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

---

steps

steps: Step[]

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

---

trackedEvents

trackedEvents: string[]

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

Methods

_setupActiveTour()

_setupActiveTour(): void

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

Make this tour “active”

Returns

void

---

addStep()

addStep(options, index?): Step | StepOptions

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

Adds a new step to the tour

Parameters

options

Step | StepOptions

An object containing step options or a Step instance

index?

number

The optional index to insert the step at. If undefined, the step is added to the end of the array.

Returns

Step | StepOptions

The newly added step

---

addSteps()

addSteps(steps?): Tour

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

Add multiple steps to the tour

Parameters

steps?

Step[] | StepOptions[]

The steps to add to the tour

Returns

Tour

---

back()

back(): void | Promise<void>

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

Go to the previous step in the tour

Returns

void | Promise<void>

---

cancel()

cancel(): Promise<void>

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

Calls _done() triggering the ‘cancel’ event If confirmCancel is true, will show a window.confirm before cancelling If confirmCancel is a function, will call it and wait for the return value, and only cancel when the value returned is true

Returns

Promise<void>

---

complete()

complete(): void

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

Calls _done() triggering the complete event

Returns

void

---

getById()

getById(id): Step | undefined

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

Gets the step from a given id

Parameters

id

string | number

The id of the step to retrieve

Returns

Step | undefined

The step corresponding to the id

---

getCurrentStep()

getCurrentStep(): Step | null | undefined

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

Gets the current step

Returns

Step | null | undefined

---

hide()

hide(): void

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

Hide the current step

Returns

void

---

isActive()

isActive(): boolean

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

Check if the tour is active

Returns

boolean

---

next()

next(): void | Promise<void>

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

Go to the next step in the tour If we are at the end, call complete

Returns

void | Promise<void>

---

off()

off(event, handler?): Tour

Defined in: docs-src/node_modules/shepherd.js/src/evented.ts:53

Removes an event listener for the given event string.

Parameters

event

string

handler?

AnyHandler

Returns

Tour

Inherited from

Evented.off

---

on()

on(event, handler, ctx?, once?): Tour

Defined in: docs-src/node_modules/shepherd.js/src/evented.ts:22

Adds an event listener for the given event string.

Parameters

event

string

handler

AnyHandler

ctx?

unknown

once?

boolean = false

Returns

Tour

Inherited from

Evented.on

---

once()

once(event, handler, ctx?): Tour

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

Adds an event listener that only fires once for the given event string.

Parameters

event

string

handler

AnyHandler

ctx?

unknown

Returns

Tour

Inherited from

Evented.once

---

removeStep()

removeStep(name): void

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

Removes the step from the tour

Parameters

name

string

The id for the step to remove

Returns

void

---

setupModal()

setupModal(): void

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

setupModal create the modal container and instance

Returns

void

---

show()

show(key?, forward?): void | Promise<void>

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

Show a specific step in the tour

Parameters

key?

string | number

The key to look up the step by

forward?

boolean = true

True if we are going forward, false if backward

Returns

void | Promise<void>

A promise when the step’s waitForElement option makes showing asynchronous, otherwise undefined

---

start()

start(): Promise<void>

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

Start the tour

Returns

Promise<void>

---

trigger()

trigger(event, …args): Tour

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

Triggers an event listener for the given event string.

Parameters

event

string

args

…any[]

Returns

Tour

Inherited from

Evented.trigger