Desktop Embedding for Flutter

This project was originally created to develop Windows, macOS, and Linux embeddings of Flutter. That work has since become part of Flutter, and this project is now just an example of, and test environment for, building applications using those libraries in their current state. It also includes some experimental, early stage desktop plugins.

As explained in the link above, desktop libraries are still in early stages. The code here is not stable, nor intended for production use.

Setting Up

This project is closely tied to changes in the Flutter repository, so you must be on the latest version of the Flutter master channel. You should always update this repository and Flutter at the same time, as breaking changes for desktop happen frequently.

Tools

First you will need to enable Flutter desktop support for your platform.

Then run flutter doctor and be sure that no issues are reported for the sections relevant to your platform.

Running a Project

Example

Once you have everything set up, just flutter run in the example directory to run your first desktop Flutter application!

Note: Only debug mode is currently available for Windows and Linux. Running with --release or --profile will succeed, but the result will still be using a debug Flutter configuration: asserts will fire, the observatory will be enabled, etc.

Running Other Flutter Projects

See the example README for information on using the example as a starting point to run another project.

Repository Structure

testbed is a more complex example that is primarily intended for people actively working on Flutter for desktop. See its README for details.

The plugins directory has early-stage desktop plugins. See the README for details.

Feedback and Discussion

For bug reports and feature requests specific to the example or the plugins, you can file GitHub issues. Bugs and feature requests related to desktop support in general should be filed in the Flutter issue tracker.

For general discussion and questions there's a project mailing list.

Caveats

• This is not an officially supported Google product.
• The code and examples here, and the desktop Flutter libraries they use, are in early stages, and not intended for production use.