tool_usertours/events

Description:

  • Javascript events for the tool_usertours subsystem.

Source:
Copyright:
  • 2021 Andrew Lyons
License:
  • http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Javascript events for the tool_usertours subsystem.

Example

Example of listening to a step rendering event and cancelling it.

import {eventTypes as userTourEvents} from 'tool_usertours/events';

document.addEventListener(userTourEvents.stepRender, e => {
    console.log(e.detail.tour); // The Tour instance
    e.preventDefault();
});

Members

(static, constant) eventTypes

Description:

  • Events for the component.

Source:
Properties:
Name Type Description
eventTypes object
Properties
Name Type Description
stepRender String

See event:tool_usertours/stepRender
stepRendered String

See event:tool_usertours/stepRendered
tourStart String

See event:tool_usertours/tourStart
tourStarted String

See event:tool_usertours/tourStarted
tourEnd String

See event:tool_usertours/tourEnd
tourEnded String

See event:tool_usertours/tourEnded
stepHide String

See event:tool_usertours/stepHide
stepHidden String

See event:tool_usertours/stepHidden

Events for the component.

Events

tool_usertours/stepHidden

Description:

  • An event triggered after a step has been hidden.

Source:
Properties:
Name Type Description
detail object
Properties
Name Type Description
tour tool_usertours/tour
Type:
  • CustomEvent

tool_usertours/stepHide

Description:

  • An event triggered before a step is hidden.

    This event is cancellable.

Source:
Properties:
Name Type Description
detail object
Properties
Name Type Description
tour tool_usertours/tour
Type:
  • CustomEvent

tool_usertours/stepRender

Description:

  • An event triggered before a user tour step is rendered.

    This event is cancellable.

Source:
Properties:
Name Type Description
detail object
Properties
Name Type Description
tour tool_usertours/tour
stepConfig object
Type:
  • CustomEvent

tool_usertours/stepRendered

Description:

  • An event triggered after a user tour step has been rendered.

Source:
Properties:
Name Type Description
detail object
Properties
Name Type Description
tour tool_usertours/tour
stepConfig object
Type:
  • CustomEvent
Listeners of This Event:

tool_usertours/tourEnd

Description:

  • An event triggered before a tour ends.

    This event is cancellable.

Source:
Properties:
Name Type Description
detail object
Properties
Name Type Description
tour tool_usertours/tour
Type:
  • CustomEvent

tool_usertours/tourEnded

Description:

  • An event triggered after a tour has ended.

Source:
Properties:
Name Type Description
detail object
Properties
Name Type Description
tour tool_usertours/tour
Type:
  • CustomEvent

tool_usertours/tourStart

Description:

  • An event triggered before a user tour starts.

    This event is cancellable.

Source:
Properties:
Name Type Description
detail object
Properties
Name Type Description
tour tool_usertours/tour
startAt Number
Type:
  • CustomEvent

tool_usertours/tourStarted

Description:

  • An event triggered after a user tour has started.

Source:
Properties:
Name Type Description
detail object
Properties
Name Type Description
tour tool_usertours/tour
Type:
  • CustomEvent