{"_id":"@asicupv/paella-onboarding-plugin","name":"@asicupv/paella-onboarding-plugin","dist-tags":{"latest":"2.2.11"},"versions":{"2.2.11":{"name":"@asicupv/paella-onboarding-plugin","version":"2.2.11","type":"module","exports":{".":{"types":"./dist/types/paella-onboarding-plugin.es.d.ts","import":"./dist/paella-onboarding-plugin.es.js","require":"./dist/paella-onboarding-plugin.cjs.js"},"./paella-onboarding-plugin.css":{"import":"./dist/paella-onboarding-plugin.css","require":"./dist/paella-onboarding-plugin.css"}},"description":"A plugin for Paella Player that provides onboarding functionality to guide users through the interface and features.","scripts":{"dev":"tsc && vite build --watch","build":"tsc && vite build --emptyOutDir"},"repository":{"type":"git","url":"git+https://github.com/polimediaupv/paella-player.git"},"keywords":["paella","player","onboarding","help"],"author":{"name":"Miguel Escriva Gregori","email":"miesge@gmail.com"},"license":"SEE LICENSE IN license.txt","bugs":{"url":"https://github.com/polimediaupv/paella-player/issues"},"homepage":"https://github.com/polimediaupv/paella-player#readme","devDependencies":{"@types/node":"^24.0.3","typescript":"~5.8.3","vite":"^6.0.11","vite-plugin-dts":"^4.5.4"},"dependencies":{"@asicupv/paella-core":"^2.2.11","shepherd.js":"^14.5.0"},"_id":"@asicupv/paella-onboarding-plugin@2.2.11","gitHead":"f69bc23a748c1bf4abe5e7fd01e506d61ef370bc","_nodeVersion":"20.11.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-cEva72cTXAQ1us705luB0hae+RvMvypjE/Wq9+mzRpIPwmuc3PqlFNKAzXSeSJRRL6HZKMvAPS+OcIbFYhYang==","shasum":"e0a8efb099f7f13e6313484daf4148617919f87f","tarball":"https://registry.npmjs.org/@asicupv/paella-onboarding-plugin/-/paella-onboarding-plugin-2.2.11.tgz","fileCount":13,"unpackedSize":739314,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCyHvLSoL7T5whBIIfJSI4ea+lOpA6SRvmwm0oKlU3GZgIhAL2+iZ2sObAZX7JrusAHMfEZNkUqOvbxlrxlQjJIrd4U"}]},"_npmUser":{"name":"miesgre","email":"miesgre@gmail.com","actor":{"name":"miesgre","email":"miesgre@gmail.com","type":"user"}},"directories":{},"maintainers":[{"name":"polimediaupv","email":"polim@upvnet.upv.es"},{"name":"miesgre","email":"miesgre@gmail.com"},{"name":"miedgo","email":"miedgo@inf.upv.es"},{"name":"ferserc1","email":"ferserc1@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/paella-onboarding-plugin_2.2.11_1750947918371_0.16450189907046586"},"_hasShrinkwrap":false}},"time":{"created":"2025-06-26T14:25:18.310Z","2.2.11":"2025-06-26T14:25:18.565Z","modified":"2025-06-26T14:25:18.942Z"},"maintainers":[{"name":"polimediaupv","email":"polim@upvnet.upv.es"},{"name":"miesgre","email":"miesgre@gmail.com"},{"name":"miedgo","email":"miedgo@inf.upv.es"},{"name":"ferserc1","email":"ferserc1@gmail.com"}],"description":"A plugin for Paella Player that provides onboarding functionality to guide users through the interface and features.","homepage":"https://github.com/polimediaupv/paella-player#readme","keywords":["paella","player","onboarding","help"],"repository":{"type":"git","url":"git+https://github.com/polimediaupv/paella-player.git"},"author":{"name":"Miguel Escriva Gregori","email":"miesge@gmail.com"},"bugs":{"url":"https://github.com/polimediaupv/paella-player/issues"},"license":"SEE LICENSE IN license.txt","readme":"# paella-onboarding-plugin\n\n## Description\n\nThe `paella-onboarding-plugin` provides an interactive tutorial for users to familiarize themselves with the features of the Paella Player. It uses the `shepherd.js` library to create guided tours.\n\n## Features\n\n- Step-by-step tutorial for navigating the player.\n- Highlights key elements of the player interface.\n- Option to disable the tutorial permanently.\n\n## Installation\n\nInstall the plugin via npm:\n\n```bash\nnpm install @asicupv/paella-onboarding-plugin\n```\n\n## Usage\n\n### Step 1: Import the plugin and CSS\n\n```typescript\nimport { OnboardingPlugin } from '@asicupv/paella-onboarding-plugin';\nimport '@asicupv/paella-onboarding-plugin/paella-onboarding-plugin.css';\n```\n\n### Step 2: Add the plugin to the Paella Player configuration\n\n```typescript\nlet paella = new Paella('player-container', {\n    plugins: [\n        {\n            plugin: OnboardingPlugin,\n            config: {\n                enabled: true\n            }\n        }\n    ]\n});\n```\n\n\n## Configuration\n\nThe plugin can be configured in the `config.json` file:\n\n```json\n{\n    \"plugins\": {\n        \"es.upv.paella.onboarding\": {\n            \"enabled\": true\n        }\n    }\n}\n```\n\n### Options\n\n- `enabled`: Enable or disable the plugin.\n\n## Screenshots\n\n### Example of a tutorial step\n![tutorial_step.png](tutorial_step.png)\n\n## Dependencies\n\n- [shepherd.js](https://shepherdjs.dev/): Library for creating guided tours.\n\n","readmeFilename":"README.md","_rev":"1-da97f14065383caa7987b09e49ef78c8"}