Skip to content

ShepherdBase

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

new ShepherdBase(): ShepherdBase

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

ShepherdBase

Evented.constructor

optional activeTour: Tour | null

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


bindings: Bindings

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

Evented.bindings


Step: typeof Step

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


Tour: typeof Tour

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

off(event, handler?): ShepherdBase

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

Removes an event listener for the given event string.

string

AnyHandler

ShepherdBase

Evented.off


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

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

Adds an event listener for the given event string.

string

AnyHandler

unknown

boolean = false

ShepherdBase

Evented.on


once(event, handler, ctx?): ShepherdBase

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.

string

AnyHandler

unknown

ShepherdBase

Evented.once


trigger(event, …args): ShepherdBase

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

Triggers an event listener for the given event string.

string

any[]

ShepherdBase

Evented.trigger