Pakete, Repositories und App-Kategorien suchen

Cover von rough_notation
Paketdetailsv0.0.3

rough_notation

Erstellen Sie animierte, handgezeichnete Anmerkungen auf Widgets mit Flutter's CustomPainter. Inspiriert durch die Rough Notation JS-Bibliothek.

AndroidiOSWebmacOSWindowsLinux
30-Tage-Downloads
68
Likes
5
Pub-Punkte
160

Paket installieren

flutter pub add rough_notation

Paketübersicht

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.

This package recreates the original Rough Notation experience created by Preet Shihn and the contributors.

It uses Flutter’s CustomPainter to render the annotations, supporting config options for styling and animation — including manual triggers, sequencing via groups, and autoplay.

demo-gif


🌐 Playground

See the landing page which has the complete showcase: 👉 roughnotation-flutter.web.app

It showcases all use cases, animation types, groupings, styling controls, and more — all built with Flutter Web.

Explore source in the playground/ folder.


✨ Features

  • Hand-drawn-style annotations
  • Built-in styles:
    • Underline
    • Box
    • Circle
    • Highlight
    • Strike-through
    • Crossed-off
    • Bracket
  • Supports:
    • Autoplay animation
    • Manual triggers
    • Group-based sequencing
    • WidgetSpan for rich text use 38: - iterations for sketchier multi-stroke effect

📦 Installation

flutter pub add rough_notation

🚀 Usage

Basic Annotation
RoughUnderlineAnnotation(
  child: Text('Flutter is fun!'),
  iterations: 3, // Optional: default is 2
)
With Controller (Manual Trigger)
final controller = RoughAnnotationController();

RoughBoxAnnotation(
  controller: controller,
  child: Text('Boxed text'),
);

// Manually trigger
controller.show();

🧹 RichText with WidgetSpan

SelectableText.rich(
  TextSpan(
    text: 'Create a ',
    children: [
      WidgetSpan(
        alignment: PlaceholderAlignment.baseline,
        baseline: TextBaseline.alphabetic,
        child: RoughUnderlineAnnotation(
          child: Text('underline'),
        ),
      ),
      TextSpan(text: ' on a span.'),
    ],
  ),
);

🔄 Grouped Annotations

Use group and sequence to define a group and control animation order.

RoughUnderlineAnnotation(
  group: 'intro',
  sequence: 1,
  child: Text('Step 1'),
);

RoughBoxAnnotation(
  group: 'intro',
  sequence: 2,
  child: Text('Step 2'),
);

// Trigger animation
RoughAnnotationRegistry.showGroup('intro');
Autoplay a Group on Widget Init
@override
void initState() {
  super.initState();
  RoughAnnotationRegistry.markGroupForAutoStart('groupName');
}
✅ Note:
  • 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.

Optional:

RoughAnnotationRegistry.showGroup(
  'intro',
  delayBetween: Duration(milliseconds: 300),
);

⚠️ Potential Pitfalls & Edge Cases

  • 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:

  • lib/src/painters/
  • lib/src/annotations/

🙏❤️ Acknowledgements

This Flutter package is heavily inspired by the original Rough Notation JS library.

We acknowledge the original creators and contributors of the JS library — including design, animation logic, and documentation.

We are grateful for the coder’s community and the support of open-source enthusiasts everywhere.


📄 License

MIT


🤝 Contributions

Pull requests are welcome. Let’s make annotations ✏️ in Flutter fun and beautiful.

Kategorien

Quell-Repository

Projekte, die dieses Paket verwenden

Noch keine Daten verfügbar.