搜尋套件、儲存庫與 APP 分類

GitHub 儲存庫0xharkirat/rough_notation

rough_notation

使用 Flutter 的 CustomPainter 在元件上建立動畫的手繪風格註解。靈感來自 Rough Notation JS 庫。

rough_notation 專案封面
星標
5
分支
1
最近推送(UTC)
2026年1月12日
專案狀態
未封存

原始 README

以下為英文專案原文快照,最新內容請造訪 GitHub。

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.

Hark Singh [SSW] GitHub avatar
GitHub 作者

Hark Singh [SSW] ↗

SSW Software Engineer I

@SSWConsulting Newcastle官方網站 ↗
語言DartC++CMakeHTMLSwiftCRubyKotlinObjective-C

分類

此儲存庫發佈的套件

使用的依賴

依賴清單 3 項

  • flutter{"sdk":"flutter"}
  • flutter_test開發依賴{"sdk":"flutter"}
  • flutter_lints開發依賴^5.0.0

如何選擇適合專案的儲存庫?

先依使用情境篩選,再比較專案活躍情況,最後到原始儲存庫確認使用要求。

  1. 透過儲存庫名稱、作者或描述搜尋,再依技術分類縮小範圍。
  2. 綜合星標、分支與最近推送比較專案;星標反映社群關注,不保證品質。
  3. 使用前在 GitHub 確認 README、授權條款與 Issues。

來源與維護

“A repository is the most basic element of GitHub.”

GitHub Docs — About repositories ↗