[Suggestion]: Update useEffect cleanup example regarding mount
Nessuno ha ancora preso questa issue.
- Lingua principale
- JavaScript
- Stelle
- 11.8k
- Fork
- 7.9k
- Merge medio
- 1g 11h
- PR unite (30g)
- 11
Descrizione
Summary
On the Synchronizing with Effects page under section "Step 3: Add cleanup if needed" it seems like the example should be updated along with adding some more explanation for how useEffect works when in Strict Mode.
Page
https://react.dev/learn/synchronizing-with-effects
Details
Consider the following code:
import { useEffect } from "react";
export default function App() {
return (
<div>
<h1>My App</h1>
<TestExample />
</div>
);
}
function TestExample() {
useEffect(() => {
console.log("run effect");
return () => {
console.log("cleanup");
};
}, []);
return <h2>Test example!</h2>;
}
From reading the documentation and the explanation for how components mount, unmount, and then mount again in Strict Mode I would expect this example to log "run effect", then log "cleanup", and then log "run effect". Instead it seems like the component is only mounting once and not doing the extra steps because it only logs "run effect" once and nothing else.
After experimenting and searching around, I think the issue is that React can tell that this component will never be unmounted so it does not bother with the extra steps of unmounting and remounting it in Strict Mode. Look at this updated example:
import { useEffect, useState } from "react";
export default function App() {
const [showTestExample, setShowTestExample] = useState(false);
return (
<div>
<h1>My App</h1>
<button onClick={() => setShowTestExample(!showTestExample)}>
Toggle TestExample
</button>
{showTestExample ? <TestExample /> : ""}
</div>
);
}
function TestExample() {
useEffect(() => {
console.log("run effect");
return () => {
console.log("cleanup");
};
}, []);
return <h2>Test example!</h2>;
}
Now the component can be toggled to render or be removed from the screen. It now behaves as expected- when clicking the button and adding the component, it console logs "run effect", then "cleanup", then "run effect". I am honestly not sure how the example given in the docs is working at all because it seems like that component will always be rendered. I think this behavior should be explained in the doc so readers can understand why sometimes they may see the mount/unmount/remount behavior and other times they may not. Please correct me if my understanding is wrong.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dalla sezione "Step 3: Add cleanup if needed" su https://react.dev/learn/synchronizing-with-effects e riproduci il comportamento segnalato di Strict Mode usando gli esempi nell’issue. Aggiorna l’esempio e la spiegazione in modo che i lettori comprendano quando si verifica il comportamento di cleanup e remount, quindi verifica il comportamento documentato rispetto agli esempi.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript, react
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 42/100