reactjs / reactjs/react.dev

Proposal to change state hook documentation

Open
#4,572 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
11.8k
Forks
7.9k
Avg merge
1d 11h
Merged PRs (30d)
11

Description

The current documentation for setting state hooks is shown as:

<button onClick={() => setCount(count + 1)}>

However wouldn't it be much better to use the previous state?

<button onClick={() => setCount(prevCount => prevCount + 1)}>

This would be more consistent with the original setState documentation.

I have also personally had issues with states being handled incorrectly due to using the documented method of setting state with the rendered state.

Wouldn't this prevent a lot of logical errors people may face due to the documentation?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Hooks introduction documentation and compare its state-setting example with the linked original setState documentation. Update the example or accompanying guidance to address functional updates and consistency with the existing documentation; done means the revised example clearly communicates the intended state-update pattern.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.