{"id":18656593,"url":"https://github.com/zendesk/chariot-tooltips","last_synced_at":"2025-10-05T04:31:23.530Z","repository":{"id":41150364,"uuid":"38845385","full_name":"zendesk/chariot-tooltips","owner":"zendesk","description":"A javascript library for creating on screen step by step tutorials.","archived":false,"fork":false,"pushed_at":"2024-07-22T20:48:15.000Z","size":1500,"stargazers_count":26,"open_issues_count":21,"forks_count":6,"subscribers_count":363,"default_branch":"master","last_synced_at":"2025-01-16T21:08:32.740Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zendesk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-07-09T21:08:27.000Z","updated_at":"2021-11-24T05:23:20.000Z","dependencies_parsed_at":"2024-06-21T18:56:00.778Z","dependency_job_id":"572e64a9-5f69-4176-bae4-852a81f96e4a","html_url":"https://github.com/zendesk/chariot-tooltips","commit_stats":{"total_commits":25,"total_committers":6,"mean_commits":4.166666666666667,"dds":0.6799999999999999,"last_synced_commit":"0650103b2074a48f933ea21846606352da0fa3b7"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Fchariot-tooltips","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Fchariot-tooltips/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Fchariot-tooltips/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Fchariot-tooltips/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zendesk","download_url":"https://codeload.github.com/zendesk/chariot-tooltips/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235361643,"owners_count":18977720,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T07:24:12.687Z","updated_at":"2025-10-05T04:31:23.086Z","avatar_url":"https://github.com/zendesk.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![repo-checks](https://github.com/zendesk/chariot-tooltips/workflows/repo-checks/badge.svg)\n![example image](example/chariot_screenshot.png)\n\n# Chariot\n\u003e Walkthroughs so easy, you might as well be flying in a chariot.\n\nA Javascript library for creating step-by-step tooltip tutorials, using a\nbackground overlay to bring focus to the elements you care about.\n\n# Demo\n\nVisit the [live demo](http://chariot.zendesk.com).\n\n# Motivation\nTooltips are better at drawing focus to highlighted elements on a website\nwhen the background is dimmed out.\n\nExisting tooltip overlay solutions don't use overlay backgrounds, or if they\ndo, they fail to consider when parent containers already have the CSS\n`z-index` property set.\n(A child element's `z-index` cannot override it's parent's `z-index`).\n\n# Features\n\n- Programmatic API and lifecycle callbacks\n- Overlay obscures the background, and your key elements are cloned over it\n- `z-index` is taken care of\n- Tooltips are animated into view\n- Browser support includes every sane browser and IE9+\n\n# Usage\n\n`chariot.js` works in global, CommonJS and AMD contexts.\n\nVisit the [demo page](http://chariot.zendesk.com) for usage examples.\n\n# API\n\nIf you're running the project locally, you can view the JSDoc-formatted\ndocumentation at\n[http://localhost:8080/docs/global.html](http://localhost:8080/docs/global.html).\n\nOr go to the example site: http://chariot.zendesk.com/docs\n\n# Development\nCheckout the `development` branch.\n\tgit checkout development\n\nInstall node packages.\n\n\tyarn install # if you use yarn, otherwise\n\tnpm install\n\nInstall the gulp cli.\n\n\tnpm install -g gulp\n\nTo run a webserver:\n\n\tgulp connect\n\nThis will start a simple server that serves `index.html` at\n[http://localhost:8080/example/index.html](http://localhost:8080/example/index.html),\n and loads `chariot.js` onto the page.\nThe task will also watch your changes and reloads the page as the files are updated.\n\nRun the following style-checker before pushing your branch.\n\n\tgulp style\n\nTo automatically fix the style errors:\n\n\tgulp style-fix\n\nTo update the generated docs:\n\n\tgulp js-doc\n\n# Testing\n\n## Command Line\nTo run test in command line, run:\n\n\tgulp test\n\n## Browser\nIf you want to test the same test suite in multiple browsers, run:\n\n\tgulp testem\n\nThe browsers to test can be configured in `testem.yml`, currently it is configured to test in all major browsers (Firefox, Safari, Chrome) and PhantomJS.\n\n# Build\nRun the following to build `chariot.js` into thd `/dist` directory.\n\n\tgulp\n\n*Do not check in the `dist` directory. Release on github will contain the tarballs with compiled js/css.*\n\n# Release\n\nWhen you have merge in all your changes from your branch. Run the following **IN MASTER**:\n\n\tgulp release\n\nThis gulp task will\n\n1. Bump version in package.json, bower.json\n1. Auto-generate documentation with js-doc\n1. Package release into the `release/` folder\n1. Commit the version bump changes in package.json, bower.json\n1. Push the bump changes\n1. Tag with the new version\n\nAfter releasing, update the relevant files in your project which uses ChariotJS.\nUpdate version in bower/npm, or copy release/chariot.[min.]js,\nrelease/chariot.[min.]css into your project's `vendor/` folder.\n\n# Copyright and License\n\nCopyright 2016, Zendesk Inc. Licensed under the Apache License Version 2.0, http://www.apache.org/licenses/LICENSE-2.0\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzendesk%2Fchariot-tooltips","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzendesk%2Fchariot-tooltips","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzendesk%2Fchariot-tooltips/lists"}