showWithItems method

Future<void> showWithItems(
  1. Rect targetRect,
  2. List<IOSSystemContextMenuItemData> items
)

Shows the system context menu anchored on the given Rect with the given buttons.

Currently only supported on iOS 16.0 and later. Check MediaQuery.maybeSupportsShowingSystemContextMenu before calling this.

The Rect represents what the context menu is pointing to. For example, for some text selection, this would be the selection Rect.

items specifies the buttons that appear in the menu. The buttons that appear in the menu will be exactly as given and will not automatically udpate based on the state of the input field. See SystemContextMenu.getDefaultItems for the default items for a given EditableTextState.

Currently this system context menu is bound to text input. Using this without an active TextInputConnection will be a noop.

There can only be one system context menu visible at a time. Calling this while another system context menu is already visible will remove the old menu before showing the new menu.

See also:

Implementation

Future<void> showWithItems(Rect targetRect, List<IOSSystemContextMenuItemData> items) {
  assert(!_isDisposed);
  assert(items.isNotEmpty);
  assert(
    TextInput._instance._currentConnection != null,
    'Currently, the system context menu can only be shown for an active text input connection',
  );

  // Don't show the same thing that's already being shown.
  if (_lastShown != null &&
      _lastShown!.isVisible &&
      _lastShown!._lastTargetRect == targetRect &&
      listEquals(_lastShown!._lastItems, items)) {
    return Future<void>.value();
  }

  assert(
    _lastShown == null || _lastShown == this || !_lastShown!.isVisible,
    'Attempted to show while another instance was still visible.',
  );

  ServicesBinding.systemContextMenuClient = this;

  final List<Map<String, dynamic>> itemsJson =
      items.map<Map<String, dynamic>>((IOSSystemContextMenuItemData item) => item._json).toList();
  _lastTargetRect = targetRect;
  _lastItems = items;
  _lastShown = this;
  _hiddenBySystem = false;
  return _channel.invokeMethod('ContextMenu.showSystemContextMenu', <String, dynamic>{
    'targetRect': <String, double>{
      'x': targetRect.left,
      'y': targetRect.top,
      'width': targetRect.width,
      'height': targetRect.height,
    },
    'items': itemsJson,
  });
}