README.md 2.04 KB
Newer Older
1
# Welcome to the Flutter API reference documentation!
2

3
Flutter is Google's SDK for crafting beautiful, fast user experiences for
4
mobile, web, and desktop from a single codebase. Flutter works with existing
Tim Sneath's avatar
Tim Sneath committed
5 6
code, is used by developers and organizations around the world, and is free
and open source.
7

Tim Sneath's avatar
Tim Sneath committed
8
This API reference covers all libraries that are exported by the Flutter
9 10
SDK.

11
## More Documentation
12

13 14 15
This site hosts Flutter's API documentation. Other documentation can be found at
the following locations:

16 17 18
* [flutter.dev](https://flutter.dev) (main site)
* [Installation](https://flutter.dev/docs/get-started/install)
* [Codelabs](https://flutter.dev/docs/codelabs)
19
* [Contributing to Flutter](https://github.com/flutter/flutter/blob/master/CONTRIBUTING.md)
20

21
## Importing a Library
22

23
### Framework Libraries
24 25 26 27 28 29 30 31 32 33

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';
```

34
### Dart Libraries
35

Tim Sneath's avatar
Tim Sneath committed
36
Libraries in the "Dart" section exist in the `dart:` namespace and are imported
37 38 39 40 41 42 43 44 45
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.

46
### Supporting Libraries
47 48 49 50 51 52 53 54 55 56

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';
```

57
## Packages on pub.dev
58

Tim Sneath's avatar
Tim Sneath committed
59
Flutter has a rich ecosystem of packages that have been contributed by the
60 61
Flutter team and the broader open source community to a central repository.
Among the thousands of packages, you'll find support for Firebase, Google
Tim Sneath's avatar
Tim Sneath committed
62 63 64
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).