reactjs / reactjs/react.dev

[Bug]: Documentation for hooks: warning about infinite loop useEffect with state update is not prominent

Ouverte
#8,131 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

bug: unconfirmed
Langage dominant
JavaScript
Étoiles
11.8k
Forks
7.9k
Merge moyen
1 j 11 h
PR mergées (30 j)
11

Description

Summary

Description

The documentation for React Hooks (especially useEffect) mentions that updating state inside an effect without a proper dependency array can cause infinite loops, but this warning is not highlighted prominently. Many beginners miss this and end up in render loops.

Given how frequently this issue occurs, the documentation should emphasize it more clearly, perhaps with a bold warning and a simple example.

Example that causes confusion

import React, { useState, useEffect } from "react";

function MyComponent() {
  const [count, setCount] = useState(0);

  useEffect(() => {
    setCount(c => c + 1);
  }); // Missing dependency array

  return <div>{count}</div>;
}

Running this causes an infinite render loop because setCount triggers a state update on every render, re-invoking useEffect.

Actual behavior

  • Docs mention dependency arrays briefly, but the infinite loop risk is not highlighted enough.
  • Beginners often miss this and think React is “re-rendering infinitely” due to a bug.

Expected behavior

  • The official docs should include a bold, visible warning in the useEffect section, such as:

Warning: Omitting the dependency array causes the effect to run after every render, potentially leading to infinite loops if state or props are updated inside.

  • Include a small “bad vs. good” code example pair to clarify.

Why this matters

This is one of the most common pitfalls for new React developers. Making the warning prominent in official docs will help reduce confusion and GitHub issues related to infinite re-renders.

Environment

  • React version: 18.x (or whichever version is current)
  • Browser: Chrome 118
  • OS: Windows 11 / Ubuntu 22.04

Additional info

Several discussions online highlight this confusion; here’s one example:
https://www.reddit.com/r/reactjs/comments/oomo1w/what_are_the_biggest_issues_you_see_with_react_in/

Page

https://react.dev/reference/react/useEffect

Details

The warning could be moved closer to the main example or highlighted with a strong visual cue (e.g., bold text or a red caution box).
This would help prevent confusion among new React users who encounter infinite loop behavior.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la page de référence de useEffect liée dans l’issue et examinez comment les tableaux de dépendances et l’exemple principal sont actuellement expliqués. Rendez l’avertissement concernant la boucle infinie bien visible et ajoutez un exemple concis de mauvaise approche par rapport à une bonne approche, puis vérifiez que la page explique clairement le risque de mettre à jour l’état depuis un effet sans tableau de dépendances.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript, react
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
52/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.