2018-11-11 22:36:47 -08:00
|
|
|
|
Welcome to the Flutter API reference documentation.
|
|
|
|
|
|
|
2018-03-30 12:19:44 -07:00
|
|
|
|
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.
|
|
|
|
|
|
|
2018-11-11 22:36:47 -08:00
|
|
|
|
The API reference herein covers all libraries that are exported by the Flutter
|
|
|
|
|
|
SDK.
|
|
|
|
|
|
|
|
|
|
|
|
### More Documentation
|
2018-03-30 12:19:44 -07:00
|
|
|
|
|
2018-11-08 09:00:47 -08:00
|
|
|
|
This site hosts Flutter's API documentation. Other documentation can be found at
|
|
|
|
|
|
the following locations:
|
|
|
|
|
|
|
2019-03-20 14:42:46 -07: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 09:00:47 -08:00
|
|
|
|
* [Contributing to Flutter](https://github.com/flutter/flutter/blob/master/CONTRIBUTING.md)
|
2018-11-11 22:36:47 -08: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
|
|
|
|
|
|
|
|
|
|
|
|
Libraries in the "Dart" section exist in the `'dart:'` namespace and are imported
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
#### 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:
|
|
|
|
|
|
|
|
|
|
|
|
```dart
|
|
|
|
|
|
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
|
2019-05-14 10:35:00 -07:00
|
|
|
|
[pub.dev/flutter](https://pub.dev/flutter)
|
