262f12b4a9
This converts all remaining "## Sample code" segments into snippets, and fixes the snippet generator to handle multiple snippets in the same dartdoc block properly. I also generated, compiled, and ran each of the existing application samples, and fixed them up to be more useful and/or just run without errors. This PR fixes these problems with examples: 1. Switching tabs in a snippet now works if there is more than one snippet in a single dartdoc block. 2. Generation of snippet code now works if there is more than one snippet. 3. Contrast of text and links in the code sample block has been improved to recommended levels. 4. Added five new snippet templates, including a "freeform" template to make it possible to show examples that need to change the app instantiation. 5. Fixed several examples to run properly, a couple by adding the "Scaffold" widget to the template, a couple by just fixing their code. 6. Fixed visual look of some of the samples when they run by placing many samples inside of a Scaffold. 7. In order to make it easier to run locally, changed the sample analyzer to remove the contents of the supplied temp directory before running, since having files that hang around is problematic (only a problem when running locally with the `--temp` argument). 8. Added a `SampleCheckerException` class, and handle sample checking exceptions more gracefully. 9. Deprecated the old "## Sample code" designation, and added enforcement for the deprecation. 10. Removed unnecessary `new` from templates (although they never appeared in the samples thanks to dartfmt, but still). Fixes #26398 Fixes #27411
Welcome to the Flutter API reference documentation.
Flutter is Google’s mobile UI framework for crafting high-quality native interfaces on iOS and Android in record time. Flutter works with existing code, is used by developers and organizations around the world, and is free and open source.
The API reference herein covers all libraries that are exported by the Flutter SDK.
More Documentation
This site hosts Flutter's API documentation. Other documentation can be found at the following locations:
- flutter.io (main site)
- Installation
- Codelabs
- Contributing to Flutter
Importing a Library
Framework Libraries
Libraries in the "Libraries" section below (or in the left navigation) are part
of the core Flutter framework and are imported using
'package:flutter/<library>.dart', like so:
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
Dart Libraries
Libraries in the "Dart" section exist in the 'dart:' namespace and are imported
using 'dart:<library>', like so:
import 'dart:async';
import 'dart:ui';
Except for 'dart:core', you must import a Dart library before you can use it.
Other Libraries
Libraries in other sections are supporting libraries that ship with Flutter.
They are organized by package and are imported using
'package:<package>/<library>.dart', like so:
import 'package:flutter_test/flutter_test.dart';
import 'package:file/local.dart';
Finding Other Libraries
Flutter has a rich community of packages that have been contributed by the open-source community. You can browse those packages at pub.dartlang.org