Walkthroughs so easy, you might as well be flying in a chariot.
Visit the live demo.
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
- Programmatic API and lifecycle callbacks
- Overlay obscures the background, and your key elements are cloned over it
z-indexis taken care of
- Tooltips are animated into view
- Browser support includes every sane browser and IE9+
chariot.js works in global, CommonJS and AMD contexts.
Visit the demo page for usage examples.
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
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:
This will start a simple server that serves
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.
To automatically fix the style errors:
To update the generated docs:
To run test in command line, run:
If you want to test the same test suite in multiple browsers, run:
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.
Run the following to build
chariot.js into thd
Do not check in the
dist directory. Release on github will contain the tarballs with compiled js/css.
When you have merge in all your changes from your branch. Run the following IN MASTER:
This gulp task will
- Bump version in package.json, bower.json
- Auto-generate documentation with js-doc
- Package release into the
- Commit the version bump changes in package.json, bower.json
- Push the bump changes
- 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
Copyright and License
Copyright 2016, Zendesk Inc. Licensed under the Apache License Version 2.0, http://www.apache.org/licenses/LICENSE-2.0