Skip to content
pubscout

overlayment

0.2.1, released 4 years ago by qlevar.de

Manage overlays like dialogs, panels, notifications, windows, and dropdowns easily.

WASM-ready
$ flutter pub add overlayment
Source repository

What it does

Provides a unified system for showing and managing various overlay types on screen such as dialogs, panels, notifications, floating windows, autocomplete suggestions, and expandable dropdowns. Overlays can be triggered imperatively using static methods or declaratively via helper widgets.

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

Use it when

  • You need a simple way to display custom dialogs, notifications, or panels from anywhere in your code.
  • You want built-in support for auto-complete boxes and expandable dropdown widgets.

Skip it when

  • You are using complex routing setups that do not support providing a global NavigatorState or custom router key.

Strengths

  • Supports multiple overlay formats out of the box (dialogs, panels, windows, notifications).
  • Provides helper widgets like OverAutoComplete and OverExpander.
  • Allows background customization, animations, and automatic dismissal timers.

Weaknesses

  • Requires setting a global NavigationKey or passing context every time.
  • Animation documentation in the README is marked as TODO.

Setup

Kind
Flutter widgets
Effort
Low
Code generation
No
Direct dependencies
0

Requires assigning the NavigatorState key to Overlayment.navigationKey at app startup.

Overlayment.show(
    OverDialog(
        child: Text('Hello world'),
    ),
);

Alternatives

Packages that do the same job and could replace overlayment.