Skip to content

Latest commit

 

History

History
152 lines (98 loc) · 6.55 KB

enable-apps.md

File metadata and controls

152 lines (98 loc) · 6.55 KB
Raw

../README.md#Guides

Enable the New Architecture for Apps

This page will help you create or migrate a React Native app that uses the New Architecture.

Warning

If you're using Expo or plan to use Expo, you can't enable the New Architecture at the moment and will have to wait for a future release of the Expo SDK.

Prerequisites

  1. Use or upgrade to the latest React Native version. This guide is written with the expectation that you’re using the latest React Native release.
  2. If you previously installed a global react-native-cli package, please remove it as it may cause unexpected issues:
  npm uninstall -g react-native-cli @react-native-community/cli
  1. Enable Hermes. If you are using React Native 0.70 or above, it is already the default JS engine so no action is needed.

Create a React Native app

If you are creating a new app to enable the New Architecture, follow all the steps in Setting up the development environment section under the React Native CLI Quickstart tab.

If following the setup guide, stop when you reach the section Running your React Native Application, and resume following this guide.

Then, create a new React Native project from the template:

npx react-native@latest init AwesomeProject --skip-install
cd AwesomeProject
yarn install

Enable New Architecture for iOS

For new apps created from React Native CLI

Navigate to the ios directory and run the following:

# from `ios` directory
bundle install && RCT_NEW_ARCH_ENABLED=1 bundle exec pod install

Then build and run the app as usual:

yarn ios

For existing apps

You'll need to reinstall your pods by running pod install with the right flag:

# Run pod install with the flag:
RCT_NEW_ARCH_ENABLED=1 bundle exec pod install

Troubleshooting

Run pod install when a dependency with native code changes

You will need to run pod install each time a dependency with native code changes. Make this command easier to run by adding it to scripts to your project's package.json file:

  "scripts": {
    "pod-install": "RCT_NEW_ARCH_ENABLED=1 bundle exec pod install"
  }

and run it with yarn pod-install. Note that bundle install does not need to run a second time, as long as the Gemfile has not changed.

Use Xcode to rename files in the ios folder

Whenever you have to rename some files in the ios folder, please use Xcode to rename them. This ensure that the file references are updated in the Xcode project as well. You might need to clean the build folder (Project → Clean Build Folder or Cmd ⌘ + Shift ⇪ + K) before re-building the app. If the file is renamed outside of Xcode, you may need to click on the old .m file reference and Locate the new file.

react-native run-ios fails

If you see a build failure from react-native run-ios, there may be cached files from a previous build with the old architecture. Clean the build cache and try again:

  1. Open the project ios/project.xcworkspace in Xcode
  2. In XCode, choose Product > Clean Build Folder
  3. In the project directory, remove the ios/Podfile.lock file and ios/Pods directory: rm -rf ios/Podfile.lock ios/Pods
  4. Re-run yarn pod-install and yarn ios

Enable the New Architecture on Android

Note

You may notice longer build times with the New Architecture due to additional step of C++ compilation with the Android NDK. To improve your build time, see Speeding Up Your Build Phase.

For new apps created from React Native CLI

Set the newArchEnabled property to true by either:

  • Changing the corresponding line in android/gradle.properties
  • Setting the environment variable ORG_GRADLE_PROJECT_newArchEnabled=true

Then build and run the app as usual:

yarn android

For existing apps

You will only need to update your android/gradle.properties file as follows:

# Use this property to enable support to the new architecture.
# This will allow you to use TurboModules and the Fabric render in
# your application. You should enable this flag either if you want
# to write custom TurboModules/Fabric components OR use libraries that
# are providing them.
-newArchEnabled=false
+newArchEnabled=true

Verify the New Architecture is in Use

After you build and run the app when Metro serves the JavaScript bundle, you should see "fabric": true in the Metro logs:

Metro shows fabric: true

[Advanced] Handling custom Native Components

If you followed the previous steps but your app uses some custom Native Components that have not been migrated to the New Architecture completely, you are going to see some reddish/pinkish boxes saying that the component is not compatible with Fabric. This is happening because custom Native Components written for the legacy architecture can't run as-is in the New Architecture.

Starting from React Native 0.72.0, we worked on a interoperability layer to let you use legacy components in the New Architecture without having to wait for them to be migrated.

You can read more about the interoperability layer and how to use it here. Follow the guide to register your components and then rerun your app with the commands with either npm or yarn

# To run android
npm/yarn run android

# To run iOS
npm/yarn run ios

Want to Know More?

If you'd like to view the code changes relevant to the New Architecture, take a look at the upgrade helper from version 0.67.4 to 0.68.0. Files that were added for the New Architecture are marked with a yellow banner.

Important

This documentation is still experimental and details are subject to changes as we iterate. Feel free to share your feedback on this discussion.

Moreover, it contains several manual steps. Please note that this won't be representative of the final developer experience once the New Architecture is stable. We're working on tools, templates and libraries to help you get started fast on the New Architecture, without having to go through the whole setup.