showMenu<T> abstract method

OverlayCompleter<T?> showMenu<T>({
  1. required BuildContext context,
  2. required WidgetBuilder builder,
  3. AlignmentGeometry alignment = Alignment.center,
  4. Offset? position,
  5. AlignmentGeometry? anchorAlignment,
  6. PopoverConstraint widthConstraint = PopoverConstraint.flexible,
  7. PopoverConstraint heightConstraint = PopoverConstraint.flexible,
  8. Key? key,
  9. bool rootOverlay = true,
  10. bool modal = true,
  11. bool barrierDismissable = true,
  12. Clip clipBehavior = Clip.none,
  13. Object? regionGroupId,
  14. Offset? offset,
  15. AlignmentGeometry? transitionAlignment,
  16. EdgeInsetsGeometry? margin,
  17. bool follow = true,
  18. bool consumeOutsideTaps = true,
  19. Anchor? anchor,
  20. ValueChanged<PopoverOverlayWidgetState>? onTickFollow,
  21. bool allowInvertHorizontal = true,
  22. bool allowInvertVertical = true,
  23. bool dismissBackdropFocus = true,
  24. Duration? showDuration,
  25. Duration? dismissDuration,
  26. OverlayBarrier? overlayBarrier,
})

Shows a menu overlay.

Specialized method for displaying menus with appropriate defaults for menu behavior (dismissible, follows anchor, etc.).

Parameters similar to show method. See show for full parameter documentation.

Returns an OverlayCompleter for managing the menu lifecycle.

Implementation

OverlayCompleter<T?> showMenu<T>({
  required BuildContext context,
  required WidgetBuilder builder,
  AlignmentGeometry alignment = Alignment.center,
  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,
});