A javascript library for creating on screen step by step tutorials.
JavaScript CSS HTML
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets/images
docs
example
lib
release
stylesheets
test
.babelrc Updated babel and babelify versions, then added .babelrc file with Dec 6, 2016
.gitignore
.jscsrc
.node-version
.nvmrc
.travis.yml
AUTHORS
LICENSE.txt
README.md
bower.json
gulpfile.js
package.json
testem.yml
webpack.config.babel.js
yarn.lock

README.md

example image

Chariot

Walkthroughs so easy, you might as well be flying in a chariot.

A Javascript library for creating step-by-step tooltip tutorials, using a background overlay to bring focus to the elements you care about.

Demo

Visit the live demo.

Motivation

Tooltips are better at drawing focus to highlighted elements on a website when the background is dimmed out.

Existing tooltip overlay solutions don't use overlay backgrounds, or if they do, they fail to consider when parent containers already have the CSS z-index property set. (A child element's z-index cannot override it's parent's z-index).

Features

  • Programmatic API and lifecycle callbacks
  • Overlay obscures the background, and your key elements are cloned over it
  • z-index is taken care of
  • Tooltips are animated into view
  • Browser support includes every sane browser and IE9+

Usage

chariot.js works in global, CommonJS and AMD contexts.

Visit the demo page for usage examples.

API

If you're running the project locally, you can view the JSDoc-formatted documentation at http://localhost:8080/docs/global.html.

Or go to the example site: http://chariot.zendesk.com/docs

Development

Checkout the development branch. git checkout development

Install node packages.

yarn install # if you use yarn, otherwise
npm install

Install the gulp cli.

npm install -g gulp

To run a webserver:

gulp connect

This will start a simple server that serves index.html at http://localhost:8080/example/index.html, and loads chariot.js onto the page. The task will also watch your changes and reloads the page as the files are updated.

Run the following style-checker before pushing your branch.

gulp style

To automatically fix the style errors:

gulp style-fix

To update the generated docs:

gulp js-doc

Testing

Command Line

To run test in command line, run:

gulp test

Browser

If you want to test the same test suite in multiple browsers, run:

gulp testem

The browsers to test can be configured in testem.yml, currently it is configured to test in all major browsers (Firefox, Safari, Chrome) and PhantomJS.

Build

Run the following to build chariot.js into thd /dist directory.

gulp

Do not check in the dist directory. Release on github will contain the tarballs with compiled js/css.

Release

When you have merge in all your changes from your branch. Run the following IN MASTER:

gulp release

This gulp task will

  1. Bump version in package.json, bower.json
  2. Auto-generate documentation with js-doc
  3. Package release into the release/ folder
  4. Commit the version bump changes in package.json, bower.json
  5. Push the bump changes
  6. Tag with the new version

After releasing, update the relevant files in your project which uses ChariotJS. Update version in bower/npm, or copy release/chariot.[min.]js, release/chariot.[min.]css into your project's vendor/ folder.

Copyright and License

Copyright 2016, Zendesk Inc. Licensed under the Apache License Version 2.0, http://www.apache.org/licenses/LICENSE-2.0