docs: fix useSpring example and rewrite docs - Githubissues

vueuse / motion

🤹 Vue Composables putting your components in motion

https://motion.vueuse.org

MIT License

2.27k stars 79 forks source link

docs: fix useSpring example and rewrite docs #181

Closed timpulver closed 6 months ago

timpulver commented 6 months ago

🔗 Linked issue

https://github.com/vueuse/motion/issues/148

❓ Type of change

[x] 📖 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 #148)
Fixing the outdated parts in the useSpring docs
Rewriting parts of the useSpring docs for better clarity

📝 Checklist

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

Tahul commented 6 months ago

That looks excellent to me :)

Nice job @timpulver ; thank you so much!

BobbieGoede commented 6 months ago

This is great! Thanks for contributing!