[Suggestion]: Update useEffect cleanup example regarding mount
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 11.8k
- Forks
- 7.9k
- Ø Merge
- 1 T. 11 Std.
- Gemergte PRs (30 T.)
- 11
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem Abschnitt "Step 3: Add cleanup if needed" auf https://react.dev/learn/synchronizing-with-effects und reproduziere das gemeldete Strict Mode-Verhalten anhand der Beispiele im Issue. Aktualisiere das Beispiel und die Erklärung, damit Leser verstehen, wann cleanup- und remount-Verhalten auftritt, und überprüfe anschließend das dokumentierte Verhalten anhand der Beispiele.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, react
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 42/100