docs: clarify this binding in setState callback#8414
Open
Assamee wants to merge 1 commit intoreactjs:mainfrom
Open
docs: clarify this binding in setState callback#8414Assamee wants to merge 1 commit intoreactjs:mainfrom
Assamee wants to merge 1 commit intoreactjs:mainfrom
Conversation
Size changesDetails📦 Next.js Bundle Analysis for react-devThis analysis was generated by the Next.js Bundle Analysis action. 🤖 This PR introduced no changes to the JavaScript bundle! 🙌 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #8314
Summary
The legacy
ComponentAPI docs forsetStatedon't mention that React automatically bindsthisfor the optional callback parameter. This usually leads to developers writing unnecessary arrow functions or using manual.bind(this)because they (rightly) assume standard JS rules apply.I've updated the callback description to clarify that React handles this binding internally rather than leaving it as an undocumented behaviour.
Testing
I verified this in a local Vite environment with a standard Class Component. I used a
function()(not an arrow function) as the callback and confirmed thatthiscorrectly points to the component instance. I also verified that I could accessthis.stateandthis.propsinside the callback without any manual binding.