react-spring

react-spring copied to clipboard

Why

Upon attempting to use the useResize hook as illustrated in the current documentation, I encountered an error stating that an argument was expected by useResize, but none was provided. This was specifically related to the initial usage example

const { width, height } = useResize();
return <animated.div style={{ width, height }}>Hello World</animated.div>

This led to some confusion, as it was not immediately clear that useResize requires at least one argument to function correctly.

What

To make it easier for people who use the useResize Hook to understand, we have modified the Usage example code.

Checklist

• [x] Documentation updated
• [ ] Demo added
• [ ] Ready to be merged

If there are any changes I need to make to my code, I would appreciate your feedback.

⚠️ No Changeset found

Latest commit: b7f69b06a34aabcf74aa80a4cdeba0947c7c3dfa

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
react-spring	❌ Failed (Inspect)			Feb 26, 2024 3:39pm

I find the example you've provided more unclear, perhaps you can remove the noise around it e.g. background color, interpolating etc. to make it much more bare bones and simpler to understand the minimum required to use the hook?