show<T> method

@override OverlayCompleter<T> show<T>({ required BuildContext context, required AlignmentGeometry alignment, required WidgetBuilder builder, Offset? position, AlignmentGeometry? anchorAlignment, PopoverConstraint widthConstraint = PopoverConstraint.flexible, PopoverConstraint heightConstraint = PopoverConstraint.flexible, Key? key, bool rootOverlay = true, bool modal = true, bool barrierDismissable = true, Clip clipBehavior = Clip.none, Object? regionGroupId, Offset? offset, AlignmentGeometry? transitionAlignment, EdgeInsetsGeometry? margin, bool follow = true, bool consumeOutsideTaps = true, Anchor? anchor, ValueChanged<PopoverOverlayWidgetState>? onTickFollow, bool allowInvertHorizontal = true, bool allowInvertVertical = true, bool dismissBackdropFocus = true, Duration? showDuration, Duration? dismissDuration, OverlayBarrier? overlayBarrier, })

Shows an overlay with the specified configuration.

Displays an overlay (popover, sheet, or dialog) with extensive customization options for positioning, sizing, behavior, and appearance.

Parameters:

• context (BuildContext, required): Build context
• alignment (AlignmentGeometry, required): Overlay alignment
• builder (WidgetBuilder, required): Overlay content builder
• position (Offset?): Explicit position (overrides alignment)
• anchorAlignment (AlignmentGeometry?): Anchor alignment
• widthConstraint (PopoverConstraint): Width constraint, defaults to flexible
• heightConstraint (PopoverConstraint): Height constraint, defaults to flexible
• key (Key?): Widget key
• rootOverlay (bool): Use root overlay, defaults to true
• modal (bool): Modal behavior, defaults to true
• barrierDismissable (bool): Dismissible by tapping barrier, defaults to true
• clipBehavior (Clip): Clipping behavior, defaults to none
• regionGroupId (Object?): Region group ID
• offset (Offset?): Position offset
• transitionAlignment (AlignmentGeometry?): Transition alignment
• margin (EdgeInsetsGeometry?): Overlay margin
• follow (bool): Follow anchor on move, defaults to true
• consumeOutsideTaps (bool): Consume outside taps, defaults to true
• onTickFollow (ValueChanged<PopoverOverlayWidgetState>?): Follow tick callback
• allowInvertHorizontal (bool): Allow horizontal inversion, defaults to true
• allowInvertVertical (bool): Allow vertical inversion, defaults to true
• dismissBackdropFocus (bool): Dismiss on backdrop focus, defaults to true
• showDuration (Duration?): Show animation duration
• dismissDuration (Duration?): Dismiss animation duration
• overlayBarrier (OverlayBarrier?): Custom barrier configuration
• anchor (Anchor?): Anchor to position/track against, defaults to a ContextAnchor wrapping context

Returns an OverlayCompleter for managing the overlay lifecycle.

Implementation

@override
OverlayCompleter<T> show<T>({
  required BuildContext context,
  required AlignmentGeometry alignment,
  required WidgetBuilder builder,
  Offset? position,
  AlignmentGeometry? anchorAlignment,
  PopoverConstraint widthConstraint = PopoverConstraint.flexible,
  PopoverConstraint heightConstraint = PopoverConstraint.flexible,
  Key? key,
  bool rootOverlay = true,
  bool modal = true,
  bool barrierDismissable = true,
  Clip clipBehavior = Clip.none,
  Object? regionGroupId,
  Offset? offset,
  AlignmentGeometry? transitionAlignment,
  EdgeInsetsGeometry? margin,
  bool follow = true,
  bool consumeOutsideTaps = true,
  Anchor? anchor,
  ValueChanged<PopoverOverlayWidgetState>? onTickFollow,
  bool allowInvertHorizontal = true,
  bool allowInvertVertical = true,
  bool dismissBackdropFocus = true,
  Duration? showDuration,
  Duration? dismissDuration,
  OverlayBarrier? overlayBarrier,
}) {
  var navigatorState = Navigator.of(
    context,
    rootNavigator: rootOverlay,
  );
  final CapturedThemes themes =
      InheritedTheme.capture(from: context, to: navigatorState.context);
  final CapturedData data =
      Data.capture(from: context, to: navigatorState.context);
  var dialogRoute = DialogRoute<T>(
    context: context,
    builder: (context) {
      final theme = Theme.of(context);
      final surfaceOpacity = theme.surfaceOpacity;
      var child = DialogOverlayContent(
        route: ModalRoute.of(context) as DialogRoute<T>,
        child: Builder(builder: (context) {
          return builder(context);
        }),
      );
      if (overlayBarrier != null) {
        return MultiModel(
          data: const [
            Model(#shadcn_flutter_dialog_overlay, true),
          ],
          child: ModalBackdrop(
            modal: modal,
            surfaceClip: ModalBackdrop.shouldClipSurface(surfaceOpacity),
            borderRadius: overlayBarrier.borderRadius,
            padding: overlayBarrier.padding,
            barrierColor: overlayBarrier.barrierColor ??
                const Color.fromRGBO(0, 0, 0, 0.8),
            child: child,
          ),
        );
      }
      return MultiModel(
        data: const [
          Model(#shadcn_flutter_dialog_overlay, true),
        ],
        child: child,
      );
    },
    themes: themes,
    barrierDismissible: barrierDismissable,
    barrierColor: overlayBarrier == null
        ? const Color.fromRGBO(0, 0, 0, 0.8)
        : Colors.transparent,
    barrierLabel: 'Dismiss',
    useSafeArea: true,
    data: data,
    traversalEdgeBehavior: TraversalEdgeBehavior.closedLoop,
    transitionBuilder: (context, animation, secondaryAnimation, child) {
      return buildShadcnDialogTransitions(
        context,
        BorderRadius.zero,
        Alignment.center,
        animation,
        secondaryAnimation,
        false,
        child,
      );
    },
    alignment: Alignment.center,
  );
  navigatorState.push(
    dialogRoute,
  );
  return DialogOverlayCompleter(dialogRoute);
}