n-bernat / kanjivg

Implementation of a parser and Flutter widgets for resources from the Kanji Vector Graphics project.

KanjiVG for Flutter & Dart

kanjivg	flutter_kanjivg

kanjivg and flutter_kanjivg provide a simple way of interacting with data from the KanjiVG (Kanji Vector Graphics) project.

Those packages are neither supported nor related to the creators of the KanjiVG project.

Some parts of comments in this library may consist of descriptions from the original KanjiVG website which is licensed under the Creative Commons Attribution-Share Alike 3.0 license.

Documentation

• kanjivg

  Base parser for SVG files from the KanjiVG project. Provides metadata like stroke count, original radical forms (e.g. 人 for 亻), position of radicals and more.

• flutter_kanjivg

  Flutter widgets that simplify displaying animated kanji. When using flutter_kanjivg there is no need to add kanjivg to your dependencies as flutter_kanjivg imports it itself.

Version constraints

• Dart >= 3.1.0
• Flutter >= 3.10.0

Maintainers

• Nikodem Bernat

kanjivg's Issues

Add new parameter for a constant animation speed

Currently the animation takes n seconds which can be customized using the duration parameter. Unfortunately, it makes either simple characters too slow (e.g. 川) or complex characters too fast (e.g. 鬱).

There should be an option to, instead of duration, provide something like speed which would allow us to have constant drawing speed for all characters.

Add code examples

The only thing that is missing to have the perfect score is some code examples.

Create tests to validate parser against the dataset

There should be tests that will check whether everything works for all possible characters.

https://github.com/KanjiVG/kanjivg

Optimize KanjiParser.parse method

It does work, but I assume that someone may try to load all 10k files at once, and then it may be quite laggy.