• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1Samples Catalog
2=======
3
4A collection of sample apps that demonstrate how Flutter can be used.
5
6Each sample app is contained in a single `.dart` file located in the `lib`
7directory. To run each sample app, specify the corresponding file on the
8`flutter run` command line, for example:
9
10```
11flutter run lib/animated_list.dart
12flutter run lib/app_bar_bottom.dart
13flutter run lib/basic_app_bar.dart
14...
15```
16
17The apps are intended to be short and easily understood. Classes that represent
18the sample's focus are at the top of the file; data and support classes follow.
19
20Each sample app contains a comment (usually at the end) which provides some
21standard documentation that also appears in the web view of the catalog.
22See the "Generating..." section below.
23
24Generating the web view of the catalog
25---------
26
27Markdown and a screenshot of each app are produced by `bin/sample_page.dart`
28and saved in the `.generated` directory. The markdown file contains
29the text taken from the Sample Catalog comment found in the app's source
30file, followed by the source code itself.
31
32This `sample_page.dart` command line app must be run from the `examples/catalog`
33directory. It relies on templates also found in the bin directory, and it
34generates and executes `test_driver` apps to collect the screenshots:
35
36```
37cd examples/catalog
38dart bin/sample_page.dart
39```
40