flutter_eval - Dart API docs

flutter_eval is a Flutter bridge library for dart_eval, and a solution enabling code-push, dynamic widgets, and runtime evaluation of Flutter code. It can be used to enable hot-swapping parts of your app with an over-the-air update, dynamically loading UI from a server, or evaluating code based on user input such as in a calculator. flutter_eval supports all platforms including iOS and is built on dart_eval's custom bytecode interpreter, making it very fast.

dart_eval
flutter_eval
eval_annotation

For a live example, check out EvalPad.

Note: While flutter_eval supports most Flutter and Dart features, it does not support all of them. Existing code may need modification to work. You can see a list of supported widgets and classes here and a list of supported Dart features on the dart_eval Pub page.

See: Quickstart for code push | Quickstart for dynamic execution and server-driven UI | Supported widgets and classes

Quickstart for code push

Run flutter pub add flutter_eval to install the package.

At the root of your app, add a HotSwapLoader widget with a URI pointing to where you'll host the update file:

class MyApp extends StatelessWidget {

  @override
  Widget build(BuildContext context) {
    return HotSwapLoader(
        uri: 'https://mysite.com/app_update/version_xxx.evc',
        child: MaterialApp(
          ...

Then, add HotSwap widgets throughout your app at every location you'd like to be able to dynamically update:

class MyHomePage extends StatelessWidget {
  
  @override
  Widget build(BuildContext context) {
    return HotSwap(
      id: '#myHomePage',
      args: [$BuildContext.wrap(context)],
      childBuilder: (context) => Scaffold(
        ...

Next, create a new Flutter package using flutter create --template=package. This can be nested inside your app's folder or located separately. Name it something appropriate, such as my_app_hot_update. We'll refer to this as the "hot update package" from now on.

Head over to the flutter_eval Releases page and find the release corresponding to the version of flutter_eval you are using. Under Assets, download flutter_eval.json. (Or click here to download the latest version.)

In the root of the hot update package, create a folder called .dart_eval and a subfolder bindings. Place the downloaded flutter_eval.json file inside of this folder.

Your project structure should look like this:

├── .dart_eval
│   └── bindings
│       └── flutter_eval.json.
├── pubspec.yaml
└── lib
    └── hot_update.dart

At the root of the hot update package, run flutter pub add eval_annotation.

Delete all the code from main.dart, including the main() function. For every HotSwap widget you'd like to update (you can update all, or just a few, or just one), create a top-level function with the @RuntimeOverride annotation referencing its ID:

@RuntimeOverride('#myHomePage')
Widget myHomePageUpdate(BuildContext context) {
  return Scaffold(
    ...
  )
}

Finally, we'll need to install the dart_eval CLI:

dart pub global activate dart_eval

After installing, you can run:

dart_eval compile -o version_xxx.evc

If the steps were performed correctly, you should see the following in the console output:

Found binding file: .dart_eval\bindings\flutter_eval.json

as well as

Compiled $x characters Dart to $y bytes EVC in $z ms: version_xxx.evc

The resulting version_xxx.evc file will be in the root of the project and you can now upload it to the previously referenced server path.

If you run the app, you should see the contents of the HotSwap widgets replaced with the contents of their corresponding @RuntimeOverride functions.

HotSwap widgets can optionally specify a strategy to use when loading/applying updates, one of immediate, cache, or cacheApplyOnRestart. By default, HotSwapLoader uses immediate in debug/profile mode and cacheApplyOnRestart in release mode. You can also specify a placeholder widget to display when loading from the cache via the loading parameter.

For a complete example of code push, see examples/code_push_app and its subfolder hot_update.

Quickstart for dynamic execution and server-driven UI

To create a simple dynamic stateless widget, add and modify the following inside a build() method or as a child parameter:

return EvalWidget(packages: {
  'example': {
    'main.dart': '''
    import 'package:flutter/material.dart';
    
    class MyWidget extends StatelessWidget {
      MyWidget(this.name);
      final String name;

      @override
      Widget build(BuildContext context) {
        return Padding(
          padding: EdgeInsets.all(5.0),
          child: Column(children: [
              Container(
                color: Colors.red,
                child: Text('The name is ' + name)
              )
            ],
            mainAxisAlignment: MainAxisAlignment.center,
            crossAxisAlignment: CrossAxisAlignment.center,
          )
        );
      }
    }''',
    assetPath: 'assets/program.evc',
    library: 'package:example/main.dart',
    function: 'MyWidget.',
    args: [$String('Example name')]
  }
});

Internally, EvalWidget automatically switches between two modes:

When running in debug mode, it will dynamically compile the provided Dart code into EVC bytecode, save it to a file determined by assetPath, and run it in the dart_eval VM. This is slower, but allows you to make changes when developing with a hot restart.
When running in release mode, it will instead ignore the provided Dart code and attempt to load EVC bytecode, either from the assetPath or from a custom file, asset, or network URL specified by the optional uri parameter. This enables high performance at runtime, while still letting you dynamically swap out code by providing a new EVC file or URL.

If you are loading EVC bytecode from the network, you can specify an optional loading widget with the loading parameter.

flutter_eval includes two other helper Widgets for different use cases:

CompilerWidget will always compile and run provided Dart code, and never attempt to load EVC bytecode, regardless of whether the app is in debug or release mode. This is especially suitable for apps like calculators, 'learn to code' platforms, or user-scriptable automation tools. Though this mode is slower, the dart_eval compiler is very fast and will generally compile simple Flutter programs in ~0.1 second.
RuntimeWidget will always load EVC bytecode and does not provide a parameter to specify Dart code. This is recommended if you're compiling with the CLI - see below.

Calling functions and passing arguments

To instantiate a class with its default constructor, append a '.' to the class name.

When calling a dart_eval function or constructor externally, you must specify all arguments - even optional and named ones - in order, using null to indicate the absence of an argument (whereas $null() indicates a null value).

E.g. for the following class:

class MyApp extends SomeWidget {
  MyApp(this.name, {Key? key, Color? color}) : super(key: key, color: color);

  final String name;
}

You could instantiate it in RuntimeWidget with:

return RuntimeWidget(
  uri: Uri.parse('asset:assets/program.evc'),
  library: 'package:example/main.dart',
  function: 'MyApp.',
  args: [$String('Jessica'), null, null]
);

You can also pass callbacks with $Function.

Security and permissions

flutter_eval inherits dart_eval's secure execution model which restricts access to the filesystem, network, and other sensitive APIs by default. flutter_eval extends this with security controls for MethodChannel and related APIs. To allow access to a MethodChannel, add a MethodChannelPermission to the permissions parameter of EvalWidget, CompilerWidget, or RuntimeWidget.

Supported widgets and classes

Currently supported widgets and classes include:

Widget, StatelessWidget, StatefulWidget, State;
ChangeNotifier, Key, BuildContext;
WidgetsApp, Container, Column, Row, Center;
Alignment, Align, AspectRatio, Baseline;
Radius, BorderRadius, BorderRadiusGeometry, Clip, ClipRRect;
SizedBox, FittedBox, FractionallySizedBox, ColoredBox;
Stack, Positioned, StackFit;
Padding, EdgeInsetsGeometry, EdgeInsets, Axis, Size;
Offset, Velocity;
MainAxisAlignment, MainAxisSize, CrossAxisAlignment;
AlignmentGeometry, Alignment, Constraints, BoxConstraints;
Color, ColorSwatch, Colors, FontWeight, FontStyle;
MaterialApp, MaterialColor, MaterialAccentColor;
Theme, ThemeData, TextTheme, Directionality;
Decoration, BoxDecoration, BoxBorder, Border, BorderSide;
IconData, Icons, Icon;
Curve, Curves, SawTooth, Interval, Threshold, Cubic;
Text, TextStyle, TextEditingController, TextField;
TextDirection, VerticalDirection, TextBaseline
Scaffold, ScaffoldMessenger, AppBar, SnackBar, FloatingActionButton;
InkWell, TextButton, ElevatedButton, IconButton;
Card, Drawer, ListView, ListTile, Spacer;
Image, ImageProvider, NetworkImage, MemoryImage;
Navigator, NavigatorState, Builder;
PointerDeviceKind, HitTestBehavior;
GestureDetector, TapDownDetails, TapUpDetails;
LongPressStartDetails, LongPressMoveUpdateDetails, LongPressEndDetails;
DragStartDetails, DragUpdateDetails, DragEndDetails, DragDownDetails;

Note that some of these have only partial support.

App size measurements

App	Initial APK size	with EvalWidget
Flutter Counter	16.5 MB	17.9 MB (+ 1.4 MB)
Flutter Gallery	110.2 MB	110.6 MB (+ 0.4 MB)

These measurements were last updated for flutter_eval v0.4.5. They do not include the size of an EVC bytecode file, which is typically 20-100KB (or 6-30KB zipped) and may be downloaded post-install rather than packaged with the app.

Note these measurements are for a generated combined APK which includes multiple architectures. APKs downloaded from the Play Store will be about half as large in both APK size and increase.

Advanced usage

Using flutter_eval requires two main steps: compiling the Dart code to EVC bytecode, and executing the resultant EVC bytecode. Since you cannot currently expect all existing Flutter/Dart code to work with flutter_eval, it's recommended to run both steps in your app during development:

class ExampleState extends State<Example> {
  late Runtime runtime;

  @override
  void initState() {
    super.initState();

    final compiler = Compiler();
    compiler.addPlugin(flutterEvalPlugin);

    final program = compiler.compile({
      'example': { 'main.dart': '''
          import 'package:flutter/material.dart';
          
          class HomePage extends StatelessWidget {
            HomePage(this.number);
            final int number;
            
            @override
            Widget build(BuildContext context) {
              return Padding(
                padding: EdgeInsets.all(2.3 * 5),
                child: Container(
                  color: Colors.green,
                  child: Text('Current amount: ' + number.toString())
                )
              );
            }
          }
        ''' }
    });

    final file = File('out.evc');
    file.writeAsBytesSync(program.write());
    print('Wrote out.evc to: ' + file.absolute.uri);
    
    runtime = Runtime.ofProgram(program);
    runtime.addPlugin(flutterEvalPlugin);
  }

  @override
  Widget build(BuildContext context) {
    return (runtime.executeLib('package:example/main.dart', 'HomePage.', [$int(55)]) as $Value).$value;
  }
}

With this setup you can quickly see any errors in the code. However, we're also continuously writing the EVC bytecode to a file out.evc. This file contains the compiled bytecode created from the Dart source and when releasing an app to production, it's all you need. Running the compiler in your production app at runtime, while possible, is strongly discouraged as it is much slower than simply using the generated output. EVC bytecode is platform-agnostic, so you can generate the out.evc file using Flutter Desktop and use it in a Flutter Mobile app with no issues.

After it's generated, you can use it in an app like so:

import 'package:flutter/services.dart' show rootBundle;

class ExampleState extends State<Example> {
  Runtime? runtime;

  @override
  void initState() {
    super.initState();
    
    rootBundle.load('assets/out.evc').then((bytecode) => setState(() {
      runtime = Runtime(ByteData.sublistView(bytecode));
      runtime.addPlugin(flutterEvalPlugin);
    }));
  }

  @override
  Widget build(BuildContext context) {
    if (runtime == null) return CircularProgressIndicator();
    return (runtime.executeLib('package:example/main.dart', 'HomePage.', [$int(55)]) as $Value).$value;
  }
}

You can also load out.evc over the network. In a large app, you may want to consider gzip compression as EVC bytecode compresses very well (around a 4x ratio).