Skip to content

ShepherdBase

Defined in: tour.ts:121

The type of the package’s default export. It re-fires each tour’s active, cancel, complete, inactive, show and start events.

new ShepherdBase(): ShepherdBase

ShepherdBase

Evented.constructor

optional activeTour?: Tour | null

Defined in: tour.ts:126

The running tour. It is null or undefined until a tour starts, so read it when a button is clicked, not when defining the button.


bindings: Bindings

Defined in: evented.ts:23

The handlers registered through on and once.

Evented.bindings


Step: typeof Step

Defined in: tour.ts:130

The Step class.


Tour: typeof Tour

Defined in: tour.ts:134

The Tour class.

off(event, handler?): ShepherdBase

Defined in: evented.ts:64

Removes an event listener for the given event string.

string

AnyHandler

ShepherdBase

Evented.off


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

Defined in: evented.ts:34

Adds an event listener for the given event string.

string

AnyHandler

unknown

boolean = false

ShepherdBase

Evented.on


once(event, handler, ctx?): ShepherdBase

Defined in: evented.ts:53

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

string

AnyHandler

unknown

ShepherdBase

Evented.once


trigger(event, …args): ShepherdBase

Defined in: evented.ts:87

Triggers an event listener for the given event string.

string

…any[]

ShepherdBase

Evented.trigger