5
5
A collection of open source samples that illustrate best practices for
6
6
[ Flutter] ( https://flutter.dev ) .
7
7
8
- ## Visual samples index
9
-
10
- The easiest way to browse through the samples in this repo (as well as a few others!)
11
- is the [ visual samples index] ( https://flutter.github.io/samples ) .
12
-
13
- ## Tip: minimize download size
14
-
15
- As this repository is quite big, you can use svn to download a single example.
8
+ ## Index
9
+
10
+ ### Quickstarts
11
+
12
+ * [ ` asset_transformation ` ] [ ]
13
+ * [ ` background_isolate_channels ` ] [ ]
14
+ * [ ` code_sharing ` ] [ ]
15
+ * [ ` context_menus ` ] [ ]
16
+ * [ ` desktop_photo_search ` ] [ ]
17
+ * [ ` dynamic_theme ` ] [ ]
18
+ * [ ` form_app ` ] [ ]
19
+ * [ ` game_template ` ] [ ]
20
+ * [ ` gemini_tasks ` ] [ ]
21
+ * [ ` google_maps ` ] [ ]
22
+ * [ ` infinite_list ` ] [ ]
23
+ * [ ` isolate_example ` ] [ ]
24
+ * [ ` navigation_and_routing ` ] [ ]
25
+ * [ ` platform_design ` ] [ ]
26
+ * [ ` provider_counter ` ] [ ]
27
+ * [ ` provider_shopper ` ] [ ]
28
+ * [ ` simple_shader ` ] [ ]
29
+ * [ ` simplistic_calculator ` ] [ ]
30
+ * [ ` simplistic_editor ` ] [ ]
31
+ * [ ` testing_app ` ] [ ]
32
+ * [ ` web_embedding ` ] [ ]
33
+
34
+ ### Native platform samples
35
+
36
+ * [ ` add-to-app ` ] [ ] - Collection of samples that demonstrate embedding Flutter a view into a native app.
37
+ * [ ` fullscreen ` ] [ ] — Embeds a full screen instance of
38
+ Flutter into an existing iOS or Android app.
39
+ * [ ` prebuilt_module ` ] [ ] — Embeds a full screen
40
+ instance of Flutter as a prebuilt library that can be loaded into an existing
41
+ iOS or Android app.
42
+ * [ ` plugin ` ] [ ] — Embeds a full screen Flutter instance that
43
+ is using plugins into an existing iOS or Android app.
44
+ * [ ` books ` ] [ ] — Mimics a real world use-case of embedding Flutter into an
45
+ existing Android app and demonstrates using
46
+ [ Pigeon] ( https://pub.dev/packages/pigeon ) to communicate between Flutter and
47
+ the host application.
48
+ * [ ` multiple_flutters ` ] [ ] — Shows the usage of the Flutter
49
+ Engine Group APIs to embed multiple instances of Flutter into an existing app
50
+ with low memory cost.
51
+ * [ ` android_view ` ] [ ] — Shows how to integrate a Flutter
52
+ add-to-app module at a view level for Android.
53
+ * [ ` android_splash_screen ` ] [ ]
54
+ * [ ` ios_app_clip ` ] [ ]
55
+ * [ ` platform_channels ` ] [ ]
56
+ * [ ` platform_view_swift ` ] [ ]
57
+
58
+ ### Demo galleries
59
+
60
+ * [ ` animations ` ] [ ] - Showcases Flutter's animation features
61
+ * [ ` material_3_demo ` ] [ ] -
62
+
63
+ ### Demo apps
64
+
65
+ * [ ` compass_app ` ] [ ]
66
+ * [ ` deeplink_store_example ` ] [ ]
67
+ * [ ` veggie_seasons ` ] [ ]
68
+
69
+ [ `asset_transformation` ] : ./asset_transformation
70
+ [ `background_isolate_channels` ] : ./background_isolate_channels
71
+ [ `code_sharing` ] : ./code_sharing
72
+ [ `context_menus` ] : ./context_menus
73
+ [ `desktop_photo_search` ] : ./desktop_photo_search
74
+ [ `dynamic_theme` ] : ./dynamic_theme
75
+ [ `form_app` ] : ./form_app
76
+ [ `game_template` ] : ./game_template
77
+ [ `gemini_tasks` ] : ./gemini_tasks
78
+ [ `google_maps` ] : ./google_maps
79
+ [ `infinite_list` ] : ./infinite_list
80
+ [ `isolate_example` ] : ./isolate_example
81
+ [ `navigation_and_routing` ] : ./navigation_and_routing
82
+ [ `platform_design` ] : ./platform_design
83
+ [ `provider_counter` ] : ./provider_counter
84
+ [ `provider_shopper` ] : ./provider_shopper
85
+ [ `simple_shader` ] : ./simple_shader
86
+ [ `simplistic_calculator` ] : ./simplistic_calculator
87
+ [ `simplistic_editor` ] : ./simplistic_editor
88
+ [ `testing_app` ] : ./testing_app
89
+ [ `web_embedding` ] : ./web_embedding
90
+ [ `add-to-app` ] : ./add_to_app
91
+ [ `fullscreen` ] : ./add_to_app/fullscreen
92
+ [ `prebuilt_module` ] : ./add_to_app/prebuilt_module
93
+ [ `plugin` ] : ./add_to_app/plugin
94
+ [ ` books ` ] : ./add_to_app/books
95
+ [ `multiple_flutters` ] : ./add_to_app/multiple_flutters
96
+ [ `android_view` ] : ./add_to_app/android_view
97
+ [ `android_splash_screen` ] : ./android_splash_screen
98
+ [ `ios_app_clip` ] : ./ios_app_clip
99
+ [ `platform_channels` ] : ./platform_channels
100
+ [ `platform_view_swift` ] : ./platform_view_swift
101
+ [ `animations` ] : ./animations
102
+ [ `material_3_demo` ] : ./material_3_demo
103
+ [ `compass_app` ] : ./compass_app
104
+ [ `deeplink_store_example` ] : ./deeplink_store_example
105
+ [ `veggie_seasons` ] : ./veggieseasons
106
+
107
+
108
+ ## Flutter sample code
109
+
110
+ Samples are ** correct and concise code** that developers
111
+ can ** quickly understand** and ** easily reuse** with minimal side effects.
112
+ Samples teach developers how to be successful using Flutter and Dart.
113
+ They are maintained on an ongoing basis
114
+ to reflect changing APIs and best practices.
115
+
116
+ ### Types of samples
117
+
118
+ There are two types of sample code in this repository:
119
+
120
+ * ** Quickstarts** provide a starting point to extend. They answer the question,
121
+ "What is the minimal amount of code needed to implement this feature?"
122
+ * ** Demo apps** are meant to be built and ran. They demo the _ product_ ,
123
+ not how to write code.
124
+
125
+ A majority of samples in this repository are quickstarts.
126
+
127
+ ## Usage
128
+
129
+ Every sample in this repo is fully runnable. To run an example,
130
+ use ` flutter run ` inside that example's directory.
131
+ See the [ getting started guide] ( https://docs.flutter.dev/get-started/install )
132
+ to install the ` flutter ` tool.
133
+
134
+ > [ !IMPORTANT]
135
+ > If you want to run an add-to-app sample, there are additional requirements.
136
+ > We suggest reading the [ add-to-app documentation] ( https://docs.flutter.dev/add-to-app ) .
137
+
138
+ ### Tip: minimize download size
139
+
140
+ As this repository is quite big, you can use
141
+ [ svn] ( https://subversion.apache.org/ ) to download a single example.
16
142
For example:
17
143
18
144
```
@@ -38,7 +164,7 @@ If you have a general question about one of these samples or how to adapt its
38
164
techniques for one of your own apps, try one of these resources:
39
165
40
166
* [ The FlutterDev Discord] ( https://discord.gg/rflutterdev )
41
- * [ StackOverflow ] ( https://stackoverflow. com/questions/tagged/flutter )
167
+ * [ The Flutter Community forum ] ( https://forum.itsallwidgets. com/latest )
42
168
43
169
If you run into a bug in one of the samples, please file an issue in the
44
170
[ ` flutter/samples ` issue tracker] ( https://github.com/flutter/samples/issues ) .
0 commit comments