History

Chris Bracken 0ee3f57a10 Build Flutter app as a framework on iOS (#8971 )

**THIS IS A BREAKING CHANGE.** See below for migration steps for
existing projects.

Previously, Flutter app code was built as a raw dylib on iOS.  Dynamic
libraries outside of a framework bundle are not supported on iOS, except
for the system Swift libraries provided by Xcode.

See:
https://developer.apple.com/library/content/technotes/tn2435/_index.html#//apple_ref/doc/uid/DTS40017543-CH1-TROUBLESHOOTING_BUNDLE_ERRORS-EMBEDDED__DYLIB_FILES

* Migrates Xcode build from app.dylib to App.framework
* Migrates flutter create template
* Migrates example projects

Migration steps for existing projects
=====================================

The following steps should be taken from the root of your Flutter
project:

1. Edit `ios/.gitignore`: add `/Flutter/App.framework` on a new line.
2. In the Xcode project navigator, remove `app.dylib` from the Flutter
   folder. Delete this file from the `ios/Flutter` directory in your project.
3. Run a build to generate `ios/Flutter/App.framework`. From the command
   line, run `flutter build ios`. If you have not configured app signing
   in Xcode, an alternative method is to open the simulator, then run
   `flutter run -d iP`.
4. In the Xcode project navigator, select the `Runner` project. In the
   project settings that are displayed in the main view, ensure that the
   `Runner` target is selected. You can verify this by exposing the
   sidebar using the [| ] icon in the upper-left corner of the main
   view.
5. Select the *General* tab in the project settings. Under the
   *Embedded Binaries* section, click '+' to add `App.framework`. In the
   sheet that drops down, click the *Add Other...* button. Navigate to
   the `ios/Flutter` directory and select `App.framework`. Click *Open*.
   In the sheet that drops down, select *Create folder references*, then
   click *Finish*.
6. In the project settings, verify that `App.framework` has been added to the
   *Embedded Binaries* and *Linked Frameworks and Libraries* lists.
7. In the Xcode project navigator, drag `App.framework` under the
   Flutter folder.
8. In the Xcode project navigator, select `Flutter` then from the
   *File* menu, select *Add Files to "Runner"...*. Navigate to the
   `ios/Flutter` directory, select `AppFrameworkInfo.plist` and click
   the *Add* button.
9. From the command line, in your project directory, run
   `flutter build clean`, then `flutter run`.

At this point your project should be fully migrated.

2017-03-22 17:41:49 -07:00

.idea

Revert back IntelliJ .iml file to project root (#8139 )

2017-02-14 18:15:26 +01:00

android

Remove old platform messaging API (#8837 )

2017-03-17 11:56:50 +01:00

ios

Build Flutter app as a framework on iOS (#8971 )

2017-03-22 17:41:49 -07:00

lib

Remove old platform messaging API (#8837 )

2017-03-17 11:56:50 +01:00

.gitignore

Merge hello_android into hello_services (#4366 )

2016-06-03 16:15:03 -07:00

hello_services.iml

Revert back IntelliJ .iml file to project root (#8139 )

2017-02-14 18:15:26 +01:00

pubspec.yaml

Add uses-material-design: true to pubspec.yaml in examples. (#8088 )

2017-02-14 13:47:43 +00:00

README.md

Remove obsolete references to "flutter refresh" in hello_services (#7093 )

2016-11-30 09:49:43 -08:00

README.md

Example of embedding Flutter using FlutterView

This project demonstrates how to embed Flutter within an iOS or Android application. On iOS, the iOS and Flutter components are built with Xcode. On Android, the Android and Flutter components are built with Android Studio or gradle.

You can read more about accessing platform and third-party services in Flutter.

iOS

Configure

Create an ios/Flutter/Generated.xcconfig file with this entry:

FLUTTER_ROOT=[absolute path to the Flutter SDK]

There are a number of other parameters you can control with this file:

FLUTTER_APPLICATION_PATH: The path to the directory that contains your pubspec.yaml file relative to your xcodeproj file.
FLUTTER_BUILD_MODE: Whether to build for debug, profile, or release. Defaults to release.
FLUTTER_TARGET: The path to your main.dart relative to your pubspec.yaml. Defaults to lib/main.dart.
FLUTTER_FRAMEWORK_DIR: The absolute path to the directory that contains Flutter.framework. Defaults to the ios-release version of Flutter.framework in the bin/cache directory of the Flutter SDK.

Build

Once you've configured your project, you can open ios/HelloServices.xcodeproj in Xcode and build the project as usual.

Android

Configure

Create an android/local.properties file with these entries:

sdk.dir=[path to the Android SDK]
flutter.sdk=[path to the Flutter SDK]

There are a number of other parameters you can control with this file:

flutter.buildMode: Whether to build for debug, profile, or release. Defaults to release.
flutter.jar: The path to flutter.jar. Defaults to the android-arm-release version of flutter.jar in the bin/cache directory of the Flutter SDK.

See android/app/build.gradle for project specific settings, including:

source: The path to the directory that contains your pubspec.yaml file relative to your build.gradle file.
target: The path to your main.dart relative to your pubspec.yaml. Defaults to lib/main.dart.

Build

To build directly with gradle, use the following commands:

cd android
gradle wrapper
./gradlew build

To build with Android Studio, open the android folder in Android Studio and build the project as usual.