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: fix useSpring example and rewrite docs #181

Merged
merged 4 commits into from
Apr 4, 2024

Conversation

timpulver
Copy link
Contributor

@timpulver timpulver commented Apr 1, 2024

πŸ”— Linked issue

#148

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme or JSDoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

The docs for useSpring were outdated and the example was not working. I enhanced the useSpring docs by...:

  • Replacing the broken example with a new one (resolves useSpring not workingΒ #148)
  • Fixing the outdated parts in the useSpring docs
  • Rewriting parts of the useSpring docs for better clarity

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have added tests (if possible).
  • I have updated the documentation accordingly.

Tim Pulver added 4 commits April 1, 2024 15:19
The old example was not working, due to a change in the useSpring API and was therefore replaced.
This new example shows a complete Vue component and therefore lowers the barrier to using useSpring.
The API of useSpring was changed and the description was therefore outdated.
This makes it clearer what spring animations are and how a spring is configured.
In the rest of the `useSpring` doc, lower case β€œspring” is used.
@BobbieGoede BobbieGoede self-assigned this Apr 4, 2024
@Tahul
Copy link
Member

Tahul commented Apr 4, 2024

That looks excellent to me :)

Nice job @timpulver ; thank you so much!

@BobbieGoede BobbieGoede merged commit c9161f9 into vueuse:main Apr 4, 2024
5 checks passed
@BobbieGoede
Copy link
Collaborator

This is great! Thanks for contributing!

This pull request was closed.
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.

useSpring not working
3 participants