Skip to content
pubscout

overlay_tutorial

3.0.0, released 5 years ago by estrelio.com

Displays overlay tutorials with customizable hole shapes and optional hints.

WASM-ready
$ flutter pub add overlay_tutorial
Source repository

What it does

Provides widgets to create a dimmed overlay with cut‑out holes over target UI elements. Hints can be positioned beside each hole and the overlay appearance is configurable.

AI-written summary of version 3.0.0, based on the package's README and metadata. Report an inaccuracy

Use it when

  • You need to highlight parts of the UI for onboarding or feature tours
  • You want a simple, code‑only way to show focus areas without external libraries

Skip it when

  • You require a full‑featured step‑by‑step tutorial framework
  • You need persistent storage or complex state management for tutorials

Strengths

  • Customizable hole shapes and sizes
  • Easy to integrate with existing widget tree
  • Supports Flutter 3 and multiple platforms

Weaknesses

  • No built‑in step sequencing or tutorial flow control
  • Manual handling of tutorial state is required
  • Limited to overlay UI, no other onboarding features

Setup

Kind
Flutter widgets
Effort
Low
Code generation
No
Direct dependencies
3
Widget build(BuildContext context){
  return OverlayTutorialScope(
    enabled:true,
    overlayColor:Colors.black54,
    child:Stack(
      children:[
        // your UI here
        OverlayTutorialHole(
          enabled:true,
          overlayTutorialEntry:OverlayTutorialRectEntry(
            padding:EdgeInsets.all(8),
            radius:Radius.circular(8),
            overlayTutorialHints:[
              OverlayTutorialWidgetHint(
                builder:(c,entryRect)=>Positioned(
                  top:entryRect.rRect!.bottom+8,
                  child:Text('Tap here'),
                ),
              ),
            ],
          ),
          child:Icon(Icons.add),
        ),
      ],
    ),
  );
}

Alternatives

Packages that do the same job and could replace overlay_tutorial.

Works with

Packages commonly used together with overlay_tutorial: ones it builds on, ones built on it, and its own family.