- System requirements
- Create a Flutter module
- Embed the Flutter module in your existing application
Flutter can be incrementaly added into your existing iOS application as embedded frameworks.
Create a Flutter module
To embed Flutter into your existing application, first create a Flutter module.
From the command line, run:
cd some/path/ flutter create --template module my_flutter
A Flutter module project is created at
From that directory, you can run the same
commands you would in any other Flutter project,
flutter run --debug or
flutter build ios.
You can also run the module in
Android Studio/IntelliJ or VS Code with
the Flutter and Dart plugins. This project contains a
single-view example version of your module before it’s
embedded in your existing application,
which is useful for incrementally
testing the Flutter-only parts of your code.
my_flutter module directory structure is similar to a
normal Flutter application:
my_flutter/ ├── .ios/ │ ├── Runner.xcworkspace │ └── Flutter/podhelper.rb ├── lib/ │ └── main.dart ├── test/ └── pubspec.yaml
Add your Dart code to the
Add Flutter dependencies to
including Flutter packages and plugins.
.ios/ hidden subfolder contains an Xcode workspace where
you can run a standalone version of your module.
It is a wrapper project to bootstrap your Flutter code,
and contains helper scripts to facilitate building frameworks or
embedding the module into your existing application with CocoaPods.
Embed the Flutter module in your existing application
There are two ways to embed Flutter in your existing application.
- Use the CocoaPods dependency manager and installed Flutter SDK. (Recommended.)
- Create frameworks for the Flutter engine, your compiled Dart code, and all Flutter plugins. Manually embed the frameworks, and update your existing application’s build settings in Xcode.
Using Flutter increases your app size.
Option A - Embed with CocoaPods and the Flutter SDK
This method requires every developer working on your project to have a locally installed version of the Flutter SDK. Simply build your application in Xcode to automatically run the script to embed your Dart and plugin code. This allows rapid iteration with the most up-to-date version of your Flutter module without running additional commands outside of Xcode.
The following example assumes that your existing application and the Flutter module are in sibling directories. If you have a different directory structure, you may need to adjust the relative paths.
some/path/ ├── my_flutter/ │ └── .ios/ │ └── Flutter/ │ └── podhelper.rb └── MyApp/ └── Podfile
If your existing application (
already have a Podfile, follow the
CocoaPods getting started guide
to add a
Podfile to your project.
Add the following lines to your
flutter_application_path = '../my_flutter' load File.join(flutter_application_path, '.ios', 'Flutter', 'podhelper.rb')
For each Podfile target that needs to embed Flutter, call
target 'MyApp' do install_all_flutter_pods(flutter_application_path) end
podhelper.rb script embeds your plugins,
App.framework into your project.
Your app’s Debug and Release build configurations embed the Debug or Release build modes of Flutter, respectively. Add a Profile build configuration to your app to test in profile mode.
MyApp.xcworkspace in Xcode.
You can now build the project using
Option B - Embed frameworks in Xcode
Alternatively, you can generate the necessary frameworks
and embed them in your application by manually editing
your existing Xcode project. You may do this if members of your
team can’t locally install Flutter SDK and CocoaPods,
or if you don’t want to use CocoaPods
as a dependency manager in your existing applications.
You must run
flutter build ios-framework
every time you make code changes in your Flutter module.
If you’re using the previous Embed with CocoaPods and Flutter tools method, you can skip these instructions.
The following example assumes that you want to generate the
flutter build ios-framework --output=some/path/MyApp/Flutter/
some/path/MyApp/ └── Flutter/ ├── Debug/ │ ├── Flutter.framework │ ├── App.framework │ ├── FlutterPluginRegistrant.framework (only if you have plugins with iOS platform code) │ └── example_plugin.framework (each plugin is a separate framework) ├── Profile/ │ ├── Flutter.framework │ ├── App.framework │ ├── FlutterPluginRegistrant.framework │ └── example_plugin.framework └── Release/ ├── Flutter.framework ├── App.framework ├── FlutterPluginRegistrant.framework └── example_plugin.framework
Embed and link the generated frameworks into your existing application in Xcode. There are multiple ways to do this—use the method that is best for your project.
Link on the frameworks
For example, you can drag the frameworks from
some/path/MyApp/Flutter/Release/ in Finder
into your targets’ build
settings > Build Phases > Link Binary With Libraries.
In the target’s build settings, add
to the Framework Search Paths (
Embed the frameworks
The generated dynamic frameworks must be embedded into your app to be loaded at runtime.
For example, you can drag the framework
FlutterPluginRegistrant and any other
static frameworks) from your application’s Frameworks group
into your targets’ build settings > Build Phases >
Then, select Embed & Sign from the drop-down list.
You should now be able to build the project in Xcode using
Option C - Embed application and plugin frameworks in Xcode and Flutter framework with CocoaPods
Alternatively, instead of distributing the large Flutter.framework
to other developers, machines, or continuous integration systems,
you can instead generate Flutter as CocoaPods podspec by adding
--cocoapods. This produces a
instead of an engine Flutter.framework.
The App.framework and plugin frameworks are generated
as described in Option B.
flutter build ios-framework --cocoapods --output=some/path/MyApp/Flutter/
some/path/MyApp/ └── Flutter/ ├── Debug/ │ ├── Flutter.podspec │ ├── App.framework │ ├── FlutterPluginRegistrant.framework │ └── example_plugin.framework (each plugin with iOS platform code is a separate framework) ├── Profile/ │ ├── Flutter.podspec │ ├── App.framework │ ├── FlutterPluginRegistrant.framework │ └── example_plugin.framework └── Release/ ├── Flutter.podspec ├── App.framework ├── FlutterPluginRegistrant.framework └── example_plugin.framework
Host apps using CocoaPods can add Flutter to their Podfile:
pod 'Flutter', :podspec => 'some/path/MyApp/Flutter/[build mode]/Flutter.podspec'
Embed and link the generated App.framework, FlutterPluginRegistrant.framework, and any plugin frameworks into your existing application as described in Option B.
You can now add a Flutter screen to your existing application.