[Bug]: Documentation for hooks: warning about infinite loop useEffect with state update is not prominent
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- JavaScript
- Estrellas
- 11.8k
- Forks
- 7.9k
- Merge medio
- 1 d 11 h
- PR fusionados (30 d)
- 11
Descripción
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
useEffectsection, 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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza por la página de referencia de useEffect enlazada en el issue y revisa cómo se explican actualmente los arrays de dependencias y el ejemplo principal. Haz que la advertencia sobre el bucle infinito destaque y añade un ejemplo conciso de mal enfoque frente a buen enfoque; después, verifica que la página explique claramente el riesgo de actualizar el estado desde un efecto sin un array de dependencias.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript, react
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bien especificado
- Aptitud para principiantes
- 52/100