• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Templates for Flutter Module
2
3## common
4
5Written to root of Flutter application.
6
7Adds Dart project files including `pubspec.yaml`.
8
9## android
10
11#### library
12
13Written to the `.android/` hidden folder.
14
15Contents wraps Flutter/Dart code as a Gradle project that defines an
16Android library.
17
18Executing `./gradlew flutter:assembleDebug` in that folder produces
19a `.aar` archive.
20
21Android host apps can set up a dependency to this project to consume
22Flutter views.
23
24#### gradle
25
26Written to `.android/` or `android/`.
27
28Mixin for adding Gradle boilerplate to Android projects.
29
30#### host_app_common
31
32Written to either `.android/` or `android/`.
33
34Contents define a single-Activity, single-View Android host app
35with a dependency on the `.android/Flutter` library.
36
37Executing `./gradlew app:assembleDebug` in the target folder produces
38an `.apk` archive.
39
40Used with either `android_host_ephemeral` or `android_host_editable`.
41
42#### host_app_ephemeral
43
44Written to `.android/` on top of `android_host_common`.
45
46Combined contents define an *ephemeral* (hidden, auto-generated,
47under Flutter tooling control) Android host app with a dependency on the
48`.android/Flutter` library.
49
50#### host_app_editable
51
52Written to `android/` on top of `android_host_common`.
53
54Combined contents define an *editable* (visible, one-time generated,
55under app author control) Android host app with a dependency on the
56`.android/Flutter` library.
57
58## ios
59
60#### library
61
62Written to the `.ios/Flutter` hidden folder.
63
64Contents wraps Flutter/Dart code for consumption by an Xcode project.
65
66iOS host apps can set up a dependency to this contents to consume
67Flutter views.
68
69#### host_app_ephemeral
70
71Written to `.ios/` outside the `Flutter/` sub-folder.
72
73Combined contents define an *ephemeral* (hidden, auto-generated,
74under Flutter tooling control) iOS host app with a dependency on the
75`.ios/Flutter` folder contents.
76
77The host app does not make use of CocoaPods, and is therefore
78suitable only when the Flutter part declares no plugin dependencies.
79
80#### host_app_ephemeral_cocoapods
81
82Written to `.ios/` on top of `host_app_ephemeral`.
83
84Adds CocoaPods support.
85
86Combined contents define an ephemeral host app suitable for when the
87Flutter part declares plugin dependencies.
88