{"_id":"@cysense-hq/tourjs","_rev":"1-66891c12f2c8dc2b9a0499d2c5bda763","name":"@cysense-hq/tourjs","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@cysense-hq/tourjs","version":"1.0.0","description":"Website guided tour","main":"src/index.js","devDependencies":{"@babel/core":"^7.20.12","@floating-ui/dom":"^1.1.1","@popperjs/core":"^2.9.2","babel-loader":"^9.1.2","bootstrap":"^5.0.2","webpack":"^5.75.0","webpack-cli":"^5.0.1"},"scripts":{"build":"webpack --mode production"},"repository":{"type":"git","url":"git+https://github.com/cysense-hq/tour-js.git"},"keywords":["website guided tour","guided tour","tour","storybook","step by step guide","how to use website/webapp","website feature explain","virtual assistant"],"author":{"name":"cysense-hq"},"license":"ISC","bugs":{"url":"https://github.com/cysense-hq/tour-js/issues"},"homepage":"https://github.com/cysense-hq/tour-js#readme","gitHead":"095e34551542b05ffeced5e91f711a33bbe5fd13","_id":"@cysense-hq/tourjs@1.0.0","_nodeVersion":"19.4.0","_npmVersion":"9.2.0","dist":{"integrity":"sha512-ySxTtq4YuTdbs65rfxVdYxduqH2PLwFk7F6lqwhqiNPUIkHUb9SxKdXTdRj/mLELNDRlbgvTyi1jucOXksh7OQ==","shasum":"3244201800d5a440eb784696a89c55dcee910a78","tarball":"https://registry.npmjs.org/@cysense-hq/tourjs/-/tourjs-1.0.0.tgz","fileCount":22,"unpackedSize":54761,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCILUFx9iDGxcWqQ0CqDqlqiL+9YUdXak1wtBDxYZ+nVgIhALg6Gq/VqzzsYUtkopQ4Z+lma/xviPilvUtcuqHwCsLo"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj5Jy8ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoUzQ/+KViGrMDztSM93Imgxb0wzQcP5QfEqmW8AopIsHqdxbTSKXwt\r\nAB7RcRfTC5nSLVgkFmqGqKPwv2deKAdLYjRj3CU88GhMp6ESEEehI6yg06G1\r\n14b2VIQOdrw13YyMS0MMA+Ob0PjZKzJevBtSEC85J7ZmfC2lUne60Jy2p/+8\r\nPx1f6llR8KzxAsQ2Cbz9fYB4swGVcu7kJvTKdcHN920qHaZJuNq9cdBcnxkn\r\nGJmehVGLfj6pWkUMzizg162qx0+Ki0Uuxq1tKaKQgNFO287V7lkHlZ5m5dZA\r\nac4OQWr1eIvK7fnG3Dz8iBdqsws7TSEhi7swA4nwqIfY30+HzO4sH/xlMrYm\r\n9OalIIngCLbzxgB20kj66RjYcblS0tI1CB/aEZZhc0Yt4BEUDm5luPUy5C50\r\nVVok1KwBIYHEjol+9MCV5T/N+Mkw4JzkafDamNQ9esJqBWpBAdzHVSLsmVLe\r\nnKoF/c4p1g2MbG3LWuxXS//ZR0T6RI5/6khb87aJKdiO+L5A6/SnJlrNBMj4\r\ndMcZmST3/eExSXFNfPRzy5W2XMH6v3C2QkR+u4L7MwfSlMc0Zny1lkmbqSEb\r\npuE5e9B+dU8kP8rUxZA7JYWq+JN7o3Jkpy1/E5nyzpCRJ9Sxkpr8X6BaIDYS\r\nYlaK7SmQOPZRMhWdoSJjqcYdl8o7mnQ+MqU=\r\n=W+Jb\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"digitaldreams","email":"digitaldreams40@gmail.com"},"directories":{},"maintainers":[{"name":"digitaldreams","email":"digitaldreams40@gmail.com"},{"name":"zoeller","email":"dev@zoeller.biz"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/tourjs_1.0.0_1675926716581_0.046068171788712586"},"_hasShrinkwrap":false},"1.0.1":{"name":"@cysense-hq/tourjs","version":"1.0.1","description":"Website guided tour","main":"src/index.js","devDependencies":{"@babel/core":"^7.20.12","@floating-ui/dom":"^1.1.1","@popperjs/core":"^2.9.2","babel-loader":"^9.1.2","bootstrap":"^5.0.2","webpack":"^5.75.0","webpack-cli":"^5.0.1"},"scripts":{"build":"webpack --mode production"},"repository":{"type":"git","url":"git+https://github.com/cysense-hq/tour-js.git"},"keywords":["website guided tour","guided tour","tour","storybook","step by step guide","how to use website/webapp","website feature explain","virtual assistant"],"author":{"name":"cysense-hq"},"license":"ISC","bugs":{"url":"https://github.com/cysense-hq/tour-js/issues"},"homepage":"https://github.com/cysense-hq/tour-js#readme","gitHead":"6d4d3d0e4379c689935cebfcbcc40dfa02a1f792","_id":"@cysense-hq/tourjs@1.0.1","_nodeVersion":"19.4.0","_npmVersion":"9.2.0","dist":{"integrity":"sha512-gqFDidYCJAYbL14KdmgEeGUMxSo07Tcv/TXUVVk3rQLkX1cGuE3cxR7ghqIxfuGKTSyn7wD7Dlt3/zINKf0bWA==","shasum":"7eff6e872856c32c5bccd51293205d685cfaf0ec","tarball":"https://registry.npmjs.org/@cysense-hq/tourjs/-/tourjs-1.0.1.tgz","fileCount":22,"unpackedSize":55164,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC6xldgW7U8AX/HENUbqFJZTp8uqNyO5PF3qmpJ0vvNYAIhAJpqbqBJVaKCw7KXHWbb+gXf8tMXXXXsHESjByv3IP8Z"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj5J3CACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmodYxAAow7MHlinPayR2Z6N9hkx1yBHfCoXXLVJMgKebYSHXnBC7y6w\r\nBCS/uGpiR2PThUGBg6QGk2YBu8hZLOE5AdS2xA6MTw00nelsOFVLc0dyqDHN\r\nYaOT87TozXqesfE7/RMZuEra9wjm5N6U6Xppe8VNFydmAU5hM5yvZvTopkPN\r\nUpYLEyv9ctwXi+yEFKQSohdZFX+lLB7ZximhtpCx4yvRu8x0nYBjx7EThbyo\r\nRdDxurVKzGQRyBahQYBp4fZCpnKefNWLg5Fcx/g4QBt0FJfluyrvlJahbPhE\r\n3QL5PybTAzD5xs03Lp194M5KYsft8njOAsUOgaMzTCmLmTXnTJ3dtZe7jboH\r\n3JUbBvnR+5jZYnfHLGQL/pmkVysM5/jiReHxhUvqSgQKKB8cS8JMhijs08Dl\r\nyd3+rW7IVUSM5WTLQ3+9t20j8CG9oSEDQkrReR7mdJcSPoP+euR1AnQrqxxA\r\n7kSJzcEXCZ4IrTtKs6S3gYLs6XYX68qn3m8Ad6vu9zVYobd5ntyEmfWUbhMf\r\nWI541vUj1VOxG7WAS41281xqBhfGr+JtL+Q67tvpwUZTPra8nxvLlmxeuV/y\r\nDpYAZFH+2nwKl9LLOS4Wl27BLWV8OeCix+lHyIxrMPZeC32da2fhz2amllvb\r\nWhCOfXIlzSmfurNx31af58ENwwUl7DSv/No=\r\n=IreE\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"digitaldreams","email":"digitaldreams40@gmail.com"},"directories":{},"maintainers":[{"name":"digitaldreams","email":"digitaldreams40@gmail.com"},{"name":"zoeller","email":"dev@zoeller.biz"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/tourjs_1.0.1_1675926978622_0.7656301178453644"},"_hasShrinkwrap":false}},"time":{"created":"2023-02-09T07:11:56.478Z","1.0.0":"2023-02-09T07:11:56.717Z","modified":"2023-02-09T07:16:18.907Z","1.0.1":"2023-02-09T07:16:18.785Z"},"maintainers":[{"name":"digitaldreams","email":"digitaldreams40@gmail.com"},{"name":"zoeller","email":"dev@zoeller.biz"}],"description":"Website guided tour","homepage":"https://github.com/cysense-hq/tour-js#readme","keywords":["website guided tour","guided tour","tour","storybook","step by step guide","how to use website/webapp","website feature explain","virtual assistant"],"repository":{"type":"git","url":"git+https://github.com/cysense-hq/tour-js.git"},"author":{"name":"cysense-hq"},"bugs":{"url":"https://github.com/cysense-hq/tour-js/issues"},"license":"ISC","readme":"# Website Guided Tour\n\n### How to Install\n``` \nnpm install @cysense-hq/tourjs --save\n```\n![cysense-hq-website-guided-tour-demo](https://user-images.githubusercontent.com/6059541/217733066-6ed7759e-d288-4e40-9e49-83715de982e0.gif)\n\n\n### How to start\n#### Via Button\nCopy this HTML code and paste anywhere. Click on this button will start the tour.\n```html\n<tour-start class=\"...\" api=\"/Your-Api-Endpoint\" id=\"...\">Start the Tour</tour-start>\n```\nAPI here must be publicly available and `GET` method. \n\nThat's all you need to get started. You can skip following if you stick with the defaults.\n\n#### Via JavaScript\n```javascript\nfunction eventhandler(event) {\n    // Your code goes here\n    fetch('Your-API-Endpoint').then(response => {\n        return response.json();\n    }).then(response => {\n        globalThis.webtour = new Tourjs(response);\n    });\n}\n```\n**<font color=\"red\">Warning: variable must be `globalThis.webtour`. Because this global variable is used in other custom web components.</font>**\n\nYour API must be in the same format.\nYou does not have an API. No worries. You can create a json file in your project public folder. \nand then add this file like `api=\"getting-started-tour.json`\nSee our example api response json file here.\n\n### Read our Documentation for more\n1. [Theme Customization](Theme.md)\n2. [API data format](APIFormat.md)\n3. [Event](Event.md)\n\n\n\n","readmeFilename":"README.md"}