Tour

tool_usertours/tour~ Tour

new Tour(config)

Source:
Parameters:
Name Type Description
config object

The configuration object.

Methods

dispatchEvent(eventName, detailopt, cancelableopt) → {CustomEvent}

Description:
  • Fire any event handlers for the specified event.

Source:
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}

Description:
  • Get potentially visible steps in a tour.

Source:
Returns:

A list of ordered steps

Type
StepList

isCSSAllowed() → {boolean}

Description:
  • Is the browser actually allow CSS styles?

Source:
Returns:

True if the browser is allowing CSS styles

Type
boolean

requireDefaultTourZindex(elem) → {Boolean}

Description:
  • 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.

Source:
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