Dart pub
Draw SVG (and some Android VectorDrawable (XML)) files on a Flutter Widget.
This is a Dart-native rendering library. Issues/PRs will be raised in Flutter and flutter/engine as necessary for features that are not good candidates for Dart implementations (especially if they're impossible to implement without engine support). However, not everything that Skia can easily do needs to be done by Skia; for example, the Path parsing logic here isn't much slower than doing it in native, and Skia isn't always doing low level GPU accelerated work where you might think it is (e.g. Dash Paths).
All of the SVGs in the assets/ folder (except the text related one(s)) now
have corresponding PNGs in the golden/ folder that were rendered using
flutter test tool/gen_golden.dart and compared against their rendering output
in Chrome. Automated tests will continue to compare these to ensure code changes
do not break known-good renderings.
Basic usage (to create an SVG rendering widget from an asset):
final String assetName = 'assets/image.svg';
final Widget svg = new SvgPicture.asset(
assetName,
);
You can color/tint the image like so:
final String assetName = 'assets/icon.svg';
final Widget svgIcon = new SvgPicture.asset(
assetName,
color: Colors.red,
);
The default placeholder is an empty box (LimitedBox) - although if a height
or width is specified on the SvgPicture, a SizedBox will be used instead
(which ensures better layout experience). There is currently no way to show an
Error visually, however errors will get properly logged to the console in debug
mode.
You can also specify a placeholder widget. The placeholder will display during parsing/loading (normally only relevant for network access).
// Will print error messages to the console.
final String assetName = 'assets/image_that_does_not_exist.svg';
final Widget svg = new SvgPicture.asset(
assetName,
);
final Widget networkSvg = new SvgImage.network(
'https://site-that-takes-a-while.com/image.svg',
loadingPlaceholderBuilder: (BuildContext context) => new Container(
padding: const EdgeInsets.all(30.0),
child: const CircularProgressIndicator()),
);
If you'd like to render the SVG to some other canvas, you can do something like:
import 'package:flutter_svg/flutter_svg.dart';
final String rawSvg = '''<svg viewBox="...">...</svg>''';
final DrawableRoot svgRoot = await svg.fromSvgString(rawSvg, rawSvg);
// If you only want the final Picture output, just use
final Picture picture = svgRoot.toPicture();
// Otherwise, if you want to draw it to a canvas:
// Optional, but probably normally desirable: scale the canvas dimensions to
// the SVG's viewbox
svgRoot.scaleCanvasToViewBox(canvas);
// Optional, but probably normally desireable: ensure the SVG isn't rendered
// outside of the viewbox bounds
svgRoot.clipCanvasToViewBox(canvas);
svgRoot.draw(canvas, size);
The SvgPicture helps to automate this logic, and it provides some convenience
wrappers for getting assets from multiple sources and caching the resultant
Picture. It does not render the data to an Image at any point; you
certainly can do that in Flutter, but you then lose some of the benefit of
having a vector format to begin with.
While I'm making every effort to avoid needlessly changing the API, it's not
guarnateed to be stable yet (hence the pre-1.0.0 version). To date, the biggest
change is deprecating the SvgImage widgets in favor of SvgPicture - it
became very confusing to maintain that name, as Pictures are the underlying
mechanism for rendering rather than Images.
See main.dart for a complete sample.
This list is not very well ordered. I'm mainly picking up things that seem interesting or useful, or where I've gotten a request to fix something/example of something that's broken.
SVGs in /assets/w3samples pulled from W3 sample files
SVGs in /assets/deborah_ufw provided by @deborah-ufw
SVGs in /assets/simple are pulled from trivial examples or generated to test
basic functionality - some of them come directly from the SVG 1.1 spec. Some
have also come or been adapted from issues raised in this repository.
SVGs in /assets/wikimedia are pulled from Wikimedia Commons
Android Drawables in assets/android_vd are pulled from Android Documentation
and examples.
The Flutter Logo created based on the Flutter Logo Widget © Google.
The Dart logo is from dartlang.org © Google
SVGs in /assets/noto-emoji are from (Google i18n noto-emoji)[https://github.com/googlei18n/noto-emoji],
licensed under the Apache license.
Please submit SVGs this can't render properly (e.g. that don't render here the way they do in chrome), as long as they're not using anything "probably out of scope" (above).
clipPath outside of defs eleemnts.use in a clipPath.usvg rather than svgcleaner per author's recommendation.DrawableNoop implement DrawableStyleable to avoid crashing with
certain unhandled elements.<style> element scenarios.width and height. These
changes did not quite fix what they were intended to fix and caused problems
they weren't intended to case.async to support image loading.<image> elements.SvgPicture.asset will now cache the asset. We already cached the
final picture, but the caching included any color filtering provided on the
image. This is problematic if the color is animated. See
https://github.com/dnfield/flutter_svg/issues/33width and height processing on the root
element.width and height were treated as synonyms for the width and
height of the viewBox. This is not correct, and resulted in meaningful
rendering errors in some scenarios compared to Chrome. Fixing this makes the
parser more conformant to the spec, but may make your SVGs look
significantly different if they specify width or height. If you want the
old behavior, you'll have to update your SVGs to not specify width and
height (only specify viewBox).MediaQuery.of(context).devicePixelRatio if available before defaulting
to window.devicePixelRatio in places that need awareness of
devicePixelRatios.<use>, <symbol>, and shape/group elements in <defs>. There
are some limitations to this currently,BoxFit and Alignment for SvgPictures (Thanks
@sroddy!).userSpaceOnUse gradientUnits (@sroddy)Paint and assist with inheriting all
painting properties.HttpStatus.OK change - not ready yet for Flutter beta channel<tspan> stylestext-anchor attribute<ellipse> parsing bug (ellipses were drawn at half the expected size)<polyline> parsing bug (polylines were incorrectly forced to be closed)FittedBoxwidth and height properties to SvgPictureSvgImagematchesTextDirectiontext-anchorSvgImage, AvdImage, and VectorDrawableImage have been
deprecated. They relied on methods that are less efficient than those now
surfaced in SvgPicture.SvgPicture - its size is
determined by parent size.clipToViewBox is now called allowDrawingOutsideViewBox.
It defaults to false. It should not ordinarily be set to true, as it can allow
unexpected memory usage if your vector graphic tries to draw far outside of
the viewBox bounds.SvgPicture does not support custom ErrorWidgetBuilders at
this point in time. However, errors will be properly logged to the console.
This is a result of improvements in the loading/caching of drawings.<clipPath>s<radialGradient> percentage handling.Bumping minor version due to internal breaking changes and new support. Works on dev channel as of release (Flutter >= 0.3.6).
DrawableRoot to support top level style definition.@style attributes.rgb() color attribute/styles.assets/simple/style_attr.svg).Initial text support. Relies on flutter 0.3.6.
Initial release. Relies on pre-released master.
example/README.md
A new Flutter project.
For help getting started with Flutter, view our online documentation.
Add this to your package's pubspec.yaml file:
dependencies:
flutter_svg: ^0.8.3
You can install packages from the command line:
with Flutter:
$ flutter packages get
Alternatively, your editor might support flutter packages get.
Check the docs for your editor to learn more.
Now in your Dart code, you can use:
import 'package:flutter_svg/flutter_svg.dart';
| Version | Uploaded | Documentation | Archive |
|---|---|---|---|
| 0.10.3 | Jan 25, 2019 |
|
|
| 0.10.2 | Jan 17, 2019 |
|
|
| 0.10.1 | Jan 14, 2019 |
|
|
| 0.10.0+2 | Jan 14, 2019 |
|
|
| 0.10.0+1 | Jan 13, 2019 |
|
|
| 0.10.0 | Jan 12, 2019 |
|
|
| 0.9.0+1 | Dec 31, 2018 |
|
|
| 0.9.0 | Dec 31, 2018 |
|
|
| 0.8.3 | Dec 29, 2018 |
|
|
| 0.8.2 | Dec 18, 2018 |
|
|
|
Popularity:
Describes how popular the package is relative to other packages.
[more]
|
99
|
|
Health:
Code health derived from static analysis.
[more]
|
100
|
|
Maintenance:
Reflects how tidy and up-to-date the package is.
[more]
|
100
|
|
Overall:
Weighted score of the above.
[more]
|
99
|
We analyzed this package on Feb 14, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
Detected platforms: Flutter
References Flutter, and has no conflicting libraries.
Fix lib/src/utilities/http.dart. (-0.50 points)
Analysis of lib/src/utilities/http.dart reported 1 hint:
line 6 col 1: The class 'Future' was not exported from 'dart:core' until version 2.1, but this code is required to be able to run on earlier versions.
| Package | Constraint | Resolved | Available |
|---|---|---|---|
| Direct dependencies | |||
| Dart SDK | >=1.19.0 <3.0.0 | ||
| flutter | 0.0.0 | ||
| meta | ^1.1.2 | 1.1.6 | 1.1.7 |
| path_drawing | ^0.4.0 | 0.4.0 | |
| vector_math | ^2.0.4 | 2.0.8 | |
| xml | ^3.0.0 | 3.3.1 | |
| Transitive dependencies | |||
| charcode | 1.1.2 | ||
| collection | 1.14.11 | ||
| convert | 2.1.1 | ||
| path_parsing | 0.1.3 | ||
| petitparser | 2.1.1 | ||
| sky_engine | 0.0.99 | ||
| typed_data | 1.1.6 | ||
| Dev dependencies | |||
| flutter_test | |||
| mockito | ^4.0.0 | ||
| path | ^1.5.1 | ||
| test | ^1.4.0 | ||