Name: intro.js
Owner: Sandstorm.io
Description: A better way for new feature introduction and step-by-step users guide for your website and project.
Created: 2016-04-06 22:58:36.0
Updated: 2016-04-06 22:58:37.0
Pushed: 2016-04-06 23:03:35.0
Homepage: http://introjs.com
Size: 2304
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
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. To add hints you should use data-hint attribute.
For example:
ref='http://google.com/' data-intro='Hello step one!'></a>
See all attributes here.
3) Call this JavaScript function:
oJs().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 -->
k href="../../introjs.css" rel="stylesheet">
Add Nazanin template -->
k href="../../themes/introjs-nazanin.css" rel="stylesheet">
Creating an introJs object.
Available since: v0.1.0
Parameters:
#intro-farm.Returns:
Example:
oJs() //without selector, start introduction for whole page
oJs("#intro-farm") //start introduction for element id='intro-farm'
Start the introduction for defined element(s).
Available since: v0.1.0
Returns:
Example:
oJs().start()
Go to specific step of introduction.
Available since: v0.3.0
Parameters:
Returns:
Example:
oJs().goToStep(2).start(); //starts introduction from step 2
Go to next step of introduction.
Available since: v0.7.0
Returns:
Example:
oJs().start().nextStep();
Go to previous step of introduction.
Available since: v0.7.0
Returns:
Example:
oJs().goToStep(3).start().previousStep(); //starts introduction from step 2
Exit the introduction.
Available since: v0.3.0
Returns:
Example:
oJs().exit()
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:
oJs().setOption("skipLabel", "Exit");
Set a group of options to the introJs object.
Available since: v0.3.0
Parameters:
Returns:
Example:
oJs().setOptions({ 'skipLabel': 'Exit', 'tooltipPosition': 'right' });
To refresh and order layers manually
Available since: v0.5.0
Returns:
Example:
oJs().refresh();
To add available hints to the page (using data-hint or JSON)
Available since: v2.0
Returns:
Example:
oJs().addHints();
Invkoes given function when user clicks on one of hints.
Available since: v2.0
Parameters:
Returns:
Example:
oJs().onhintclick(function() {
ert("hint clicked");
Invokes given callback function after adding and rendering all hints.
Available since: v2.0
Parameters:
Returns:
Example:
oJs().onhintsadded(function() {
ert("all hints were added");
Set callback for when a single hint removes from page (e.g. when user clicks on “Got it” button)
Available since: v2.0
Parameters:
Returns:
Example:
oJs().onhintclose(function() {
ert("hint closed");
Set callback for when introduction completed.
Available since: v0.2.0
Parameters:
Returns:
Example:
oJs().oncomplete(function() {
ert("end of introduction");
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:
oJs().onexit(function() {
ert("exit of introduction");
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:
oJs().onchange(function(targetElement) {
ert("new step");
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:
oJs().onbeforechange(function(targetElement) {
ert("before new step");
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:
oJs().onafterchange(function(targetElement) {
ert("after new step");
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 bottomdata-hint: The tooltip text of hintdata-hintPosition: Optionally define the position of hint. Options: top-middle, top-left, top-right, bottom-left, bottom-right, bottom-middle. Default: top-middlesteps: 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 falsehintPosition: Hint position. Default: top-middlehintButtonLabel: Hint button label. Default: 'Got it'See 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
GWT wrapper on top of Intro.js
Github: https://github.com/Agnie-Software/gwt-introjs
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.
Afshin Mehrabani
If you want to use Intro.js for a commercial application, theme or plugin the commercial license is the appropriate license. With this option, your source code is kept proprietary. Purchase a commercial license at introjs.com
Copyright © 2012-2016 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.