Skip to content
pubscout

flutter_tutorial_overlay

1.0.6, released 3 months ago by an unverified publisher

Create interactive tutorials and onboarding flows with widget highlights and tooltips.

WASM-ready
$ flutter pub add flutter_tutorial_overlay
Source repository

What it does

Allows developers to build step-by-step guided tours and user instruction overlays in Flutter apps. It highlights specific target widgets using GlobalKeys, displays customizable tooltips, and offers callbacks for user interactions at each step.

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

Use it when

  • You need to guide new users through app features during an onboarding flow.
  • You want to highlight specific UI elements with step-by-step tooltips and descriptions.

Skip it when

  • You require complex state management or dependency injection.
  • You are building a game that requires custom game-loop rendering.

Strengths

  • Easy integration using just a GlobalKey for target widgets.
  • Flexible styling for tooltips, highlights, blur effects, and buttons.
  • Step-specific callbacks for tracking and analytics.

Weaknesses

  • Relies on GlobalKeys to locate targets, which may require refactoring widget trees.
  • Limited to overlay tooltips and guided tours.

Setup

Kind
Flutter widgets
Effort
Low
Code generation
No
Direct dependencies
0
final GlobalKey _buttonKey = GlobalKey();

final steps = [
  TutorialStep(
    targetKey: _buttonKey,
    title: "Welcome!",
    description: "This is your main action button.",
  ),
];

final tutorial = TutorialOverlay(
  context: context,
  steps: steps,
);
tutorial.show();

Alternatives

Packages that do the same job and could replace flutter_tutorial_overlay.