Transforming assets at build time

You can configure your project to automatically transform assets at build time using compatible Dart packages.

In the pubspec.yaml file, list the assets to be transformed and the associated transformer package.

flutter:
  assets:
    - path: assets/logo.svg
      transformers:
        - package: vector_graphics_compiler

With this configuration, assets/logo.svg is transformed by the vector_graphics_compiler package as it is copied to the build output. This package precompiles SVG files into an optimized binary files that can be displayed using the vector_graphics package, like so:

import 'package:vector_graphics/vector_graphics.dart';

const Widget logo = VectorGraphic(
  loader: AssetBytesLoader('assets/logo.svg'),
);

To pass a string of arguments to an asset transformer, also specify that in the pubspec:

flutter:
  assets:
    - path: assets/logo.svg
      transformers:
        - package: vector_graphics_compiler
          args: ['--tessellate', '--font-size=14']

Asset transformers can be chained and are applied in the order they are declared. Consider the following example using imaginary packages:

flutter:
  assets:
    - path: assets/bird.png
      transformers:
        - package: grayscale_filter
        - package: png_optimizer

Here, bird.png is transformed by the grayscale_filter package. The output is then transformed by the png_optimizer package before being bundled into the built app.

An asset transformer is a Dart command-line app that is invoked with dart run with at least two arguments: --input, which contains the path to the file to transform and --output, which is the location where the transformer code must write its output to.

If the transformer applications finishes with a non-zero exit code, the build fails with error message explaining that transformation of the asset failed. Anything written to the stderr stream of the process by the transformer is included in the error message.

For a sample Flutter project that uses asset transformation and includes a custom Dart package that is used as a transformer, check out the asset_transformers project in the Flutter samples repo.

Unless stated otherwise, the documentation on this site reflects the latest stable version of Flutter. Page last updated on 2024-05-20. View source or report an issue.