Skip to content

fix(events): update events react example code #8330

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

Merged
merged 2 commits into from
Apr 23, 2025

Conversation

jjarvisp
Copy link
Member

Description of changes:

The purpose of this PR is to update the React code example for the Events API to use a React pattern that won't result in dangling subscriptions due to the 2x render of useEffect hooks when React.StrictMode is enabled. Also, updated JSX to use index for key as data.id is not unique across subsequent events as it references the subscription id not the event id.

Related GitHub issue #, if available:

aws-amplify/amplify-data#531

Instructions

If this PR should not be merged upon approval for any reason, please submit as a DRAFT

Which product(s) are affected by this PR (if applicable)?

  • amplify-cli
  • amplify-ui
  • amplify-studio
  • amplify-hosting
  • amplify-libraries

Which platform(s) are affected by this PR (if applicable)?

  • JS
  • Swift
  • Android
  • Flutter
  • React Native

Please add the product(s)/platform(s) affected to the PR title

Checks

  • Does this PR conform to the styleguide?

  • Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.

  • Are any files being deleted with this PR? If so, have the needed redirects been created?

  • Are all links in MDX files using the MDX link syntax rather than HTML link syntax?

    ref: MDX: [link](https://docs.amplify.aws/)
    HTML: <a href="https://docs.amplify.aws/">link</a>

When this PR is ready to merge, please check the box below

  • Ready to merge

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@jjarvisp jjarvisp marked this pull request as ready for review April 18, 2025 16:03
@jjarvisp jjarvisp requested a review from josefaidt as a code owner April 18, 2025 16:03
calebpollman
calebpollman previously approved these changes Apr 18, 2025
@jjarvisp jjarvisp closed this Apr 23, 2025
@jjarvisp jjarvisp reopened this Apr 23, 2025
@jjarvisp jjarvisp merged commit 41a42b2 into main Apr 23, 2025
16 checks passed
@jjarvisp jjarvisp deleted the james/chore/update-event-docs branch April 23, 2025 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants