Installations
npm install @aborovsky/react-joyride
Developer Guide
Typescript
Yes
Module System
CommonJS
Node Version
14.16.0
NPM Version
6.14.11
Score
69.2
Supply Chain
89.5
Quality
74.1
Maintenance
100
Vulnerability
99.6
License
Releases
Contributors
Languages
TypeScript (98.14%)
CSS (1.67%)
HTML (0.19%)
Developer
Download Statistics
Total Downloads
1,105
Last Day
3
Last Week
3
Last Month
11
Last Year
95
GitHub Statistics
7,035 Stars
826 Commits
548 Forks
45 Watching
2 Branches
44 Contributors
Bundle Size
97.92 kB
Minified
28.68 kB
Minified + Gzipped
Package Meta Information
Latest Version
2.4.1
Package Id
@aborovsky/react-joyride@2.4.1
Unpacked Size
183.64 kB
Size
40.33 kB
File Count
6
NPM Version
6.14.11
Node Version
14.16.0
Total Downloads
Cumulative downloads
Total Downloads
1,105
Last day
0%
3
Compared to previous day
Last week
200%
3
Compared to previous week
Last month
57.1%
11
Compared to previous month
Last year
-42.4%
95
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
10
Peer Dependencies
3
Dev Dependencies
65
React Joyride
Create awesome tours for your app!
Showcase your app to new users or explain functionality of new features.
It uses react-floater for positioning and styling.
And you can use your own components too!
View the demo here (or the codesandbox examples)
Read the docs
Chat about it in our Spectrum community
Setup
1npm i react-joyride
Getting Started
1import Joyride from 'react-joyride'; 2 3export class App extends React.Component { 4 state = { 5 steps: [ 6 { 7 target: '.my-first-step', 8 content: 'This is my awesome feature!', 9 }, 10 { 11 target: '.my-other-step', 12 content: 'This another awesome feature!', 13 }, 14 ... 15 ] 16 }; 17 18 render () { 19 const { steps } = this.state; 20 21 return ( 22 <div className="app"> 23 <Joyride 24 steps={steps} 25 ... 26 /> 27 ... 28 </div> 29 ); 30 } 31}
If you need to support legacy browsers you need to include the scrollingelement polyfill.
Development
Setting up a local development environment is easy!
Clone (or fork) this repo on your machine, navigate to its location in the terminal and run:
1npm install 2npm link # link your local repo to your global packages 3npm run watch # build the files and watch for changes
Now clone https://github.com/gilbarbara/react-joyride-demo and run:
1npm install 2npm link react-joyride # just link your local copy into this project's node_modules 3npm start
Start coding! 🎉
No vulnerabilities found.
Reason
5 commit(s) and 14 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
packaging workflow detected
Details
- Info: Project packages its releases by way of GitHub Actions.: .github/workflows/main.yml:18
Reason
9 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-64vr-g452-qvp3
- Warn: Project is vulnerable to: GHSA-9cwx-2883-4wfx
- Warn: Project is vulnerable to: GHSA-vg6x-rcgg-rjx6
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Info: no jobLevel write permissions found
Reason
Found 0/15 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/gilbarbara/react-joyride/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/gilbarbara/react-joyride/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/gilbarbara/react-joyride/main.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/gilbarbara/react-joyride/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/gilbarbara/react-joyride/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:72: update your workflow using https://app.stepsecurity.io/secureworkflow/gilbarbara/react-joyride/main.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:81: update your workflow using https://app.stepsecurity.io/secureworkflow/gilbarbara/react-joyride/main.yml/main?enable=pin
- Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 3 third-party GitHubAction dependencies pinned
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 21 are checked with a SAST tool
Score
4.3
/10
Last Scanned on 2025-01-27
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More