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

Passing ref node to the onChange callback fn in useIntersectionObserver #617

Conversation

tengweiherr
Copy link

@tengweiherr tengweiherr commented Jul 16, 2024

Context
Since the breaking change in the useIntersectionObserver hook in v2.13.0, we no longer have to pass a ref to the hook. Instead, it exports the callback ref for us to bind to the DOM node. However, using the callback ref loses the ref node access at the same time. For instance, the user might want to have some side effects on the ref node itself when it is intersecting. It would be helpful if the ref node were passed to the onChange callback so we have access to it

Changes

  • pass ref node to the onChange callback in useIntersectionObserver
  • add type parameter so that the node passed to the callback fn will receive the correct type

Example

const { ref } = useIntersectionObserver<HTMLDivElement>({
  freezeOnceVisible: true,
  onChange: (isIntersecting, _, node) => {
    if (node !== null) {
      node.style.height = isIntersecting ? 'auto' : `100px`
    }
  },
})

* add type parameter <T> so that the node passed to the callback fn will receive the correct type
Copy link

changeset-bot bot commented Jul 16, 2024

⚠️ No Changeset found

Latest commit: 6cc79b3

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

@tengweiherr tengweiherr deleted the pass-ref-node-to-intersection-observer-onchange-callback branch July 16, 2024 18:47
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.

1 participant