{"id":15294900,"url":"https://github.com/fatihsolhan/v-onboarding","last_synced_at":"2026-05-31T21:00:42.894Z","repository":{"id":38172720,"uuid":"436305747","full_name":"fatihsolhan/v-onboarding","owner":"fatihsolhan","description":"A fully-typed, customizable onboarding component for Vue 3","archived":false,"fork":false,"pushed_at":"2026-05-10T23:42:33.000Z","size":19761,"stargazers_count":210,"open_issues_count":6,"forks_count":22,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-05-11T01:28:43.922Z","etag":null,"topics":["introduction","onboarding","vue","vue-introduction","vue-onboarding"],"latest_commit_sha":null,"homepage":"https://v-onboarding.fatihsolhan.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fatihsolhan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"fatihsolhan"}},"created_at":"2021-12-08T15:55:34.000Z","updated_at":"2026-05-10T23:42:34.000Z","dependencies_parsed_at":"2023-02-06T10:17:30.478Z","dependency_job_id":"3517fe2d-241c-4da8-b046-317325890be7","html_url":"https://github.com/fatihsolhan/v-onboarding","commit_stats":{"total_commits":152,"total_committers":9,"mean_commits":16.88888888888889,"dds":"0.36184210526315785","last_synced_commit":"a09cb8fb69bbf23b41a99a6b584bbc7bbe0cc098"},"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"purl":"pkg:github/fatihsolhan/v-onboarding","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fatihsolhan%2Fv-onboarding","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fatihsolhan%2Fv-onboarding/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fatihsolhan%2Fv-onboarding/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fatihsolhan%2Fv-onboarding/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fatihsolhan","download_url":"https://codeload.github.com/fatihsolhan/v-onboarding/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fatihsolhan%2Fv-onboarding/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33748607,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-31T02:00:06.040Z","response_time":95,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["introduction","onboarding","vue","vue-introduction","vue-onboarding"],"created_at":"2024-09-30T17:07:49.678Z","updated_at":"2026-05-31T21:00:42.887Z","avatar_url":"https://github.com/fatihsolhan.png","language":"TypeScript","funding_links":["https://github.com/sponsors/fatihsolhan"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# v-onboarding\n\nA fully-typed, customizable onboarding component for Vue 3\n\n\u003e Looking for React? Check out [r-onboarding](https://github.com/fatihsolhan/r-onboarding)\n\n[![Version](https://img.shields.io/npm/v/v-onboarding.svg?style=flat-square)](https://www.npmjs.com/package/v-onboarding)\n[![License](https://img.shields.io/npm/l/v-onboarding.svg?style=flat-square)](https://www.npmjs.com/package/v-onboarding)\n[![Downloads](https://img.shields.io/npm/dm/v-onboarding.svg?style=flat-square)](https://www.npmjs.com/package/v-onboarding)\n[![Nuxt](https://img.shields.io/badge/Nuxt-00DC82?style=flat-square\u0026logo=nuxt.js\u0026logoColor=white)](https://v-onboarding-docs.fatihsolhan.com/guide/nuxt)\n\n[Demo](https://v-onboarding.fatihsolhan.com/) · [Documentation](https://v-onboarding-docs.fatihsolhan.com/)\n\n\u003cimg src=\"demo/src/assets/screenshot.png\" alt=\"v-onboarding screenshot\" /\u003e\n\n\u003c/div\u003e\n\n---\n\n## Features\n\n- **TypeScript First** - Full type support out of the box\n- **Customizable UI** - Use default styling or bring your own with slots\n- **Accessible** - Built-in focus trap for keyboard navigation\n- **Flexible Positioning** - Smart tooltip placement with Popper.js\n- **SVG Overlay** - Highlight elements with customizable overlay\n- **Lifecycle Hooks** - `onBeforeStep`, `onAfterStep` for custom logic\n\n## Installation\n\n```sh\n# npm\nnpm install v-onboarding\n\n# yarn\nyarn add v-onboarding\n\n# pnpm\npnpm add v-onboarding\n```\n\n## Nuxt\n\nFor Nuxt 3+ applications, use the built-in module:\n\n```ts\n// nuxt.config.ts\nexport default defineNuxtConfig({\n  modules: ['v-onboarding/nuxt']\n})\n```\n\nComponents, composables, and styles are auto-imported. See the [Nuxt guide](https://v-onboarding-docs.fatihsolhan.com/guide/nuxt) for configuration options.\n\n## Quick Start\n\n```vue\n\u003cscript setup lang=\"ts\"\u003e\nimport { ref } from 'vue'\nimport { VOnboardingWrapper, VOnboardingStep } from 'v-onboarding'\nimport 'v-onboarding/dist/style.css'\n\nconst wrapper = ref(null)\nconst steps = [\n  {\n    attachTo: { element: '#feature-1' },\n    content: { title: 'Welcome!', description: 'Let me show you around.' }\n  },\n  {\n    attachTo: { element: '#feature-2' },\n    content: { title: 'Next Feature', description: 'Here is another feature.' }\n  }\n]\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n  \u003cVOnboardingWrapper ref=\"wrapper\" :steps=\"steps\" /\u003e\n\n  \u003cbutton @click=\"wrapper?.start()\"\u003eStart Tour\u003c/button\u003e\n\n  \u003cdiv id=\"feature-1\"\u003eFeature 1\u003c/div\u003e\n  \u003cdiv id=\"feature-2\"\u003eFeature 2\u003c/div\u003e\n\u003c/template\u003e\n```\n\n## Using Vue Template Refs\n\nYou can attach steps to elements using Vue template refs:\n\n```vue\n\u003cscript setup lang=\"ts\"\u003e\nimport { ref } from 'vue'\nimport { VOnboardingWrapper } from 'v-onboarding'\nimport 'v-onboarding/dist/style.css'\n\nconst wrapper = ref(null)\nconst buttonRef = ref(null)\n\nconst steps = [\n  {\n    attachTo: { element: buttonRef },\n    content: { title: 'Click me!', description: 'This button uses a template ref.' }\n  }\n]\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n  \u003cVOnboardingWrapper ref=\"wrapper\" :steps=\"steps\" /\u003e\n  \u003cbutton ref=\"buttonRef\" @click=\"wrapper?.start()\"\u003eStart Tour\u003c/button\u003e\n\u003c/template\u003e\n```\n\n## Custom Step UI\n\nUse the default slot to create your own step UI:\n\n```vue\n\u003cVOnboardingWrapper ref=\"wrapper\" :steps=\"steps\"\u003e\n  \u003ctemplate #default=\"{ step, next, previous, exit, isFirst, isLast }\"\u003e\n    \u003cVOnboardingStep\u003e\n      \u003cdiv class=\"my-custom-tooltip\"\u003e\n        \u003ch3\u003e{{ step.content.title }}\u003c/h3\u003e\n        \u003cp\u003e{{ step.content.description }}\u003c/p\u003e\n        \u003cbutton v-if=\"!isFirst\" @click=\"previous\"\u003eBack\u003c/button\u003e\n        \u003cbutton @click=\"isLast ? exit() : next()\"\u003e\n          {{ isLast ? 'Finish' : 'Next' }}\n        \u003c/button\u003e\n      \u003c/div\u003e\n    \u003c/VOnboardingStep\u003e\n  \u003c/template\u003e\n\u003c/VOnboardingWrapper\u003e\n```\n\n## Styling\n\nCustomize the overlay and tooltips with CSS variables:\n\n```css\n:root {\n  --v-onboarding-overlay-z: 10;\n  --v-onboarding-step-z: 20;\n\n  /* SVG Overlay */\n  --v-onboarding-overlay-fill: rgba(0, 0, 0, 0.75);\n\n  /* Tooltip */\n  --v-onboarding-step-arrow-background: white;\n}\n```\n\n## Documentation\n\nFor full documentation including all props, events, hooks, and examples, visit the [documentation site](https://v-onboarding-docs.fatihsolhan.com/).\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffatihsolhan%2Fv-onboarding","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffatihsolhan%2Fv-onboarding","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffatihsolhan%2Fv-onboarding/lists"}