Javascript events for the tool_usertours
subsystem.
- Source:
- Copyright:
- 2021 Andrew Lyons
- 2021 Andrew Lyons
- License:
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Example
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
Properties:
Name | Type | Description | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
eventTypes |
object |
Properties
|
Events for the component.
Events
tool_usertours/stepHidden
Properties:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
detail |
object |
Properties
|
An event triggered after a step has been hidden.
Type:
- CustomEvent
tool_usertours/stepHide
Properties:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
detail |
object |
Properties
|
An event triggered before a step is hidden.
This event is cancellable.
Type:
- CustomEvent
tool_usertours/stepRender
Properties:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
detail |
object |
Properties
|
An event triggered before a user tour step is rendered.
This event is cancellable.
Type:
- CustomEvent
tool_usertours/stepRendered
Properties:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
detail |
object |
Properties
|
An event triggered after a user tour step has been rendered.
Type:
- CustomEvent
Listeners of This Event:
tool_usertours/tourEnd
Properties:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
detail |
object |
Properties
|
An event triggered before a tour ends.
This event is cancellable.
Type:
- CustomEvent
tool_usertours/tourEnded
Properties:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
detail |
object |
Properties
|
An event triggered after a tour has ended.
Type:
- CustomEvent
tool_usertours/tourStart
Properties:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
detail |
object |
Properties
|
An event triggered before a user tour starts.
This event is cancellable.
Type:
- CustomEvent
tool_usertours/tourStarted
Properties:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
detail |
object |
Properties
|
An event triggered after a user tour has started.
Type:
- CustomEvent