search

gilbarbara / react-joyride

Create guided tours in your apps
https://react-joyride.com/
MIT License
6.62k stars 519 forks source link

Update example code to clarify Joyride placement #958

Closed mike-healy closed 6 months ago

mike-healy commented 8 months ago

Thanks for building Joyride. Using it for the first time I was confused because I misread the minimal ... in the README to mean that <Joyride> should wrap the other components it needed to be able to target, as opposed to being their sibling.

Though the README is correct as-is, I think having a tiny bit more context than ... would help people like me understand it correctly and where it needs to be positioned in the JSX.

Thanks

codesandbox-ci[bot] commented 8 months ago

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 5766dd17bb282ee50a4fa60d59fbec7baf807f17:

Sandbox Source
React Configuration
sonarcloud[bot] commented 8 months ago

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

gilbarbara commented 6 months ago

Hey @mike-healy

This is the standard for most react packages, especially my own. Thanks for the PR, but I'm leaving it as is.