ShepherdBase

Extends

• Evented

Constructors

new ShepherdBase()

new ShepherdBase(): ShepherdBase

Returns

ShepherdBase

Overrides

Evented.constructor

Defined in

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

Properties

activeTour?

optional activeTour: null | Tour

Defined in

docs-src/node_modules/shepherd.js/src/tour.ts:91

---

bindings

bindings: Bindings

Inherited from

Evented.bindings

Defined in

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

---

Step

Step: typeof Step

Defined in

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

---

Tour

Tour: typeof Tour

Defined in

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

Methods

off()

off(event, handler?): ShepherdBase

Removes an event listener for the given event string.

Parameters

• event: string

• handler?: AnyHandler

Returns

ShepherdBase

Inherited from

Evented.off

Defined in

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

---

on()

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

Adds an event listener for the given event string.

Parameters

• event: string

• handler: AnyHandler

• ctx?: unknown

• once?: boolean = false

Returns

ShepherdBase

Inherited from

Evented.on

Defined in

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

---

once()

once(event, handler, ctx?): ShepherdBase

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

Parameters

• event: string

• handler: AnyHandler

• ctx?: unknown

Returns

ShepherdBase

Inherited from

Evented.once

Defined in

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

---

trigger()

trigger(event, …args): ShepherdBase

Triggers an event listener for the given event string.

Parameters

• event: string

• …args: any[]

Returns

ShepherdBase

Inherited from

Evented.trigger

Defined in

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