Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs fixes #1845

Merged
merged 3 commits into from
Feb 27, 2022
Merged

Docs fixes #1845

merged 3 commits into from
Feb 27, 2022

Conversation

bkrmadtya
Copy link
Contributor

@bkrmadtya bkrmadtya commented Feb 20, 2022

Why

  • Example code was not functioning as it was supposed to
  • The instruction did not state clearly when the animation will be in effect which could be confusing for beginners (which was my case)

What

Updated the documentation:

  • Fixed the unused useSpring styles object that was not passed as style to the animated.div
  • Clearly stated when the animation is shown

Checklist

  • Documentation updated
  • Demo added
  • Ready to be merged

This was my first time trying react-spring and I tried the example in CodeSandBox but it was not working. Found why it was not working and updated the documentation so, it will be easier for anyone who is trying this library for the first time.

NB: This is my first time contributing to any open source project.

@vercel
Copy link

vercel bot commented Feb 20, 2022

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/pmndrs/react-spring-io/GVWSgp8Br2uAjMR3De6XJzC4RAVB
✅ Preview: https://react-spring-io-git-fork-bkrmadtya-docs-fixes-pmndrs.vercel.app

@codesandbox-ci
Copy link

codesandbox-ci bot commented Feb 20, 2022

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 61775a1:

Sandbox Source
pmndrs/react-spring Configuration
spring-card Configuration
spring-cards-stack Configuration
spring-chain Configuration
spring-draggable-list Configuration
pmndrs/react-spring Configuration
pmndrs/react-spring Configuration

@joshuaellis
Copy link
Member

Great catch! That's an issue with the docs package at the moment, so I need to take a look at that before I can merge this.

Copy link
Member

@joshuaellis joshuaellis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution! ⭐

@joshuaellis joshuaellis merged commit eee9656 into pmndrs:master Feb 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants