Package selection guidance compiled from public package information, community data, and project usage.
Rough Notation is a Flutter package that enables developers to add animated, hand-drawn-style annotations to widgets using CustomPainter. Inspired by the Rough Notation JavaScript library, it brings a sketchy, expressive look to text and UI elements. Ideal for highlighting key parts of content with dynamic, stylized lines and shapes. It supports multiple platforms including Android, iOS, Web, macOS, Windows, and Linux, making it versatile for cross-platform apps. The package integrates smoothly with rich text, markdown, and HTML editors.
Use cases
Highlighting important text in educational apps
Adding expressive annotations in interactive tutorials
Enhancing UIs with hand-drawn style effects
Visualizing data points in dashboards
Creating engaging onboarding experiences
Styling markdown content with dynamic markers
Key features
Animated hand-drawn style lines
Customizable stroke and fill properties
Support for multiple annotation types (underline, box, circle)
Built-in integration with CustomPainter
Cross-platform compatibility
Easy setup via pub add command
Suitable for
Educational and learning applications
Interactive UIs with visual feedback
Designers seeking expressive UI elements
Developers building rich text editors
Apps requiring playful or artistic annotations
Considerations
May impact performance with many annotations
Requires understanding of CustomPainter basics
Limited to 2D canvas rendering
Not ideal for high-performance animations
Best suited for static or low-frequency updates
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
RoughNotation Flutter
A lightweight Flutter package to create animated, hand-drawn-style annotations on widgets.
It uses Flutter’s CustomPainter to render the annotations, supporting config options for styling and animation — including manual triggers, sequencing via groups, and autoplay.
It doesn't matter where widgets are in the widget tree — grouped annotations can live inside deeply nested widgets or even different build scopes. The registry handles sequencing regardless of position.
From Flutter 3.16+, deferred or conditionally built widgets (e.g., in a ListView.builder) won’t throw errors but will skip animations until built.
Delays & Durations: Group sequencing introduces its own delays between elements. Avoid adding large delay values on individual annotations if part of a group.
Controllers & Autoplay: If using RoughAnnotationController(autoPlay: true), ensure the widget is built first. Internally, we use addPostFrameCallback to delay the trigger.
Multiple Controllers: You can reuse the same controller for multiple widgets, but only one annotation may render if others haven't mounted yet.
Lazy Lists / Builders: Widgets in a ListView.builder or similar builders that are not yet mounted will not animate. No crash, but no effect either.
Visual Misalignments: Styling mismatches may occur across platforms. Future updates will improve drawing precision and painter logic.
🧠 What's Next
We’re aiming to improve:
Core painter logic for smoother lines and curves (lib/src/painters)
Extend features and stability of annotation widgets (lib/src/annotations)
Also the controllers & grouped behaviour (lib/src/controllers)
The original JS library uses roughjs. Although there's a Flutter version (rough), it’s outdated and Dart 3 incompatible.
We’re considering reviving or reimplementing it in parts. All contributions are welcome!
If you're looking to contribute, ideal places to start are: