Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Suggestion]: Update useEffect cleanup example regarding mount #7422

Open
LuckyT89 opened this issue Jan 10, 2025 · 0 comments
Open

[Suggestion]: Update useEffect cleanup example regarding mount #7422

LuckyT89 opened this issue Jan 10, 2025 · 0 comments

Comments

@LuckyT89
Copy link

LuckyT89 commented Jan 10, 2025

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant