showBubbleMenu function

Future<BubbleMenuItem?> showBubbleMenu({
  1. required BuildContext context,
  2. required BubbleMenuRequest request,
  3. required BubbleMenuConfiguration configuration,
})

Shows the default popup menu for request at the pointer position.

Returns the chosen entry, or null when the menu was dismissed, had no entries, or the side has no items builder.

Implementation

Future<BubbleMenuItem?> showBubbleMenu({
  required BuildContext context,
  required BubbleMenuRequest request,
  required BubbleMenuConfiguration configuration,
}) async {
  final itemsBuilder = configuration.itemsBuilderFor(request.isSender);
  if (itemsBuilder == null) return null;

  final items = itemsBuilder(context, request);
  if (items.isEmpty) return null;

  final overlay = Overlay.of(
    context,
    rootOverlay: configuration.useRootNavigator,
  ).context.findRenderObject();
  if (overlay is! RenderBox || !overlay.hasSize) return null;

  // globalPosition is in screen coordinates, while showMenu's position is in
  // the Overlay's local coordinates. When the Overlay is scaled or offset (by a
  // FittedBox, for example) the two differ, so using it unconverted would place
  // the menu away from the pointer.
  final pointer = overlay.globalToLocal(request.globalPosition);
  final position = RelativeRect.fromRect(
    Rect.fromPoints(pointer, pointer),
    Offset.zero & overlay.size,
  );

  final selectedIndex = await showMenu<int>(
    context: context,
    position: position,
    color: configuration.color,
    surfaceTintColor: configuration.surfaceTintColor,
    shape: configuration.shape,
    elevation: configuration.elevation,
    constraints: configuration.constraints,
    popUpAnimationStyle: configuration.animationStyle,
    useRootNavigator: configuration.useRootNavigator,
    items: [
      for (int i = 0; i < items.length; i++)
        PopupMenuItem<int>(
          value: i,
          enabled: items[i].enabled,
          height: items[i].height,
          padding: items[i].padding,
          child: items[i].buildContent(context),
        ),
    ],
  );

  if (selectedIndex == null) return null;
  final selected = items[selectedIndex];
  if (context.mounted) selected.onSelected?.call(context, request);
  return selected;
}