guides
v1.2.9
Published
Simple way to highlighting DOM elements and guide your users with step-by-step welcome tours in your web app.
Downloads
165
Maintainers
ejulianovaReadme
guides.js
Guides.js is a lightweight javascript library for making guided website tours. It finds the element you want to highlight, creates a guide element using the html you specified in the configuration options and connects the guide and the highlighted element with an svg arrow.
#Demo
http://ejulianova.github.io/guides/
#Getting started
Once you have downloaded the source, simply include guides.css in the head of your page:
<head>
...
<link rel="stylesheet" type="text/css" href="guides.css" >
</head>and guides.js in your page scripts section. Make sure you include it after jquery:
...
<script type="text/javascript" src="jquery.js" >
<script type="text/javascript" src="guides.js" >
</body>Note that you can import guides.scss and compile it togerther with your website styles if you are using sass.
#Docs
##Dependencies
Guides.js depends on jquery, so you need to make sure you include jquery first.
##Initialization
Guides.js is a jquery plugin so it can be initialized on an element, that will "trigger" the guided tour:
$('#demo').guides({
guides: [{
element: $('.navbar-brand'),
html: 'Welcome to Guides.js'
}, {
element: $('.navbar'),
html: 'Navigate through guides.js website'
}, {
element: $('#demo'),
html: 'See how it works'
}, {
element: $('#download'),
html: 'Download guides.js'
}, {
element: $('#getting-started'),
html: 'Check out how to get started with guides.js'
}, {
element: $('#docs'),
html: 'Read the docs'
}]
});Now the tour will start everytime $('#demo') element is clicked.
If you want to manually start the tour you can do the following:
var guides = $.guides({
guides: [{
html: 'Welcome to Guides.js'
}, {
element: $('.navbar'),
html: 'Navigate through guides.js website'
}, {
element: $('#demo'),
html: 'See how it works'
}, {
element: $('#download'),
html: 'Download guides.js'
}, {
element: $('#getting-started'),
html: 'Check out how to get started with guides.js'
}, {
element: $('#docs'),
html: 'Read the docs'
}]
});
guides.start();##Configuration options
The default options are as follows:
{
distance: 100,
color: '#fffff',
guides: []
}- distance number - distance between the guide text and the element that it is related to
- color string - the guides arrows and text default color
- guides array of objects - the list of guides
###The guides array
A guide object looks like this:
{
element: $('.navbar-brand'),
html: 'Welcome to Guides.js',
color: '#fff'
}- element (optional) jquery element or string - the element (or selector) you want to highlight; if omitted the guide will be centered;
- html (required) string - this is the content of the tip: you can enter plain text or markup
- color (optional) string - the guide arrow and text color (falls back to the default color if not specified)
- render (optional) function - a callback function that is called before guide is rendered
##Methods
- start $('#demo').guides('start');
- end $('#demo').guides('end');
- next $('#demo').guides('next');
- prev $('#demo').guides('prev');
- destroy $('#demo').guides('destroy');
- setOptions $('#demo').guides('setOptions', options);
##Events
- start $('#demo').guides({start: onStartFunction});
- end $('#demo').guides({end: onStartFunction});
- next $('#demo').guides({next: onNextFunction});
- prev $('#demo').guides({prev: onPrevFunction});
- render $('#demo').guides({render: onRenderFunction});
- destroy $('#demo').guides({destroy: onDestroyFunction});
#Download
The source is availabe on github: https://github.com/epetrova/guides/:
git clone https://github.com/epetrova/guides.gitAlternatively, you can install using Bower:
bower install guides