tool_usertours/usertours

Description:
  • User tour control library.

Source:

User tour control library.

Methods

Description:
  • Add a reset link to the page.

Source:

(inner) fetchTour(tourId)

Description:
  • Fetch the configuration specified tour, and start the tour when it has been fetched.

Source:
Parameters:
Name Type Description
tourId Number

The ID of the tour to start.

(inner) findMatchingTour(tourDetails, filters) → {null|object}

Description:
  • Find the first matching tour.

Source:
Parameters:
Name Type Description
tourDetails Array.<object>
filters Array.<object>
Returns:
Type
null | object

(inner) init(tourDetails, filters)

Description:
  • Initialise the user tour for the current page.

Source:
Parameters:
Name Type Description
tourDetails Array

The matching tours for this page.

filters Array

The names of all client side filters.

(inner) markStepShown(e)

Description:
  • Mark the specified step as being shownd by the user.

Source:
Parameters:
Name Type Description
e Event

(inner) markTourComplete(e)

Description:
  • Mark the specified tour as being completed by the user.

Source:
Parameters:
Name Type Description
e Event
Listens to Events:

(inner) resetTourState(tourId) → {Promise}

Description:
  • Reset the state, and restart the the tour on the current page.

Source:
Parameters:
Name Type Description
tourId Number

The ID of the tour to start.

Returns:
Type
Promise

(inner) startBootstrapTour(tourId, template, tourConfig) → {Object}

Description:
  • Start the specified tour.

Source:
Parameters:
Name Type Description
tourId Number

The ID of the tour to start.

template String

The template to use.

tourConfig Object

The tour configuration.

Returns:
Type
Object