README.md 3.33 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
* [flutter.dev](https://flutter.dev) (main Flutter site)
* [Stable channel API Docs](https://api.flutter.dev)
18
* [Main channel API Docs](https://main-api.flutter.dev)
19
* Engine Embedder API documentation:
20 21 22 23 24 25
  * [Android Embedder](../javadoc/index.html)
  * [iOS Embedder](../ios-embedder/index.html)
  * [macOS Embedder](../macos-embedder/index.html)
  * [Linux Embedder](../linux-embedder/index.html)
  * [Windows Embedder](../windows-embedder/index.html)
  * [Web Embedder](dart-ui_web/dart-ui_web-library.html)
26 27
* [Installation](https://flutter.dev/docs/get-started/install)
* [Codelabs](https://flutter.dev/docs/codelabs)
28
* [Contributing to Flutter](https://github.com/flutter/flutter/blob/main/CONTRIBUTING.md)
29

30 31 32 33 34 35 36 37 38 39 40 41
## Offline Documentation

In addition to the online sites above, Flutter's documentation can be downloaded
as an HTML documentation ZIP file for use when offline or when you have a poor
internet connection.

**Warning: the offline documentation files are quite large, approximately 700 MB
to 900 MB.**

Offline HTML documentation ZIP bundles:

 * [Stable channel](https://api.flutter.dev/offline/flutter.docs.zip)
42
 * [Main channel](https://main-api.flutter.dev/offline/flutter.docs.zip)
43 44 45 46 47 48 49

Or, you can add Flutter to the open-source [Zeal](https://zealdocs.org/) app
using the following XML configurations. Follow the instructions in the
application for adding a feed.

 * Stable channel Zeal XML configuration URL:
   <https://api.flutter.dev/offline/flutter.xml>
50 51
 * Main channel Zeal XML configuration URL:
   <https://main-api.flutter.dev/offline/flutter.xml>
52

53
## Importing a Library
54

55
### Framework Libraries
56 57 58 59 60 61 62 63 64 65

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

66
### Dart Libraries
67

Tim Sneath's avatar
Tim Sneath committed
68
Libraries in the "Dart" section exist in the `dart:` namespace and are imported
69 70 71 72 73 74 75 76 77
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.

78
### Supporting Libraries
79 80 81 82 83 84 85 86 87 88

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

89
## Packages on pub.dev
90

Tim Sneath's avatar
Tim Sneath committed
91
Flutter has a rich ecosystem of packages that have been contributed by the
92 93
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
94 95 96
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).