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: modified useScroll usage code #2257

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

Gaic4o
Copy link

@Gaic4o Gaic4o commented Feb 26, 2024

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

  • 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.

Copy link

changeset-bot bot commented Feb 26, 2024

⚠️ No Changeset found

Latest commit: b7f69b0

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

Copy link

vercel bot commented Feb 26, 2024

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

@joshuaellis
Copy link
Member

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?

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.

None yet

2 participants