reactjs / reactjs/react.dev

Improve doc on componentDidUpdate

Open
#1,958 0 comments 0 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

This issue has been discussed, but seems not resolved.

The docs say

componentDidUpdate() is invoked immediately after updating occurs.

Many will agree that saying "after updating occurs" is rather vague. What is meant with updating? Is it called only when state changes? Or maybe when props changed? Can it be called if neither state, nor props changed?

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

Search the React documentation for the componentDidUpdate() entry and read the existing wording alongside the linked discussion in issue #2796. Clarify what “updating” means, including whether state or prop changes are required, and consider the documentation complete when the lifecycle conditions are stated unambiguously.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.