blob: 0d51b80e1f3e545df327477e4717c5f9b8db3603 [file] [log] [blame] [view]
Tim Sneathd62635a2019-04-08 18:02:09 -07001# [![Flutter logo][]][flutter.dev]
Patrice Chalinf8e5b9c2019-01-23 21:54:15 -05002
Patrice Chalinf8e5b9c2019-01-23 21:54:15 -05003[![Build Status - Cirrus][]][Build status]
Tim Sneathd62635a2019-04-08 18:02:09 -07004[![Gitter Channel][]][Gitter badge]
Michael Thomsen7f0f9382018-08-27 11:11:14 +02005
Tim Sneathd62635a2019-04-08 18:02:09 -07006Flutter is Google's mobile app SDK for crafting high-quality native interfaces
7on iOS and Android in record time. Flutter works with existing code, is used by
8developers and organizations around the world, and is free and open source.
Michael Thomsen7f0f9382018-08-27 11:11:14 +02009
Tim Sneathd62635a2019-04-08 18:02:09 -070010## Documentation
Adam Barth7b0bbdb2015-10-30 11:16:58 -070011
Tim Sneathd62635a2019-04-08 18:02:09 -070012* [Install Flutter](https://flutter.dev/get-started/)
13* [Flutter documentation](https://flutter.dev/docs)
14* [Development wiki](https://github.com/flutter/flutter/wiki)
15* [Contributing to Flutter](https://github.com/flutter/flutter/blob/master/CONTRIBUTING.md)
Ian Hicksoncf2fba72018-11-06 13:41:09 -080016
17For announcements about new releases and breaking changes, follow the
18[flutter-announce@googlegroups.com](https://groups.google.com/forum/#!forum/flutter-announce)
19mailing list.
Adam Barth576795d2015-11-08 21:33:00 -080020
Tim Sneathd62635a2019-04-08 18:02:09 -070021## About Flutter
Adam Barth7b0bbdb2015-10-30 11:16:58 -070022
Tim Sneathd62635a2019-04-08 18:02:09 -070023We think Flutter will help you create beautiful, fast apps, with a productive,
24extensible and open development model.
Filip Hracek53e23532017-07-12 10:12:25 -070025
Tim Sneathd62635a2019-04-08 18:02:09 -070026### Beautiful apps
Filip Hracek39d2deb2017-07-12 10:58:12 -070027
Tim Sneathd62635a2019-04-08 18:02:09 -070028We want to enable designers to deliver their full creative vision without being
29forced to water it down due to limitations of the underlying framework.
30Flutter's [layered architecture] gives you control over every pixel on the
31screen, and its powerful compositing capabilities let you overlay and animate
32graphics, video, text and controls without limitation. Flutter includes a full
33[set of widgets][widget catalog] that deliver pixel-perfect experiences on both
34iOS and Android.
Michael Thomsen7f0f9382018-08-27 11:11:14 +020035
Tim Sneathd62635a2019-04-08 18:02:09 -070036![Reflectly hero image][Reflectly hero image]
Filip Hracek53e23532017-07-12 10:12:25 -070037
Tim Sneathd62635a2019-04-08 18:02:09 -070038### Fast apps
Filip Hracek53e23532017-07-12 10:12:25 -070039
Tim Sneathd62635a2019-04-08 18:02:09 -070040Flutter is fast. It's powered by the same hardware-accelerated [Skia] 2D
41graphics library that underpins Chrome and Android. We architected Flutter to
42support glitch-free, jank-free graphics at the native speed of your device.
43Flutter code is powered by the world-class [Dart platform], which enables
44compilation to native 32-bit and 64-bit ARM code for iOS and Android.
Filip Hracek53e23532017-07-12 10:12:25 -070045
Tim Sneathd62635a2019-04-08 18:02:09 -070046### Productive development
Filip Hracek53e23532017-07-12 10:12:25 -070047
Tim Sneathd62635a2019-04-08 18:02:09 -070048Flutter offers stateful hot reload, allowing you to make changes to your code
49and see the results instantly without restarting your app or losing its state.
Filip Hracek53e23532017-07-12 10:12:25 -070050
Tim Sneathd62635a2019-04-08 18:02:09 -070051[![Hot reload animation][]][Hot reload]
Filip Hracek53e23532017-07-12 10:12:25 -070052
Tim Sneathd62635a2019-04-08 18:02:09 -070053### Extensible and open model
Filip Hracek53e23532017-07-12 10:12:25 -070054
Tim Sneathd62635a2019-04-08 18:02:09 -070055Flutter works with any development tool, but includes editor plug-ins for both
56[Visual Studio Code] and [IntelliJ / Android Studio]. Flutter provides
57[thousands of packages][Flutter packages] to speed your development, regardless
58of your target platform. And accessing platform features is easy. Here is a
59snippet from our [interop example]:
Filip Hracek53e23532017-07-12 10:12:25 -070060
61```dart
Alexandre Ardhuin936dea22018-10-17 08:09:29 +020062Future<void> getBatteryLevel() async {
Filip Hracek53e23532017-07-12 10:12:25 -070063 var batteryLevel = 'unknown';
64 try {
65 int result = await methodChannel.invokeMethod('getBatteryLevel');
66 batteryLevel = 'Battery level: $result%';
67 } on PlatformException {
68 batteryLevel = 'Failed to get battery level.';
69 }
70 setState(() {
71 _batteryLevel = batteryLevel;
72 });
73}
74```
75
Tim Sneathd62635a2019-04-08 18:02:09 -070076Flutter is a fully open source project, and we welcome contributions.
77Information on how to get started can be found at our
78[contributor guide](CONTRIBUTING.md).
Filip Hracek53e23532017-07-12 10:12:25 -070079
Tim Sneathd62635a2019-04-08 18:02:09 -070080[Flutter logo]: https://flutter.dev/assets/flutter-lockup-4cb0ee072ab312e59784d9fbf4fb7ad42688a7fdaea1270ccf6bbf4f34b7e03f.svg
81[flutter.dev]: https://flutter.dev
Patrice Chalinf8e5b9c2019-01-23 21:54:15 -050082[Build Status - Cirrus]: https://api.cirrus-ci.com/github/flutter/flutter.svg
83[Build status]: https://cirrus-ci.com/github/flutter/flutter/master
Patrice Chalinf8e5b9c2019-01-23 21:54:15 -050084[Gitter Channel]: https://badges.gitter.im/flutter/flutter.svg
Tim Sneathd62635a2019-04-08 18:02:09 -070085[Gitter badge]: https://gitter.im/flutter/flutter?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
86[layered architecture]: https://flutter.dev/docs/resources/inside-flutter
87[widget catalog]: https://flutter.dev/widgets/
88[Reflectly hero image]: https://github.com/flutter/website/blob/master/src/images/homepage/reflectly-hero-600px.png
89[Skia]: https://skia.org/
Kate Lovett054d9bb2019-05-14 10:35:00 -070090[Dart platform]: https://dart.dev/
Tim Sneathd62635a2019-04-08 18:02:09 -070091[Hot reload animation]: https://raw.githubusercontent.com/flutter/website/master/src/_assets/image/tools/android-studio/hot-reload.gif
92[Hot reload]: https://flutter.dev/docs/development/tools/hot-reload
93[Visual Studio Code]: https://marketplace.visualstudio.com/items?itemName=Dart-Code.flutter
94[IntelliJ / Android Studio]: https://plugins.jetbrains.com/plugin/9212-flutter
Kate Lovett054d9bb2019-05-14 10:35:00 -070095[Flutter packages]: https://pub.dev/flutter
Tim Sneathd62635a2019-04-08 18:02:09 -070096[interop example]: https://github.com/flutter/flutter/tree/master/examples/platform_channel