Better introductions for websites and features with a step-by-step guide for your projects
Better introductions for websites and features with a step-by-step guide for your projects.
You can obtain your local copy of Intro.js from:
1) This github repository, using git clone https://github.com/usablica/intro.js.git
2) Using bower bower install intro.js --save
3) Using npm npm install intro.js --save
4) Download it from CDN (1, 2)
Intro.js can be added to your site in three simple steps:
1) Include intro.js and introjs.css (or the minified version for production) in your page. Use introjs-rtl.min.css for Right-to-Left language support.
CDN hosted files are available at jsDelivr (click Show More) & cdnjs.
2) Add data-intro and data-step to your HTML elements.
For example:
<a href='http://google.com/' data-intro='Hello step one!'></a>
See all attributes here.
3) Call this JavaScript function:
introJs().start();
Optionally, pass one parameter to introJs function to limit the presentation section.
For example introJs(".introduction-farm").start(); runs the introduction only for elements with class='introduction-farm'.
IntroJS provides awesome templates and we are trying to update and add more templates for next versions. You can browse all templates here: https://github.com/usablica/intro.js/wiki/IntroJs-templates
In order to use templates, all you need to do is appending the template stylesheet to your page, after IntroJS CSS file:
<!-- Add IntroJs styles -->
<link href="../../introjs.css" rel="stylesheet">
<!-- Add Nazanin template -->
<link href="../../themes/introjs-nazanin.css" rel="stylesheet">
###introJs([targetElm])
Creating an introJs object.
Available since: v0.1.0
Parameters:
#intro-farm.Returns:
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:
Example:
introJs().start()
###introJs.goToStep(step)
Go to specific step of introduction.
Available since: v0.3.0
Parameters:
Returns:
Example:
introJs().goToStep(2).start(); //starts introduction from step 2
###introJs.nextStep()
Go to next step of introduction.
Available since: v0.7.0
Returns:
Example:
introJs().start().nextStep();
###introJs.previousStep()
Go to previous step of introduction.
Available since: v0.7.0
Returns:
Example:
introJs().goToStep(3).start().previousStep(); //starts introduction from step 2
###introJs.exit()
Exit the introduction.
Available since: v0.3.0
Returns:
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:
Example:
introJs().setOption("skipLabel", "Exit");
###introJs.setOptions(options)
Set a group of options to the introJs object.
Available since: v0.3.0
Parameters:
Returns:
Example:
introJs().setOptions({ 'skipLabel': 'Exit', 'tooltipPosition': 'right' });
###introJs.refresh()
To refresh and order layers manually
Available since: v0.5.0
Returns:
Example:
introJs().refresh();
###introJs.oncomplete(providedCallback)
Set callback for when introduction completed.
Available since: v0.2.0
Parameters:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
Example:
introJs().onafterchange(function(targetElement) {
alert("after new step");
});
###Attributes:
data-intro: The tooltip text of stepdata-step: Optionally define the number (priority) of stepdata-tooltipClass: Optionally define a CSS class for tooltipdata-highlightClass: Optionally append a CSS class to the helperLayerdata-position: Optionally define the position of tooltip, top, left, right, bottom, bottom-left-aligned (same as 'bottom'), 'bottom-middle-aligned' and 'bottom-right-aligned'. Default is bottom###Options:
steps: For defining steps using JSON configuration (see this example)nextLabel: Next button labelprevLabel: Previous button labelskipLabel: Skip button labeldoneLabel: Done button labeltooltipPosition: Default tooltip positiontooltipClass: Adding CSS class to all tooltipshighlightClass: Additional CSS class for the helperLayerexitOnEsc: Exit introduction when pressing Escape button, true or falseexitOnOverlayClick: Exit introduction when clicking on overlay layer, true or falseshowStepNumbers: Show steps number in the red circle or not, true or falsekeyboardNavigation: Navigating with keyboard or not, true or falseshowButtons: Show introduction navigation buttons or not, true or falseshowBullets: Show introduction bullets or not, true or falseshowProgress: Show introduction progress or not, true or falsescrollToElement: Auto scroll to highlighted element if it's outside of viewport, true or falseoverlayOpacity: Adjust the overlay opacity, NumberdisableInteraction: Disable an interaction inside element or not, true or falseSee setOption to see an example.
If you are using the rails asset pipeline you can use the introjs-rails gem.
You can simply use this project for Yii framework: https://github.com/moein7tl/Yii-IntroJS
Here you can find an IntroJs integration for Drupal: https://drupal.org/sandbox/alexanderfb/2061829
For AngularJS, you can use the directives in angular-intro.js.
You can use IntroJS inside your Wordpress, here is a good article by SitePoint: http://www.sitepoint.com/creating-intro-js-powered-tours-wordpress/
Here is a under construction plugin for Wordpress: https://github.com/newoldmedia/intro.js-wordpress
First you should install nodejs and npm, then first run this command: npm install to install all dependencies.
Now you can run this command to minify all static resources:
make build
Want to learn faster and easier? Here we have Instant IntroJs, Packt Publishing.
v1.1.1 - 2015-09-05
v1.1.0 - 2015-09-01
onexit on pressing Esc or clicking on the overlay layerv1.0.0 - 2014-10-17
z-index issuev0.9.0 - 2014-05-23
tr element's issuev0.8.0 - 2014-03-25
_direction propertyv0.7.1 - 2014-03-11
v0.7.0 - 2014-02-07
onafterchange eventnextStep and previousStep functions publicly_cloneObject method to prevent data overwritingv0.6.0 - 2013-11-13
data-step optional with elementsv0.5.0 - 2013-07-19
refresh() method to refresh and order layers manuallyonbeforechange event bug and pass correct object in parametersNull element exception in some browsersv0.4.0 - 2013-05-20
onbeforechange callbackshowStepNumbers option to show/hide step numbersexitOnEsc and exitOnOverlayClick options!important in element css propertiesonexit behaviorv0.3.0 - 2013-03-28
goToStep function to go to specific step of introduction.onchange callback.exit function to exit from introduction.setOption and setOptions functions.min-width bug with tooltip box.v0.2.1 - 2013-03-20
v0.2.0 - 2013-03-20
data-position attributeonexit and oncomplete callbackabsolute or relativeenter key for navigating in stepsv0.1.0 - 2013-03-16
Afshin Mehrabani
Copyright (C) 2012 Afshin Mehrabani (afshin.meh@gmail.com)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
User Onboarding and Product Walkthrough Library
The npm package intro.js receives a total of 129,884 weekly downloads. As such, intro.js popularity was classified as popular.
We found that intro.js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
A flawed sandbox in @nestjs/devtools-integration lets attackers run code on your machine via CSRF, leading to full Remote Code Execution (RCE).
Product
Customize license detection with Socket’s new license overlays: gain control, reduce noise, and handle edge cases with precision.
Product
Socket now supports Rust and Cargo, offering package search for all users and experimental SBOM generation for enterprise projects.