API Overview

The main library is imported via a single barrel file:

import 'package:skribble/skribble.dart';

This exports 89 files covering the full widget set, rough engine, theming, and canvas system.

API layers#

The public API is organized into five layers, from lowest to highest:

1. Rough engine#

The Dart port of rough.js that generates hand-drawn paths.

Key types:

• DrawConfig — roughness, bowing, seed, and curve settings
• Generator — creates Drawable shapes (rectangle, circle, polygon, arc, etc.)
• Filler — abstract fill pattern (HachureFiller, DotFiller, SolidFiller, etc.)
• FillerConfig — gap, angle, dash settings for fillers
• RoughFilter — enum mapping to filler types
• Drawable — output of Generator, contains OpSets for rendering
• PointD — 2D point with double precision
• RoughBoxDecoration — drop-in BoxDecoration replacement
• RoughDrawingStyle — stroke/fill style for decorations
• RoughBoxShape — shape enum (rectangle, roundedRectangle, circle, ellipse)

2. Canvas and painting#

Low-level painting infrastructure.

Key types:

• WiredPainterBase — override paintRough(Canvas, Size, DrawConfig, Filler)
• WiredCanvas — widget that takes a painter + filler type
• WiredPainter — CustomPainter adapter for WiredPainterBase

3. Base utilities#

Shared constants, paint helpers, and repaint isolation.

Key types:

• WiredBase — static fillPainter(Color) and pathPainter(double, {Color})
• WiredBaseWidget — abstract HookWidget with built-in RepaintBoundary
• WiredRepaintMixin — mixin for RepaintBoundary wrapping
• buildWiredElement() — standalone helper function
• WiredRectangleBase, WiredCircleBase, WiredLineBase, WiredRoundedRectangleBase, WiredInvertedTriangleBase — concrete painters
• kWiredButtonHeight — standard button height (42.0)

4. Theme system#

Colors, roughness, and Material bridge.

Key types:

• WiredThemeData — borderColor, textColor, fillColor, strokeWidth, roughness, drawConfig
• WiredTheme — InheritedWidget, accessed via WiredTheme.of(context)
• WiredMaterialApp — MaterialApp wrapper that syncs WiredTheme + Material ThemeData

5. Widgets (80+)#

All widgets follow the Wired* naming convention and extend HookWidget.

Buttons (10)

Inputs (17)

Navigation (13)

Selection (12)

Feedback (13)

Layout (16)

Icons

Package dependencies#

The main library depends on:

Companion packages#

skribble_icons#

import 'package:skribble_icons/skribble_icons.dart';

skribble_emoji#

import 'package:skribble_emoji/skribble_emoji.dart';

API documentation#

Full dartdoc API reference is available at:

• pub.dev/documentation/skribble/latest/