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.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ShepherdBase():
ShepherdBase
Returns
Section titled “Returns”ShepherdBase
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”activeTour?
Section titled “activeTour?”
optionalactiveTour?: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
Section titled “bindings”bindings:
Bindings
Defined in: evented.ts:23
The handlers registered through on and once.
Inherited from
Section titled “Inherited from”Step: typeof
Step
Defined in: tour.ts:130
The Step class.
Tour: typeof
Tour
Defined in: tour.ts:134
The Tour class.
Methods
Section titled “Methods”off(
event,handler?):ShepherdBase
Defined in: evented.ts:64
Removes an event listener for the given event string.
Parameters
Section titled “Parameters”string
handler?
Section titled “handler?”Returns
Section titled “Returns”ShepherdBase
Inherited from
Section titled “Inherited from”on(
event,handler,ctx?,once?):ShepherdBase
Defined in: evented.ts:34
Adds an event listener for the given event string.
Parameters
Section titled “Parameters”string
handler
Section titled “handler”unknown
boolean = false
Returns
Section titled “Returns”ShepherdBase
Inherited from
Section titled “Inherited from”once()
Section titled “once()”once(
event,handler,ctx?):ShepherdBase
Defined in: evented.ts:53
Adds an event listener that only fires once for the given event string.
Parameters
Section titled “Parameters”string
handler
Section titled “handler”unknown
Returns
Section titled “Returns”ShepherdBase
Inherited from
Section titled “Inherited from”trigger()
Section titled “trigger()”trigger(
event, …args):ShepherdBase
Defined in: evented.ts:87
Triggers an event listener for the given event string.
Parameters
Section titled “Parameters”string
…any[]
Returns
Section titled “Returns”ShepherdBase