The Android Studio IDE can help integrate your Flutter module. Using Android Studio, you can edit both your Android and Flutter code in the same IDE.

You can also use IntelliJ Flutter plugin functionality like Dart code completion, hot reload, and widget inspector.

To build your app, the Android Studio plugin configures your Android project to add your Flutter module as a dependency.

1. Open your Android project in Android Studio.

2. Go toFile >New >New Project.... TheNew Project dialog displays.

3. ClickFlutter.

4. If asked to provide yourFlutter SDK path, do so and clickNext.

5. Complete the configuration of your Flutter module.

   • If you have an existing project:

     1. To choose an existing project, click... to the right of theProject location box.
     2. Navigate to your Flutter project directory.
     3. ClickOpen.

   • If you need to create a new Flutter project:

     1. Complete the configuration dialog.
     2. In theProject type menu, selectModule.

6. ClickFinish.

To integrate a Flutter module with an existing Android app manually, without using Flutter's Android Studio plugin, follow these steps:

Assuming that you have an existing Android app atsome/path/MyApp, and that you want your Flutter project as a sibling, do the following:

cd some/path/flutter create -t module --org com.example flutter_module

This creates asome/path/flutter_module/ Flutter module project with some Dart code to get you started and a.android/ hidden subfolder. The.android folder contains an Android project that can both help you run a barebones standalone version of your Flutter module withflutter run and it's also a wrapper that helps bootstrap the Flutter module an embeddable Android library.

Flutter requires your project to declare compatibility with Java 17 or later.

Before attempting to connect your Flutter module project to your host Android app, ensure that your host Android app declares the following source compatibility within your app'sbuild.gradle file, under theandroid { } block.

android{// ...compileOptions{sourceCompatibility=JavaVersion.VERSION_17// The minimum valuetargetCompatibility=JavaVersion.VERSION_17// The minimum value}// ...}

Starting with Gradle 7, Android recommends using centralized repository declarations insettings.gradle instead of project or module level declarations inbuild.gradle files.

Before attempting to connect your Flutter module project to your host Android app, make the following changes to your host app:

1. Remove therepositories block in all of your app'sbuild.gradle files.

   groovy

   // Remove the following block, starting on the next linerepositories{google()mavenCentral()}// ...to the previous line

   content_copy

2. Add thedependencyResolutionManagement displayed in this step to thesettings.gradle file.

dependencyResolutionManagement{repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)valstorageUrl:String=System.getenv("FLUTTER_STORAGE_BASE_URL")?:"https://storage.googleapis.com"repositories{google()mavenCentral()maven("$storageUrl/download.flutter.io")}}

dependencyResolutionManagement{repositoriesMode=RepositoriesMode.PREFER_SETTINGSStringstorageUrl=System.env.FLUTTER_STORAGE_BASE_URL?:"https://storage.googleapis.com"repositories{google()mavenCentral()maven{url=uri("$storageUrl/download.flutter.io")}}}

This option packages your Flutter library as a generic local Maven repository composed of AARs and POMs artifacts. This option allows your team to build the host app without installing the Flutter SDK. You can then distribute the artifacts from a local or remote repository.

Let's assume you built a Flutter module atsome/path/flutter_module, and then run:

cd some/path/flutter_moduleflutter build aar

Then, follow the on-screen instructions to integrate.

More specifically, this command creates (by default all debug/profile/release modes) alocal repository, with the following files:

To depend on the AAR, the host app must be able to find these files.

To do that, editsettings.gradle in your host app so that it includes the local repository and the dependency:

dependencyResolutionManagement{repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)repositories{google()mavenCentral()maven("https://storage.googleapis.com/download.flutter.io")maven(url="<some/path/flutter_module>/build/host/outputs/repo")}}

dependencyResolutionManagement{repositoriesMode=RepositoriesMode.PREFER_SETTINGSrepositories{google()mavenCentral()​// Add the new repositories starting on the next line...maven{url=uri("<some/path/flutter_module>/build/host/outputs/repo")// This is relative to the location of the build.gradle file// if using a relative path.}​maven{url=uri("https://storage.googleapis.com/download.flutter.io")}// ...to before this line}}

After anaar build of a Kotlin DSL-based Android project, follow these steps to add the flutter_module.

Include the flutter module as a dependency in the host app'sapp/build.gradle file.

android{buildTypes{release{...}debug{...}create("profile"){initWith(getByName("debug"))}}​dependencies{// ...debugImplementation("com.example.flutter_module:flutter_debug:1.0")releaseImplementation("com.example.flutter_module:flutter_release:1.0")add("profileImplementation","com.example.flutter_module:flutter_profile:1.0")}

Add the customprofileImplementation dependency configuration to the end of the same app-level build.gradle file.

configurations{getByName("profileImplementation"){}}

lightbulbTip

You can also build an AAR for your Flutter module in Android Studio using theBuild > Flutter > Build AAR menu.

This option enables a one-step build for both your Android project and Flutter project. This option is convenient when you work on both parts simultaneously and rapidly iterate, but your team must install the Flutter SDK to build the host app.

Include the Flutter module as a subproject in the host app'ssettings.gradle. This example assumesflutter_module andMyApp exist in the same directory

If you are using Kotlin, apply the following changes:

// Include the host app project. Assumed existing content.include(":app")// Replace "flutter_module" with whatever package_name you supplied when you ran:// `$ flutter create -t module [package_name]valfilePath=settingsDir.parentFile.toString()+"/flutter_module/.android/include_flutter.groovy"apply(from=File(filePath))

// Include the host app project.include(":app")// assumed existing contentsetBinding(newBinding([gradle:this]))// newdeffilePath=settingsDir.parentFile.toString()+"/flutter_module/.android/include_flutter.groovy"// newapplyfrom:filePath// new

Introduce animplementation dependency on the Flutter module from your app:

dependencies{implementation(project(":flutter"))}