Skip to content
pubscout

tutorial

1.0.9, released 5 years ago by an unverified publisher

Create tutorial overlays to highlight UI components with focus shapes.

WASM-ready
$ flutter pub add tutorial
Source repository

What it does

The tutorial package displays overlay tutorials on top of your existing UI widgets. It allows you to specify GlobalKeys to focus on specific components, define custom shapes like ovals or squares, and navigate through a sequence of tutorial items.

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

Use it when

  • You need to guide new users through your app's interface features.
  • You want to highlight specific widgets using oval or square focus shapes.

Skip it when

  • You need a complex, highly customized state-driven product tour builder.
  • You require advanced multi-page animation flows beyond simple overlays.

Strengths

  • Easy to set up using GlobalKeys and a list of tutorial items.
  • Supports touch-to-advance or button-to-advance navigation.
  • Supports oval and square focus shapes.

Weaknesses

  • Limited documentation and examples.
  • Relatively old and minimal repository updates.

Setup

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

List<TutorialItens> itens = [
  TutorialItens(
    globalKey: keyMenu,
    touchScreen: true,
    children: [Text("Our menu", style: TextStyle(color: Colors.white, fontSize: 20))],
    shapeFocus: ShapeFocus.oval,
  ),
];

Tutorial.showTutorial(context, itens);

Alternatives

Packages that do the same job and could replace tutorial.

  • flutter_welcome_kit

    A customizable onboarding and tour guide kit for Flutter with spotlight overlays and tooltips.

  • hint_kit

    Toolkit for tooltips, persistent hints, and spotlight guided tours in Flutter.