Skip to content

Documentation

Jump to bottom Edit New page
David Ollerhead edited this page Sep 19, 2016 · 10 revisions

API

###introJs([targetElm])

Creating an introJs object.

Available since: v0.1.0

Parameters:

  • targetElm : String (optional) Should be defined to start introduction for specific element, for example: #intro-farm.

Returns:

  • introJs object.

Example:

introJs() //without selector, start introduction for whole page
introJs("#intro-farm") //start introduction for element id='intro-farm'

###introJs.start()

Start the introduction for defined element(s).

Available since: v0.1.0

Returns:

  • introJs object.

Example:

introJs().start()

###introJs.goToStep(step)

Go to specific step of introduction.

Available since: v0.3.0

Parameters:

  • step : Number

Returns:

  • introJs object.

Example:

introJs().goToStep(2).start(); //starts introduction from step 2

###introJs.nextStep()

Go to next step of introduction.

Available since: v0.7.0

Returns:

  • introJs object.

Example:

introJs().start().nextStep();

###introJs.previousStep()

Go to previous step of introduction.

Available since: v0.7.0

Returns:

  • introJs object.

Example:

introJs().goToStep(3).start().previousStep(); //starts introduction from step 2

###introJs.exit()

Exit the introduction.

Available since: v0.3.0

Returns:

  • introJs object.

Example:

introJs().exit()

###introJs.setOption(option, value)

Set a single option to introJs object.

Available since: v0.3.0

Parameters:

  • option : String Option key name.

  • value : String/Number Value of the option.

Returns:

  • introJs object.

Example:

introJs().setOption("skipLabel", "Exit");

###introJs.setOptions(options)

Set a group of options to the introJs object.

Available since: v0.3.0

Parameters:

  • options : Object Object that contains option keys with values.

Returns:

  • introJs object.

Example:

introJs().setOptions({ 'skipLabel': 'Exit', 'tooltipPosition': 'right' });

###introJs.refresh()

To refresh and order layers manually. This function rearranges all hints as well.

Available since: v0.5.0 Last update: v2.1.0

Returns:

  • introJs object.

Example:

introJs().refresh();

###introJs.addHints()

To add available hints to the page (using data-hint or JSON)

Available since: v2.0

Returns:

  • introJs object.

Example:

introJs().addHints();

###introJs.hideHint(stepId)

Hides the hint with given stepId. The stepId is an integer and it's the value of data-step attribute on the hint element.

Available since: v2.1

Returns:

  • introJs object.

Example:

introJs().hideHint(0); //you should pass the id of the hint (the `data-step` attribute).

###introJs.hideHints()

Hides all hints on the page.

Available since: v2.2

Returns:

  • introJs object.

Example:

introJs().hideHints();

###introJs.onhintclick(providedCallback)

Invkoes given function when user clicks on one of hints.

Available since: v2.0

Parameters:

  • providedCallback : Function

Returns:

  • introJs object.

Example:

introJs().onhintclick(function() {
  alert("hint clicked");
});

###introJs.onhintsadded(providedCallback)

Invokes given callback function after adding and rendering all hints.

Available since: v2.0

Parameters:

  • providedCallback : Function

Returns:

  • introJs object.

Example:

introJs().onhintsadded(function() {
  alert("all hints were added");
});

###introJs.onhintclose(providedCallback)

Set callback for when a single hint removes from page (e.g. when user clicks on "Got it" button)

Available since: v2.0

Parameters:

  • providedCallback : Function

Returns:

  • introJs object.

Example:

introJs().onhintclose(function() {
  alert("hint closed");
});

###introJs.oncomplete(providedCallback)

Set callback for when introduction completed.

Available since: v0.2.0

Parameters:

  • providedCallback : Function

Returns:

  • introJs object.

Example:

introJs().oncomplete(function() {
  alert("end of introduction");
});

###introJs.onexit(providedCallback)

Set callback to exit of introduction. Exit also means pressing ESC key and clicking on the overlay layer by the user.

Available since: v0.2.0

Parameters:

  • providedCallback : Function

Returns:

  • introJs object.

Example:

introJs().onexit(function() {
  alert("exit of introduction");
});

###introJs.onchange(providedCallback)

Set callback to change of each step of introduction. Given callback function will be called after completing each step. The callback function receives the element of the new step as an argument.

Available since: v0.3.0

Parameters:

  • providedCallback : Function

Returns:

  • introJs object.

Example:

introJs().onchange(function(targetElement) {
  alert("new step");
});

###introJs.onbeforechange(providedCallback)

Given callback function will be called before starting a new step of introduction. The callback function receives the element of the new step as an argument.

Available since: v0.4.0

Parameters:

  • providedCallback : Function

Returns:

  • introJs object.

Example:

introJs().onbeforechange(function(targetElement) {
  alert("before new step");
});

###introJs.onafterchange(providedCallback)

Given callback function will be called after starting a new step of introduction. The callback function receives the element of the new step as an argument.

Available since: v0.7.0

Parameters:

  • providedCallback : Function

Returns:

  • introJs object.

Example:

introJs().onafterchange(function(targetElement) {
  alert("after new step");
});

###Attributes:

  • data-intro: The tooltip text of step
  • data-step: Optionally define the number (priority) of step
  • data-tooltipClass: Optionally define a CSS class for tooltip
  • data-highlightClass: Optionally append a CSS class to the helperLayer
  • data-position: Optionally define the position of tooltip, top, left, right, bottom, bottom-left-aligned (same as bottom), bottom-middle-aligned, bottom-right-aligned or auto (to detect the position of element and assign the correct position automatically). Default is bottom
  • data-hint: The tooltip text of hint
  • data-hintPosition: Optionally define the position of hint. Options: top-middle, top-left, top-right, bottom-left, bottom-right, bottom-middle. Default: top-middle

###Options:

  • steps: For defining steps using JSON configuration (see this example)
  • nextLabel: Next button label
  • prevLabel: Previous button label
  • skipLabel: Skip button label
  • doneLabel: Done button label
  • hidePrev: Hide previous button in the first step? Otherwise, it will be disabled button.
  • hideNext: Hide next button in the last step? Otherwise, it will be disabled button.
  • tooltipPosition: Default tooltip position
  • tooltipClass: Adding CSS class to all tooltips
  • highlightClass: Additional CSS class for the helperLayer
  • exitOnEsc: Exit introduction when pressing Escape button, true or false
  • exitOnOverlayClick: Exit introduction when clicking on overlay layer, true or false
  • showStepNumbers: Show steps number in the red circle or not, true or false
  • keyboardNavigation: Navigating with keyboard or not, true or false
  • showButtons: Show introduction navigation buttons or not, true or false
  • showBullets: Show introduction bullets or not, true or false
  • showProgress: Show introduction progress or not, true or false
  • scrollToElement: Auto scroll to highlighted element if it's outside of viewport, true or false
  • overlayOpacity: Adjust the overlay opacity, Number between 0 and 1
  • disableInteraction: Disable an interaction inside element or not, true or false
  • hintPosition: Hint position. Default: top-middle
  • hintButtonLabel: Hint button label. Default: 'Got it'
  • hintAnimation: To add animation to hints or not. Default: true

See setOption to see an example.

Add a custom footer
Add a custom sidebar
Clone this wiki locally