Skip to content

ShepherdBase

Extends

Constructors

new ShepherdBase()

new ShepherdBase(): ShepherdBase

Returns

ShepherdBase

Overrides

Evented.constructor

Source

tour.ts:95

Properties

Step

Step: typeof Step

Source

tour.ts:92


Tour

Tour: typeof Tour

Source

tour.ts:93


activeTour?

optional activeTour: null | Tour

Source

tour.ts:91


bindings

bindings: Bindings

Inherited from

Evented.bindings

Source

evented.ts:11

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

Source

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

Source

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

Source

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

Source

evented.ts:78