Make it clearer that string refs are considered legacy #6692
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
ghost
added
| > | ||
| > Although string refs are not deprecated, they are considered legacy, and will likely be deprecated at some point in the future. Callback refs are preferred. | ||
|
|
||
| React also supports using a string (instead of a callback) as a ref prop on any component. |
There was a problem hiding this comment.
Just noticed: while I'm in here, should "ref prop" be changed to "ref attribute," since it's not really a prop?
There was a problem hiding this comment.
We generally use the term prop to refer to anything that is passed into an element (eg. using jsx). I think it's probably fine as-is.
gaearon
added
Component: Documentation & Website
and removed
GH Review: review-needed
labels
|
LGTM |
zpao
pushed a commit
that referenced
this pull request
May 31, 2016
(cherry picked from commit d7ced68)
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.
Anecdotally, it's my impression that most people aren't aware that string refs are considered legacy. The docs mention it, but it's easy to miss. As an example, I brought this up on Twitter and @ryanflorence (whom no one can accuse of being a React newbie) noted that he hadn't bothered to look into callback refs yet.
This PR places the legacy warning in a stylized "Note" box, like similar warnings throughout the docs.
It might also be nice to link to a resource (perhaps a blog post?) that explains the disadvantages of string refs, but the only one I'm aware of is this old GitHub issue.