Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dnfield committed May 11, 2018
1 parent 2a8519c commit 42bac04
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 21 deletions.
11 changes: 9 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# CHANGES

## 0.1.1

- Handle opacity on groups and inherited/blended opacity.
- Fixes elements that have both opacity and stroke-opacity or fill-opacity.
- Improvements for inheritence.
- Fixes related to unspecified fills on shapes.

## 0.1.0

Bumping minor version due to internal breaking changes and new support. Works on dev channel as of release (Flutter >= 0.3.6).
Expand All @@ -13,8 +20,8 @@ Bumping minor version due to internal breaking changes and new support. Works on

## 0.0.2

Initial text support. Relies on flutter 0.3.6
Initial text support. Relies on flutter 0.3.6.

## 0.0.1

Initial release. Relies on pre-released master
Initial release. Relies on pre-released master.
47 changes: 30 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,27 +26,40 @@ final Widget svg = new SvgImage.asset(
);
```

See [main.dart](/../master/lib/main.dart) for a complete sample.
See [main.dart](/../master/example/main.dart) for a complete sample.

## Use Cases

- Your designer creates a vector asset that you want to include without converting to 5 different
raster format resolutions.
- Your vector drawing is meant to be static and non (or maybe minimally) interactive

## TODO

This list is roughly ordered.

- [ ] Text support
- [ ] Gradient support (Linear: Mostly done, Radial: partly done)
- [x] Dash path support
- [ ] Dash path with percentage dasharray values
- [ ] More SVG samples to cover more complicated cases
- [ ] Display/visibility support
- [ ] Unit tests
- [ ] Inerhitance of inheritable properties (necessary? preprocess?)
- [ ] Support for minimal CSS/styles? See also [svgcleaner](https://github.com/razrfalcon/svgcleaner)
- [ ] XLink/ref support (necessary? partially supported for gradients)
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.

- [ ] Text support.
- [ ] Gradient support (Linear: Mostly done, Radial: partly done).
- [x] Dash path support.
- [ ] Dash path with percentage dasharray values.
- [ ] More SVG samples to cover more complicated cases (getting there - please send me samples of
things that don't work!).
- [ ] Display/visibility support.
- [ ] Unit tests. In particular, tests that validate XML -> Drawable* structures.
- [ ] Inheritance of inheritable properties (~~necessary? preprocess?~~ significant progress).
- [ ] Support for minimal CSS/styles? See also
[svgcleaner](https://github.com/razrfalcon/svgcleaner) (partial - style attr mostly supported).
- [ ] XLink/ref support (necessary? partially supported for gradients).
- [ ] Glyph support?
- [ ] Markers
- [ ] Filters/effects
- [ ] Android Vector Drawable support (partial so far)
- [ ] Caching of image
- [ ] Markers.
- [ ] Filters/effects.
- [ ] Android Vector Drawable support (partial so far).
- [ ] Caching of image.
- [ ] The XML parsing implementation is heavy for what this really needs. I've made efforts to keep
the API forward-reading-only compatible to eventually be able to use a SAX/XMLReader style
parser.
- [ ] Color swapping/hue shifting/tinting of asset.

## Probably out of scope

Expand Down
1 change: 1 addition & 0 deletions flutter_svg.iml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
<content url="file://$MODULE_DIR$">
<sourceFolder url="file://$MODULE_DIR$/lib" isTestSource="false" />
<sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
<excludeFolder url="file://$MODULE_DIR$/.dart_tool" />
<excludeFolder url="file://$MODULE_DIR$/.idea" />
<excludeFolder url="file://$MODULE_DIR$/.pub" />
<excludeFolder url="file://$MODULE_DIR$/build" />
Expand Down
3 changes: 2 additions & 1 deletion flutter_svg_android.iml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
<component name="FacetManager">
<facet type="android" name="Android">
<configuration>
<option name="ALLOW_USER_CONFIGURATION" value="false" />
<option name="GEN_FOLDER_RELATIVE_PATH_APT" value="/android/gen" />
<option name="GEN_FOLDER_RELATIVE_PATH_AIDL" value="/android/gen" />
<option name="MANIFEST_FILE_RELATIVE_PATH" value="/android/AndroidManifest.xml" />
Expand All @@ -23,4 +24,4 @@
<orderEntry type="sourceFolder" forTests="false" />
<orderEntry type="library" name="Flutter for Android" level="project" />
</component>
</module>
</module>
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: flutter_svg
description: An SVG rendering and widget library for Flutter.
author: Dan Field <dfield@gmail.com>
homepage: https://github.com/dnfield/flutter_svg
version: 0.1.0
version: 0.1.1

dependencies:
path_drawing: ^0.2.2
Expand Down

0 comments on commit 42bac04

Please sign in to comment.