stroke_order_animator library
This package implements stroke order animations and quizzes of Chinese characters based on the Make me a Hanzi data.
Integrating this package into your app is easy. Follow these steps:
- Download stroke order data via downloadStrokeOrder
- Pass the retrieved data to StrokeOrder
- Pass the StrokeOrder to a StrokeOrderAnimationController
- Pass the StrokeOrderAnimationController to a StrokeOrderAnimator
The first step can be skipped for offline usage. In this case, the stroke order data must be passed to the StrokeOrder constructor directly as JSON. All stroke order data can be downloaded from here. Data for single characters can be downloaded through the Hanzi Writer Data project, e.g., via https://cdn.jsdelivr.net/npm/hanzi-writer-data@latest/我.json.
The StrokeOrderAnimationController handles the animation state and serves as an interface between your app and the stroke order animation. All attributes and actions of the stroke order diagram are controlled via the StrokeOrderAnimationController and can be changed anytime using the respective setter methods. The StrokeOrderAnimator displays the actual stroke order diagram.
Classes
- QuizSummary
- Information about a stroke order quiz.
- StrokeOrder
- Represents the stroke order of a character.
- StrokeOrderAnimationController
- A ChangeNotifier that controls the behavior of a stroke order diagram.
- StrokeOrderAnimator
- A widget for displaying a stroke order diagram.
Functions
-
downloadStrokeOrder(
String character, Client client) → Future< String> - Downloads stroke order data for a single character.