{"_id":"@aborovsky/react-joyride","_rev":"6-06a8dfc9aeb15c1107ad169fdfa9f7ed","time":{"created":"2021-12-12T21:32:23.553Z","2.4.1":"2021-12-12T21:32:23.770Z","modified":"2022-04-04T11:00:03.144Z"},"name":"@aborovsky/react-joyride","dist-tags":{"latest":"2.4.1"},"versions":{"2.4.1":{"name":"@aborovsky/react-joyride","version":"2.4.1","description":"Create guided tours for your apps","author":{"name":"Gil Barbara","email":"gilbarbara@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/gilbarbara/react-joyride.git"},"bugs":{"url":"https://github.com/gilbarbara/react-joyride/issues"},"homepage":"https://react-joyride.com/","keywords":["react","react-component","tooltips","joyride","walkthroughs","tour"],"license":"MIT","main":"lib/index.js","module":"es/index.js","types":"./types/index.d.ts","peerDependencies":{"prop-types":"^15.0.0","react":"^15.0.0 || ^16.0.0 || ^17.0.0","react-dom":"^15.0.0 || ^16.0.0 || ^17.0.0"},"dependencies":{"deep-diff":"^1.0.2","deepmerge":"^4.2.2","exenv":"^1.2.2","is-lite":"^0.8.1","nested-property":"^4.0.0","react-floater":"^0.7.3","react-is":"^16.13.1","scroll":"^3.0.1","scrollparent":"^2.0.1","tree-changes":"^0.7.1"},"devDependencies":{"@babel/core":"^7.15.8","@babel/plugin-proposal-class-properties":"^7.14.5","@babel/plugin-proposal-decorators":"^7.15.8","@babel/plugin-proposal-do-expressions":"^7.14.5","@babel/plugin-proposal-export-default-from":"^7.14.5","@babel/plugin-proposal-export-namespace-from":"^7.14.5","@babel/plugin-proposal-function-sent":"^7.14.5","@babel/plugin-proposal-json-strings":"^7.14.5","@babel/plugin-proposal-logical-assignment-operators":"^7.14.5","@babel/plugin-proposal-nullish-coalescing-operator":"^7.14.5","@babel/plugin-proposal-numeric-separator":"^7.14.5","@babel/plugin-proposal-optional-chaining":"^7.14.5","@babel/plugin-proposal-pipeline-operator":"^7.15.0","@babel/plugin-proposal-throw-expressions":"^7.14.5","@babel/plugin-syntax-dynamic-import":"^7.8.3","@babel/plugin-syntax-import-meta":"^7.10.4","@babel/plugin-transform-flow-strip-types":"^7.14.5","@babel/plugin-transform-runtime":"^7.15.8","@babel/preset-env":"^7.15.8","@babel/preset-flow":"^7.14.5","@babel/preset-react":"^7.14.5","@size-limit/preset-big-lib":"^6.0.2","@types/react":"^16.14.2","babel-core":"^7.0.0-bridge.0","babel-eslint":"^10.1.0","babel-jest":"^27.2.5","babel-plugin-array-includes":"^2.0.3","babel-plugin-jsx-remove-data-test-id":"^3.0.0","babel-plugin-transform-node-env-inline":"^0.4.3","babel-plugin-transform-react-remove-prop-types":"^0.4.24","caniuse-lite":"^1.0.30001265","cross-env":"^7.0.3","dtslint":"^4.1.6","enzyme":"^3.11.0","enzyme-adapter-react-16":"^1.15.6","eslint":"^7.32.0","eslint-config-airbnb":"^18.2.1","eslint-config-prettier":"^8.3.0","eslint-plugin-babel":"^5.3.1","eslint-plugin-flowtype":"^6.1.0","eslint-plugin-import":"^2.25.1","eslint-plugin-jsx-a11y":"^6.4.1","eslint-plugin-prettier":"^4.0.0","eslint-plugin-react":"^7.26.1","eslint-plugin-react-hooks":"^4.2.0","flow-bin":"^0.110.1","husky":"^4.3.8","is-ci-cli":"^2.2.0","jest":"^27.2.5","jest-enzyme":"^7.1.2","jest-extended":"^0.11.5","jest-watch-typeahead":"^1.0.0","lint-staged":"^11.2.3","prettier":"^2.4.1","prop-types":"^15.7.2","react":"^16.14.0","react-dom":"^16.14.0","repo-tools":"^0.2.2","rimraf":"^3.0.2","rollup":"^2.58.0","rollup-plugin-babel":"^4.3.3","rollup-plugin-commonjs":"^10.1.0","rollup-plugin-node-resolve":"^5.2.0","size-limit":"^6.0.1","typescript":"^4.4.3"},"scripts":{"build":" npm run clean && npm run build:scripts","build:scripts":"cross-env NODE_ENV=production rollup -c","watch":"rollup -cw","clean":"rimraf es && rimraf lib","lint":"eslint --ext .js,.jsx src test","test":"is-ci \"test:coverage\" \"test:watch\"","test:coverage":"jest --bail --coverage","test:watch":"jest --watchAll --verbose","format":"prettier \"**/*.{js,jsx,ts,tsx}\" --write","validate":"npm run lint && npm run test:coverage && flow && npm run build && npm run size","size":"size-limit","prepublishOnly":"npm run validate"},"size-limit":[{"path":"./es/index.js","limit":"32 kB"},{"path":"./lib/index.js","limit":"32 kB"}],"husky":{"hooks":{"pre-commit":"repo-tools check-remote && lint-staged && flow","post-merge":"repo-tools install-packages"}},"lint-staged":{"*.js?(x)":["eslint --fix","jest --findRelatedTests"],"*.(css|graphql|js|json|jsx|less|md|mdx|scss|ts|tsx|yaml|yml)":["prettier --write","git add"]},"gitHead":"bbafae62a9e49d5258b62c76955ea26c68dd146b","_id":"@aborovsky/react-joyride@2.4.1","_nodeVersion":"14.16.0","_npmVersion":"6.14.11","dist":{"integrity":"sha512-ij2SJSCqbi0mAUsfjgsKS62fbSB5bOfoZVQR4/UXI9UqiN1GhlvNp3fBbD5toF/3MKyCzl3y4tNOVOJt3lDymQ==","shasum":"c6ea2c8a6fa31c37b7ba464f7a5df1012be65fd2","tarball":"https://registry.npmjs.org/@aborovsky/react-joyride/-/react-joyride-2.4.1.tgz","fileCount":6,"unpackedSize":188049,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhtmpnCRA9TVsSAnZWagAAJpoP/3GMBbBU6UHlXElvaS2I\nZJFFU6o0ZAqVWfu0ytVDlAxqxwsnjPke+u7TbdFakDh5bj7P8u7j5CGykw/N\nlek3FBZA7XuYnALrb/oiEZeOb2MtfjFUYGuHvfj7DHE6ZZ8pVWw/xmpqIcOP\n4EkJIQdXiCwrjruOqQemF1GamUOnjqIPPMrkc+bsRZkZanzEw7qXCe5ekNC2\nc/W/dGLhi9FwZSWiwyXwFnRJXCeutm1rPokSCGtvLCRhLuKRcAcQK78K0oB9\n8f97VveG813qWYopK0+I7Wapireg3wS0C9Fv1HfcwJkUMTFnOnnRjjyWuQE2\nID2JIUhifILoQjtkuJCPP89wJsg5dePJoNF6bOaeI8WCKL8Nu6Vz2oyCF8IA\nhKuR7VMhjZDkCN5JE4H8I48BnlHuqTYRHMPolsKDN+RVIN5f9A1kCdzRvFEU\nTqyHPPu1P5RMDPD/njC2kz66bG7jjpN6Txy5Zs3tpwlrSpW9MkvyV9mhtkj+\nd4s79G6PmxKdcDZTzSF5DLTQnCjBxCiPifSOCpJpDshHfP8ZRkxAr4oas5Wa\niCZBnkXszuWgnki4lOT/NOP3MsRjyxSrR8A8nCIg9Wmf08hIh6dj1xDva2zu\nRZXLLUk1Y9j7jjmdgh1/sM+Oxp0ybHVpNU3DpUOvsP1gAwuY/kbRKebUFyMn\nucC3\r\n=IudO\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBuTu9IOW7b2Goelr3bGsLjL19BikS9Vn2yf3UTF1NtJAiEA22xx0GQ6usEwaJP1V4bO46taj8xlMHZtx9TevUq0oRc="}]},"_npmUser":{"name":"aborovsky","email":"aborovsky@beetoo.me"},"directories":{},"maintainers":[{"name":"aborovsky","email":"aborovsky@beetoo.me"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/react-joyride_2.4.1_1639344743625_0.9016608524242031"},"_hasShrinkwrap":false}},"maintainers":[{"name":"aborovsky","email":"aborovsky@beetoo.me"}],"description":"Create guided tours for your apps","homepage":"https://react-joyride.com/","keywords":["react","react-component","tooltips","joyride","walkthroughs","tour"],"repository":{"type":"git","url":"git+https://github.com/gilbarbara/react-joyride.git"},"author":{"name":"Gil Barbara","email":"gilbarbara@gmail.com"},"bugs":{"url":"https://github.com/gilbarbara/react-joyride/issues"},"license":"MIT","readme":"# React Joyride\n\n[![](https://badge.fury.io/js/react-joyride.svg)](https://www.npmjs.com/package/react-joyride) [![](https://travis-ci.org/gilbarbara/react-joyride.svg)](https://travis-ci.org/gilbarbara/react-joyride) [![](https://api.codeclimate.com/v1/badges/43ecb5536910133429bd/maintainability)](https://codeclimate.com/github/gilbarbara/react-joyride/maintainability) [![](https://api.codeclimate.com/v1/badges/43ecb5536910133429bd/test_coverage)](https://codeclimate.com/github/gilbarbara/react-joyride/test_coverage)\n\n[![Joyride example image](http://gilbarbara.com/files/react-joyride.png)](https://react-joyride.com/)\n\n#### Create awesome tours for your app!\n\nShowcase your app to new users or explain functionality of new features.\n\nIt uses [react-floater](https://github.com/gilbarbara/react-floater) for positioning and styling.  \nAnd you can use your own components too!\n\n**View the demo [here](https://react-joyride.com/)** (or the codesandbox [examples](https://codesandbox.io/s/github/gilbarbara/react-joyride-demo))\n\n**Read the [docs](https://docs.react-joyride.com/)**\n\nChat about it in our [Spectrum community](https://spectrum.chat/react-joyride)\n\n## Setup\n\n```bash\nnpm i react-joyride\n```\n\n## Getting Started\n\n```jsx\nimport Joyride from 'react-joyride';\n\nexport class App extends React.Component {\n  state = {\n    steps: [\n      {\n        target: '.my-first-step',\n        content: 'This is my awesome feature!',\n      },\n      {\n        target: '.my-other-step',\n        content: 'This another awesome feature!',\n      },\n      ...\n    ]\n  };\n\n  render () {\n    const { steps } = this.state;\n\n    return (\n      <div className=\"app\">\n        <Joyride\n          steps={steps}\n          ...\n        />\n        ...\n      </div>\n    );\n  }\n}\n```\n\n> If you need to support legacy browsers you need to include the [scrollingelement](https://github.com/mathiasbynens/document.scrollingElement) polyfill.\n\n## Development\n\nSetting up a local development environment is easy!\n\nClone (or fork) this repo on your machine, navigate to its location in the terminal and run:\n\n```bash\nnpm install\nnpm link # link your local repo to your global packages\nnpm run watch # build the files and watch for changes\n```\n\nNow clone https://github.com/gilbarbara/react-joyride-demo and run:\n\n```bash\nnpm install\nnpm link react-joyride # just link your local copy into this project's node_modules\nnpm start\n```\n\n**Start coding!** 🎉\n","readmeFilename":"README.md"}