components/whiteboard_components/whiteboard_components library

Whiteboard Components

This module provides a complete whiteboard implementation for real-time collaborative drawing in MediaSFU applications.

Components:

Classes

ConfigureWhiteboardModal: ConfigureWhiteboardModal - Modal for configuring and managing whiteboard sessions.
ConfigureWhiteboardModalOptions: Options for the ConfigureWhiteboardModal widget.
ConfigureWhiteboardModalParameters: Parameters for the ConfigureWhiteboardModal widget.
Screenboard: Screenboard - Annotation overlay for screen sharing.
ScreenboardModal: ScreenboardModal - A modal component for managing screen annotation overlays.
ScreenboardModalOptions: Options for configuring the ScreenboardModal.
ScreenboardModalParameters: Parameters for the ScreenboardModal widget.
ScreenboardOptions: Options for the Screenboard widget. Matches React ScreenboardOptions interface.
ScreenboardParameters: Parameters for the Screenboard widget. Matches React ScreenboardParameters interface.
Whiteboard: Whiteboard - Real-time collaborative drawing and annotation canvas
WhiteboardOptions: Options for configuring the Whiteboard widget.
WhiteboardPainter: CustomPainter that renders all shapes on the whiteboard canvas.
WhiteboardParameters: Parameters for the Whiteboard widget.
WhiteboardShape: Represents a shape on the whiteboard.
WhiteboardToolbar: Toolbar widget for the whiteboard providing drawing tools and controls.

LineType: Enum representing the different line types for shapes.
ScreenboardMode: Drawing modes for screenboard. Matches React: draw (line), freehand, shape, erase
WhiteboardMode: Represents the current drawing mode of the whiteboard.
WhiteboardShapeType: Enum representing the different types of shapes that can be drawn on the whiteboard.

lineTypeToString(LineType lineType) → String: Converts a LineType to a string representation.
modeToString(WhiteboardMode mode) → String: Converts a WhiteboardMode to a string representation.
shapeTypeToString(WhiteboardShapeType type) → String: Converts a WhiteboardShapeType to a string representation.
stringToLineType(String str) → LineType: Converts a string to a LineType.
stringToShapeType(String str) → WhiteboardShapeType: Converts a string to a WhiteboardShapeType.

ConfigureWhiteboardModalType = Widget Function({required ConfigureWhiteboardModalOptions options}): Type definition for ConfigureWhiteboardModal widget builder.
ScreenboardModalType = Widget Function({required ScreenboardModalOptions options}): Type definition for ScreenboardModal widget builder.
ScreenboardType = Widget Function({required ScreenboardOptions options}): Type definition for the Screenboard widget.
WhiteboardType = Widget Function({required WhiteboardOptions options}): Type definition for Whiteboard widget builder.