diff --git a/docs/integration-with-android-fragment.md b/docs/integration-with-android-fragment.md new file mode 100644 index 00000000000..8f3aae0a244 --- /dev/null +++ b/docs/integration-with-android-fragment.md @@ -0,0 +1,168 @@ +--- +id: integration-with-existing-apps +title: Integration with an Android Fragment +--- + +The guide for [Integration with Existing Apps](https://reactnative.dev/docs/integration-with-existing-apps) details how to integrate a full-screen React Native app into an existing Android app as an Activity. To use React Native components within Fragments in an existing app requires some additional setup. The benefit of this is that it allows for a native app to integrate React Native components alongside native fragments in an Activity. + +### 1. Add React Native to your app + +Follow the guide for [Integration with Existing Apps](https://reactnative.dev/docs/integration-with-existing-apps) until the Code integration section. Continue to follow Step 1. Create an `index.android.js` file and Step 2. Add your React Native code from this section. + +### 2. Integrating your App with a React Native Fragment + +You can render your React Native component into a Fragment instead of a full screen React Native Activity. The component may be termed a "screen" or "fragment" and it will function in the same manner as an Android fragment, likely containing child components. These components can be placed in a `/fragments` folder and the child components used to compose the fragment can be placed in a `/components` folder. + +You will need to implement the ReactApplication interface in your main Application Java class. If you have created a new project from Android Studio with a default activity, you will need to create a new class e.g. `MyReactApplication.java`. If it is an existing class you can find this main class in your `AndroidManifest.xml` file. Under the `` tag you should see a property `android:name` e.g. `android:name=".MyReactApplication"`. This value is the class you want to implement and provide the required methods to. + +Ensure your main Application Java class implements ReactApplication: + +```java +public class MyReactApplication extends Application implements ReactApplication {...} +``` + +Override the required methods `getUseDeveloperSupport`, `getPackages` and `getReactNativeHost`: + +```java +public class MyReactApplication extends Application implements ReactApplication { + @Override + public void onCreate() { + super.onCreate(); + SoLoader.init(this, false); + } + + private final ReactNativeHost mReactNativeHost = new ReactNativeHost(this) { + @Override + public boolean getUseDeveloperSupport() { + return BuildConfig.DEBUG; + } + + protected List getPackages() { + List packages = new PackageList(this).getPackages(); + // Packages that cannot be autolinked yet can be added manually here + return packages; + } + }; + + @Override + public ReactNativeHost getReactNativeHost() { + return mReactNativeHost; + } +} +``` + +If you are using Android Studio, use Alt + Enter to add all missing imports in your class. Alternatively these are the required imports to include manually: + +```java +import android.app.Application; + +import com.facebook.react.PackageList; +import com.facebook.react.ReactApplication; +import com.facebook.react.ReactNativeHost; +import com.facebook.react.ReactPackage; +import com.facebook.soloader.SoLoader; + +import java.util.List; +``` + +Perform a "Sync Project files with Gradle" operation. + +### Step 3. Add a FrameLayout for the React Native Fragment + +You will now add your React Native Fragment to an Activity. For a new project this Activity will be `MainActivity` but it could be any Activity and more fragments can be added to additional Activities as you integrate more React Native components into your app. + +First add the React Native Fragment to your Activity's layout. For example `main_activity.xml` in the `res/layouts` folder. + +Add a `` with an id, width and height. This is the layout you will find and render your React Native Fragment into. + +```xml + +``` + +### Step 4. Add a React Native Fragment to the FrameLayout + +To add your React Native Fragment to your layout you need to have an Activity. As mentioned in a new project this will be `MainActivity`. In this Activity add a button and an event listener. On button click you will render your React Native Fragment. + +Modify your Activity layout to add the button: + +```xml +