[Suggestion]: Update useEffect cleanup example regarding mount
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 11
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the "Step 3: Add cleanup if needed" section on https://react.dev/learn/synchronizing-with-effects and reproduce the reported Strict Mode behavior using the examples in the issue. Update the example and explanation so readers understand when cleanup and remount behavior occurs, then verify the documented behavior against the examples.
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
- 42/100