2020-05-11 19:10:02 +00:00
|
|
|
**Welcome to the Flutter API reference documentation!**
|
2018-11-12 06:36:47 +00:00
|
|
|
|
2020-05-11 19:10:02 +00:00
|
|
|
Flutter is Google's SDK for crafting beautiful, fast user experiences for
|
2020-07-23 01:23:47 +00:00
|
|
|
mobile, web, and desktop from a single codebase. Flutter works with existing
|
2020-05-11 19:10:02 +00:00
|
|
|
code, is used by developers and organizations around the world, and is free
|
|
|
|
|
and open source.
|
2018-03-30 19:19:44 +00:00
|
|
|
|
2020-05-11 19:10:02 +00:00
|
|
|
This API reference covers all libraries that are exported by the Flutter
|
2018-11-12 06:36:47 +00:00
|
|
|
SDK.
|
|
|
|
|
|
|
|
|
|
### More Documentation
|
2018-03-30 19:19:44 +00:00
|
|
|
|
2018-11-08 17:00:47 +00:00
|
|
|
This site hosts Flutter's API documentation. Other documentation can be found at
|
|
|
|
|
the following locations:
|
|
|
|
|
|
2019-03-20 21:42:46 +00:00
|
|
|
* [flutter.dev](https://flutter.dev) (main site)
|
|
|
|
|
* [Installation](https://flutter.dev/docs/get-started/install)
|
|
|
|
|
* [Codelabs](https://flutter.dev/docs/codelabs)
|
2018-11-08 17:00:47 +00:00
|
|
|
* [Contributing to Flutter](https://github.com/flutter/flutter/blob/master/CONTRIBUTING.md)
|
2018-11-12 06:36:47 +00:00
|
|
|
|
|
|
|
|
### 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:
|
|
|
|
|
|
|
|
|
|
```dart
|
|
|
|
|
import 'package:flutter/material.dart';
|
|
|
|
|
import 'package:flutter/services.dart';
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
#### Dart Libraries
|
|
|
|
|
|
2020-05-11 19:10:02 +00:00
|
|
|
Libraries in the "Dart" section exist in the `dart:` namespace and are imported
|
2018-11-12 06:36:47 +00:00
|
|
|
using `'dart:<library>'`, like so:
|
|
|
|
|
|
|
|
|
|
```dart
|
|
|
|
|
import 'dart:async';
|
|
|
|
|
import 'dart:ui';
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Except for `'dart:core'`, you must import a Dart library before you can use it.
|
|
|
|
|
|
2020-05-11 19:10:02 +00:00
|
|
|
#### Supporting Libraries
|
2018-11-12 06:36:47 +00:00
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
|
|
|
|
|
```dart
|
|
|
|
|
import 'package:flutter_test/flutter_test.dart';
|
|
|
|
|
import 'package:file/local.dart';
|
|
|
|
|
```
|
|
|
|
|
|
2020-05-11 19:10:02 +00:00
|
|
|
### Packages on pub.dev
|
2018-11-12 06:36:47 +00:00
|
|
|
|
2020-05-11 19:10:02 +00:00
|
|
|
Flutter has a rich ecosystem of packages that have been contributed by the
|
|
|
|
|
Flutter team and the broader open source community to a central repository.
|
2020-07-23 01:23:47 +00:00
|
|
|
Among the thousands of packages, you'll find support for Firebase, Google
|
2020-05-11 19:10:02 +00:00
|
|
|
Fonts, hardware services like Bluetooth and camera, new widgets and
|
|
|
|
|
animations, and integration with other popular web services. You can browse
|
|
|
|
|
those packages at [pub.dev](https://pub.dev).
|
