Replace useCombinedRefs with useRefObjectAsForwardedRef
#2204
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: be7528b The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
iansan5653
commented
Aug 1, 2022
| * | ||
| * **NOTE**: The `refObject` should be passed to the underlying element, NOT the `forwardedRef`. | ||
| */ | ||
| export function useRefObjectAsForwardedRef<T>(forwardedRef: ForwardedRef<T>, refObject: RefObject<T>): void { |
There was a problem hiding this comment.
I'm open to suggestions for naming this. I think this name works but it could maybe be clearer. Other options I considered include:
useForwardedRefObjectuseForwardedRefAsRefObjectuseRefObjectAsHandle
size-limit report 📦
|
iansan5653
force-pushed
the
replace-use-combined-refs
branch
from
9aa7fda
to
be7528b
Compare
Merged
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
useCombinedRefshook only has one real use-case: combining forwarded refs with ref objects so that the value of the ref can be accessed withref.current. Elements can only take one ref, hence we 'combine' the refs into a single ref.In #2197 I attempted to improve the hook to make it more useful. However, @mattcosta7 noted that we could completely replace this one use case with a
useImperativeHandlecall, which is absolutely correct. By wrapping that call in a simple hook and replacinguseCombinedRefswith the new hook, we reach a number of advantages:useRefand forwarded refs as refs. By not creating a new ref through a hook, we avoid having to pass ref objects as dependencies to effects & memosSo this PR supersedes #2197, and I feel that it's a major improvement.
Merge checklist
[ ] Added/updated testsTake a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.