Aus öffentlichen Paketdaten erstellte Orientierung.
Rough Notation ist ein Flutter-Paket, das Entwicklern ermöglicht, mithilfe von CustomPainter animierte, handgezeichnete Anmerkungen zu Widgets hinzuzufügen. Inspiriert durch die JavaScript-Bibliothek Rough Notation verleiht es Text- und Benutzeroberflächenelementen einen skizzenhaften, ausdrucksstarken Look. Ideal zum Hervorheben wichtiger Inhaltsabschnitte mit dynamischen, stilisierten Linien und Formen. Unterstützt mehrere Plattformen wie Android, iOS, Web, macOS, Windows und Linux und ist somit vielseitig für plattformübergreifende Apps geeignet. Das Paket lässt sich nahtlos mit Rich-Text-, Markdown- und HTML-Editoren integrieren.
Anwendungsfälle
Wichtigen Text in Bildungs-Apps hervorheben
Ausdrucksstarke Anmerkungen in interaktiven Tutorials hinzufügen
Verbesserung von Benutzeroberflächen mit handgezeichneten Effekten
Datenpunkte in Dashboards visualisieren
Engagierende Onboarding-Erlebnisse erstellen
Styling von Markdown-Inhalten mit dynamischen Markern
Hauptmerkmale
Animierte Handzeichnungs-Stil-Linien
Anpassbare Strich- und Füll-Eigenschaften
Unterstützung für mehrere Anmerkungstypen (Unterstreichen, Rahmen, Kreis)
Eingebaute Integration mit CustomPainter
Plattformübergreifende Kompatibilität
Einfache Einrichtung über den Befehl pub add
Geeignet für
Bildungs- und Lernanwendungen
Interaktive Benutzeroberflächen mit visueller Rückmeldung
Designer, die ausdrucksstarke Benutzeroberflächenelemente suchen
Entwickler, die reichhaltige Texteditoren erstellen
Apps, die spielerische oder künstlerische Anmerkungen erfordern
Hinweise
Kann die Leistung bei vielen Anmerkungen beeinträchtigen
Grundlegendes Verständnis von CustomPainter erforderlich
Beschränkt auf 2D-Canvas-Rendering
Nicht ideal für Hochleistungsanimationen
Am besten geeignet für statische oder gering frequent aktualisierte Daten
Original-README
Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.
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: