pkdevboxy / guiders-js

**Optimizely is hiring software engineers in SF** Guiders.js: A Javascript library for guiders. Requires jQuery.

Guiders.js (version 2.0.0)

Guiders are a user experience design pattern for introducing users to a web application.

Live Examples

Here are a couple examples hosted online. You can also check out README.html for guiders in action!

http://jrpickhardt.com/guiders/

https://optimizely.appspot.com/edit#url=www.google.com

Set Up

Here is sample code for initializing a couple of guiders. Guiders are hidden when created, unless .show() is method chained immediately after .createGuider.

guiders.createGuider({
  buttons: [{name: "Next"}],
  description: "Guiders are a user interface design pattern for introducing features of software. This dialog box, for example, is the first in a series of guiders that together make up a guide.",
  id: "first",
  next: "second",
  overlay: true,
  title: "Welcome to Guiders.js!"
}).show();
/* .show() means that this guider will get shown immediately after creation. */

guiders.createGuider({
  attachTo: "#clock",
  buttons: [{name: "Close, then click on the clock.", onclick: guiders.hideAll}],
  description: "Custom event handlers can be used to hide and show guiders. This allows you to interactively show the user how to use your software by having them complete steps. To try it, click on the clock.",
  id: "third",
  next: "fourth",
  position: 2,
  title: "You can also advance guiders from custom event handlers.",
  width: 450
});

The parameters for creating guiders are:

attachTo: (optional) selector of the html element you want to attach the guider to
autoFocus: (optional) if you want the browser to scroll to the position of the guider, set this to true
buttons: array of button objects
  {
    name: "Close",
    classString: "primary-button",
    onclick: callback function for when the button is clicked
      (if name is "close", "next", or "back", onclick defaults to guiders.hideAll, guiders.next, or guiders.prev respectively)
   }
buttonCustomHTML: (optional) custom HTML that gets appended to the buttons div
classString: (optional) custom class name that the guider should additionally have
closeOnEscape: (optional) if true, the escape key will close the currently open guider
description: text description that shows up inside the guider
highlight: (optional) selector of the html element you want to highlight (will cause element to be above the overlay)
isHashable: (defaults to true) the guider will be shown auto-shown when a page is loaded with a url hash parameter #guider=guider_name
offset: fine tune the position of the guider, e.g. { left:0, top: -10 }
onClose: (optional) additional function to call if a guider is closed by the x button, close button, or escape key
onHide: (optional) additional function to call when the guider is hidden
onShow: (optional) additional function to call before the guider is shown
overlay: (optional) if true, an overlay will pop up between the guider and the rest of the page
position: (optional / required if using attachTo) clock position at which the guider should be attached to the html element. Can also use a description keyword (such as "topLeft" for 11 or "bottom" for 6)
shouldSkip: (optional) if this function evaluates to true, the guider will be skipped
title: title of the guider
width: (optional) custom width of the guider (it defaults to 400px)
xButton: (optional) if true, a X will appear in the top right corner of the guider, as another way to close the guider

Integration

Besides creating guiders, here is sample code you can use in your application to work with guiders:

guiders.hideAll(); // hides all guiders
guiders.next();    // hides the last shown guider, if shown, and advances to the next guider
guiders.show(id);  // shows the guider, given the id used at creation
guiders.prev();    // shows the previous guider

You'll likely want to change the default values, such as the width (set to 400px). These can be found at the top of guiders.js in the _defaultSettings object. You'll also want to modify the css file to match your application's branding.

Creating a multi-page tour? If the URL of the current window is of the form http://www.myurl.com/mypage.html#guider=foo, then the guider with id equal to foo will be shown automatically. To use this, you can set the onHide of the last guider to an anonymous function: function() { window.location.href=http://www.myurl.com/mypage.html#guider=foo; }

Contributing

Contributions are welcome! If you would like to contribute, please issue a pull request against the dev branch, not the master branch.

Versioning

As of version 2.0.0, Guiders.js will follow the Semantic Versioning guidelines as much as possible.

Releases will follow the following format:

<major>.<minor>.<patch>

Updates will occur according to the following guidelines:

• Breaking backward compatibility bumps the major (and resets the minor and patch)
• New additions without breaking backward compatibility bumps the minor (and resets the patch)
• Bug fixes and misc changes bumps the patch

For more information on SemVer, visit http://semver.org/.

In Closing

Guiders are a great way to improve the user experience of your web application.

If you're interested in optimizing your user experience through A/B testing, check out Optimizely.

License

Released under the Apache License 2.0.