{"id":15486499,"url":"https://github.com/ianfabs/vue-driver","last_synced_at":"2025-04-22T17:27:54.141Z","repository":{"id":96802035,"uuid":"169497563","full_name":"ianfabs/vue-driver","owner":"ianfabs","description":"A Vue.js wrapper for Driver.js","archived":false,"fork":false,"pushed_at":"2020-06-11T10:09:24.000Z","size":240,"stargazers_count":9,"open_issues_count":4,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-19T07:15:24.510Z","etag":null,"topics":["javascript","js","tour","tutorial","vue","web"],"latest_commit_sha":null,"homepage":null,"language":"CSS","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/ianfabs.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-02-07T00:20:20.000Z","updated_at":"2023-09-23T18:57:29.000Z","dependencies_parsed_at":"2023-04-09T06:02:47.072Z","dependency_job_id":null,"html_url":"https://github.com/ianfabs/vue-driver","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ianfabs%2Fvue-driver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ianfabs%2Fvue-driver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ianfabs%2Fvue-driver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ianfabs%2Fvue-driver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ianfabs","download_url":"https://codeload.github.com/ianfabs/vue-driver/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250286642,"owners_count":21405483,"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":["javascript","js","tour","tutorial","vue","web"],"created_at":"2024-10-02T06:08:40.267Z","updated_at":"2025-04-22T17:27:54.132Z","avatar_url":"https://github.com/ianfabs.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vue-driver.js\n\n    VueDriver is a Vue plugin for driver.js, a tool to help drive the users focus\n\n## Installation\n\n`\u003e npm install vue-driver.js`\n\n## Use\n\n```javascript\nimport Vue from \"vue\";\nimport VueDriver from \"vue-driver.js\";\n\nVue.use(VueDriver);\n\n// The rest of your Vue code\n...\n\n```\n\n## Directives\n\n### driver-step\n\nAdds `v-driver-step` directive\n\nit accepts an object that is structured like this:\n\n```javascript\n{\n  popover: {\n    title: String,\n    description: String,\n    position: String,\n    showButtons: Boolean,\n    closeBtnText: String,\n    nextBtnText: String,\n    prevBtnText: String\n  },\n  index: Number,\n  onclick: Boolean\n}\n```\nwhere the object types represent the type of the parameter\n\n\n*Note: if you specify the same index more than one step, it will choose whichever one binds last to have that position*\n\n#### Example\n\nWithout value\n```html\n\u003cdiv v-driver-step\u003e\n  Hi, I'm some content!\n\u003c/div\u003e\n```\n\nWith value\n```html\n\u003cdiv v-driver-step=\"{ popover: {title: 'Hey', description: 'Im a popover'} }\"\u003e\n  Hi, I'm some content!\n\u003c/div\u003e\n```\n\n## Mixins\n\nvue-driver has two mixins as of now\n\n### $startTour( index: Number )\n\n`$startTour` is a component mixin that starts a tour, if you've supplied steps through the `v-driver-step` attribute.\n\n*Note: You must stop event propigation on your button's click event. See [here](https://github.com/kamranahmedse/driver.js/issues/113#issuecomment-403237746) for an example*\n\n#### Example\n\nBad\n\n```html\n\u003cbutton @click=\"$startTour\"\u003estart tour\u003c/button\u003e\n```\nGood\n\n```html\n\u003cbutton @click.stop=\"$startTour\"\u003estart tour\u003c/button\u003e\n```\n\n### $driver\n\nThe `$driver` mixin exposes the current driver instance, so that you can use the driver.js api directly till i can write more useful mixins.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fianfabs%2Fvue-driver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fianfabs%2Fvue-driver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fianfabs%2Fvue-driver/lists"}