{"id":13399366,"url":"https://github.com/zurb/joyride","last_synced_at":"2025-05-15T07:05:27.584Z","repository":{"id":1740318,"uuid":"2565834","full_name":"zurb/joyride","owner":"zurb","description":"jQuery feature tour plugin.","archived":false,"fork":false,"pushed_at":"2020-09-08T15:52:56.000Z","size":1955,"stargazers_count":1419,"open_issues_count":129,"forks_count":235,"subscribers_count":115,"default_branch":"master","last_synced_at":"2025-05-14T13:31:52.021Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://www.zurb.com/playground/jquery-joyride-feature-tour-plugin","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zurb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-10-12T22:25:51.000Z","updated_at":"2025-04-07T02:22:18.000Z","dependencies_parsed_at":"2022-09-08T02:42:55.441Z","dependency_job_id":null,"html_url":"https://github.com/zurb/joyride","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zurb%2Fjoyride","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zurb%2Fjoyride/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zurb%2Fjoyride/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zurb%2Fjoyride/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zurb","download_url":"https://codeload.github.com/zurb/joyride/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254292040,"owners_count":22046426,"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-07-30T19:00:36.886Z","updated_at":"2025-05-15T07:05:22.569Z","avatar_url":"https://github.com/zurb.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","UI","Tours And Guides","Tours And Guides [🔝](#readme)","导览与指南"],"sub_categories":["Runner","运行器","运行器e2e测试"],"readme":"# Joyride\nJoyride is an easy to configure site tour wizard for [Foundation for Sites](https://github.com/zurb/foundation-sites).\n\n## Demo\nYou can try out Joyride on the [Demo Page](http://zurb.github.io/joyride/).\n\n## Installation\nTo install Joyride you can either use NPM ([NPM repository](https://www.npmjs.com/package/foundation-joyride))  or download the files directly.\n\n* `npm start` - Calls the build process and opens the demo in your browser.\n* `npm test` - Runs the JavaScript tests.\n* `npm run test:javascript` - Runs tests for JavaScript with Mocha using PhantomJS.\n* `npm run test:visual` - Runs visual tests/live demos.\n\n\n## Usage\nAll versions of joyride depend on jQuery and [what-input](https://github.com/ten1seven/what-input). While jQuery is mandatory, what-input is used for styling purposes and not necessary for joyride to work.\n\nRegardless of the way you use Joyride, you need to initialize it like all Foundation plugins by calling:\n\n```js\n$(document).foundation();\n```\n\nThe following HTML is an example on how to use Joyride. You can also have a look at the visual test cases in the `test/visual/` folder.\n\n```html\n\u003col data-joyride data-autostart=\"true\" id=\"docs-joyride\"\u003e\n  \u003cli data-target=\"#basic-joyride\"\u003e\n    \u003cp\u003eThis is the default one without settings\u003c/p\u003e\n  \u003c/li\u003e\n  \u003cli data-target=\"#footer\" data-position=\"bottom\" data-closable=\"false\"\u003e\n    \u003cp\u003eThis one isn't closable\u003c/p\u003e\n  \u003c/li\u003e\n  \u003cli\u003e\n    \u003cp\u003eIf no target is specified, you create a modal.\u003c/p\u003e\n  \u003c/li\u003e\n  \u003cli data-target=\"#open-issues\"\u003e\n    \u003cp\u003eYour ride ends here!\u003c/p\u003e\n    \u003cp class=\"text-center\"\u003e\n      \u003cbutton class=\"button success\" data-joyride-close\u003eOK, thanks!\u003c/button\u003e\n    \u003c/p\u003e\n  \u003c/li\u003e\n\u003c/ol\u003e\n```\n\n### Foundation plugin\nOriginally, Joyride is a plugin for Foundation for Sites and leaverages existing plugins and functionalities of the framework.\nTo use Joyride with Foundation, just include the files into your page right after the Foundation files. Then follow the example above to create the ride. \n\n### Standalone plugin\nTo make Joyride available for a broader amount of users, it is also available as a standalone plugin. All relevant Foundation functionalities are bundled with the Joyride files, so Joyride can still benefit from them.\nTo use Joyride with Foundation, just include the files into your page right and follow the example above to create the ride. \n\n### Using script loader\nJoyride can be used by including its files via HTML-tags and also the most popular script loaders, such as RequireJS. This is done by leveraging UMD.\n\n## Testing\n\n* `npm run test:javascript` to run JavaScript tests with Mocha using PhantomJS.\n* `npm run test:visual` to run visual regression tests.\n\n## Contributing\n\nCheck out our [contributing guide](http://foundation.zurb.com/develop/contribute.html) to learn how you can contribute to this plugin. You can also browse the [Help Wanted](https://github.com/zurb/joyride/labels/help%20wanted) tag in our issue tracker to find things to do.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzurb%2Fjoyride","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzurb%2Fjoyride","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzurb%2Fjoyride/lists"}