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

chore: specify RN peer dep version when installing Amplify UI RN package #8212

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

tiffanynwyeung
Copy link
Member

@tiffanynwyeung tiffanynwyeung commented Jan 22, 2025

Description of changes:

The @aws-amplify/ui-react-native package requires a specific peer dependency version of react-native-safe-area-context@^4.2.5. This is mentioned in the UI library docs but not in here as well. Failure to pin the dependency version results in a dependency resolution error as it attempts to install a newer version of the package that conflicts with the UI React Native package.

Related GitHub issue #, if available:

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.

@@ -2761,9 +2761,7 @@ const App = () => {
return (
<Authenticator.Provider>
<Authenticator>
<SafeAreaView>
Copy link
Member Author

@tiffanynwyeung tiffanynwyeung Jan 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please note that SafeAreaView is removed here because the Authenticator UI component has safe area handling included in its implementation, making this call unnecessary.

(Specifically, the component uses SafeAreaProvider and the useSafeAreaInsets hook as recommended by the React Navigation team.)

Copy link
Member

@jordanvn jordanvn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me. This pinned dep version is already specified as such in the UI library docs for RN.

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.

3 participants