Vue Surf

Vue Stage Play

Designing a guided tour for your website with vue components, much like directing a stage play.

Version License

Documentation

## What is VueStagePlay? VueStagePlay is a component-based package designed to assist you in implementing step-by-step guided tour function within your application. For developers using Vue, VueStagePlay makes developing such features much smoother. Simply import the component, pass in the props, and you're good to go. >The inspiration for VueStagePlay comes from [intro.js](https://introjs.com/) and [vue-starport](https://github.com/antfu/vue-starport). ## Features - 💚 Develop more naturally and seamlessly within your Vue application. - 🛠️ Simplify the customization of your guided tour and tooltip using slots and props. - 🎯 Focused on your SFC component, no need for additional configuration. - 🗞️ No need to import additional CSS files. ## Installation ``` $ npm install vue-stage-play ``` ## Usage Import `` in your root component and wrap it around the outermost layer. ```html ``` Next, import `` where you want to highlight elements and wrap the elements. Set the `actName` and `scene` for ``, and call the `action` function from the slot props. ```html ``` ## Documentation Refer to the [documentation](https://f820602h.github.io/vue-stage-play/) for more detailed information. ## License [MIT](./LICENSE) License © 2023 [max.lee](https://github.com/f820602)