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

docs: Remove unnecessary useEffect from tutorial code example #9561

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

nathggns
Copy link

@nathggns nathggns commented Jun 5, 2024

Using useEffect for syncing state with props (or other external state) is unnecessary, and can trigger additional renders and potentially flashes of incorrect content. We can use a useState to detect changes in order to trigger a sync.

This is explicitly allowed by React – https://react.dev/learn/you-might-not-need-an-effect#adjusting-some-state-when-a-prop-changes

While an in-depth tutorial of React is out of scope for Remix's tutorial, it remains the case that people look to projects like Remix for good examples – we ought to avoid effects where they aren't necessary (and are explicitly discouraged).

Using useEffect for syncing state with props (or other external state) is unnecessary, and can trigger additional renders and potentially flashes of incorrect content. We can use a useState to detect changes in order to trigger a sync. 

This is explicitly allowed by React – https://react.dev/learn/you-might-not-need-an-effect#adjusting-some-state-when-a-prop-changes
Copy link

changeset-bot bot commented Jun 5, 2024

⚠️ No Changeset found

Latest commit: c830a04

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Jun 5, 2024

Hi @nathggns,

Welcome, and thank you for contributing to Remix!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at [email protected].

Thanks!

- The Remix team

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Jun 5, 2024

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

@nathggns nathggns changed the title Remove unnecessary useEffect from tutorial code example docs: Remove unnecessary useEffect from tutorial code example Jun 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants