overlay_manager library

Classes

ContextOverlayManager

Create Manager with BuildContext context, commonly used for one or a small page group managers. Note that each Manager is independent even though it has the same context.

GlobalOverlayManager

Create Manager with GlobalKey

OverlayManager

Overlays can be grouped and managed by an OverlayManager.

OverlayManagerEntry<T>

Every overlay is provided an OverlayManagerEntry. Check the state of overlay by closed flag and close it by close method.

Enums

OverlayMode

The Overlay's mode controls the touchable onto the barrier.

Typedefs

OverlayBuilder<T> = Widget Function(BuildContext context, OverlayManagerEntry<T> entry)

OverlayBuilder returns the overlay a widget to display on the screen, with context and an OverlayManagerEntry entry to manage the overlay.

OverlayDismiss<T> = void Function(T? result)

OverlayDismiss is a callback, it is called when overlay is closed and returns a T result, the result may be null when overlay is closed automated by out click or manager.pop