overlay_tutorial library

Classes

OverlayTutorialCircleEntry
Draw a hole as a circle on the widget.
OverlayTutorialCustomShapeEntry
Allows to draw custom shape as a hole on the widget.
OverlayTutorialEntry
Abstract class of Entry.
OverlayTutorialEntryRect
The Rect information of a OverlayTutorialEntry.
OverlayTutorialHole
Crop a hole on child by configuration in overlayTutorialEntry.
OverlayTutorialHoleLayer
OverlayTutorialRectEntry
Draw a hole as a rectangular on the widget.
OverlayTutorialScope
Widget for displaying an overlay on top of UI.
OverlayTutorialScopeModel
OverlayTutorialWidgetHint<T extends OverlayTutorialEntryRect>
This is used for placing custom widget aside your OverlayTutorialEntry. The Rect of the entry's widget is provided.

Typedefs

OverlayTutorialPaintFactory = Path Function(Rect rect, Path path)
  • rect refers to the Rect of OverlayTutorialEntry.widgetKey.

  • path allows to be used for drawing custom shape of the OverlayTutorialEntry.

  • PositionFromEntryFactory = Offset Function(Rect rect)
    rect is the Rect of OverlayTutorialEntry.
    WidgetFromEntryBuilder = Widget Function(BuildContext context, OverlayTutorialEntryRect entryRect)
    Builder factory for hint widget.