showOverlay static method

void showOverlay(
  1. BuildContext context, {
  2. required Widget builder(
    1. void dismiss()
    ),
  3. required Color backgroundColor,
  4. required bool isDismissible,
  5. bool useSafeArea = false,
  6. Alignment builderAlignment = Alignment.center,
  7. OverlayTraceRoute? transitionParams,
})

Shows a custom overlay modal.

The builder provides a dismiss function to close the overlay from within.

Implementation

static void showOverlay(
  BuildContext context, {
  required Widget Function(void Function() dismiss) builder,
  required Color backgroundColor,
  required bool isDismissible,
  bool useSafeArea = false,
  Alignment builderAlignment = Alignment.center,
  OverlayTraceRoute? transitionParams,
}) {
  OverlayManager.of(context)?.showModal(
    Modal(
      content: builder,
      isDismissible: isDismissible,
      useSafeArea: useSafeArea,
      alignment: builderAlignment,
      duration: null,
      transition: transitionParams ??
          OverlayTraceRoute(
            routeTransition: RouteTransition.fade,
            transitionDuration: const Duration(
              milliseconds: 300,
            ),
            reverseTransitionDuration: const Duration(
              milliseconds: 300,
            ),
          ),
      overlayState: Overlay.of(context),
      backgroundColor: backgroundColor,
    ),
  );
}