new Tour(config)
Parameters:
| Name | Type | Description |
|---|---|---|
config |
object | The configuration object. |
Methods
dispatchEvent(eventName, detailopt, cancelableopt) → {CustomEvent}
Fire any event handlers for the specified event.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
eventName |
String | The name of the event |
||
detail |
Object |
<optional> |
{}
|
Any additional details to pass into the eveent |
cancelable |
Boolean |
<optional> |
false
|
Whether preventDefault() can be called |
Returns:
- Type
- CustomEvent
getPotentiallyVisibleSteps() → {StepList}
Get potentially visible steps in a tour.
Returns:
A list of ordered steps
- Type
- StepList
isCSSAllowed() → {boolean}
Is the browser actually allow CSS styles?
Returns:
True if the browser is allowing CSS styles
- Type
- boolean
requireDefaultTourZindex(elem) → {Boolean}
Check if the element require the default tour z-index.
Some page elements have fixed z-index. However, their weight is not enough to cover other page elements like the top navbar or a sticky footer so they use the default tour z-index instead.
Parameters:
| Name | Type | Description |
|---|---|---|
elem |
jQuery | the page element to highlight |
Returns:
true if the element requires the default tour z-index instead of the calculated one
- Type
- Boolean