feat(iOS): use system context menu in iOS(for secure paste)

Author: StayTimeApp

lib/src/editor/config/editor_config.dart

@@ -86,6 +86,7 @@ class QuillEditorConfig {
     this.readOnlyMouseCursor = SystemMouseCursors.text,
     this.onPerformAction,
     @experimental this.customLeadingBlockBuilder,
+    this.useSystemContextMenuItems = false,
   });
 
   @experimental
@@ -471,6 +472,11 @@ class QuillEditorConfig {
   /// Called when a text input action is performed.
   final void Function(TextInputAction action)? onPerformAction;
 
+  /// Show native context menu items on iOS.
+  /// To use the default context menu items on iOS, set this to true.
+  /// Use system context menu can unlock the secure paste feature for iOS
+  final bool useSystemContextMenuItems;
+
   // IMPORTANT For project authors: The copyWith()
   // should be manually updated each time we add or remove a property
 
@@ -531,6 +537,7 @@ class QuillEditorConfig {
     void Function()? onScribbleActivated,
     EdgeInsets? scribbleAreaInsets,
     void Function(TextInputAction action)? onPerformAction,
+    bool? useSystemContextMenuItems,
   }) {
     return QuillEditorConfig(
       customLeadingBlockBuilder:
@@ -600,6 +607,7 @@ class QuillEditorConfig {
       onScribbleActivated: onScribbleActivated ?? this.onScribbleActivated,
       scribbleAreaInsets: scribbleAreaInsets ?? this.scribbleAreaInsets,
       onPerformAction: onPerformAction ?? this.onPerformAction,
+      useSystemContextMenuItems: useSystemContextMenuItems ?? this.useSystemContextMenuItems,
     );
   }
 }

lib/src/editor/editor.dart

@@ -18,6 +18,7 @@ import '../document/nodes/leaf.dart';
 import 'config/editor_config.dart';
 import 'embed/embed_editor_builder.dart';
 import 'raw_editor/config/raw_editor_config.dart';
+import 'raw_editor/quill_system_context_menu.dart';
 import 'raw_editor/raw_editor.dart';
 import 'widgets/box.dart';
 import 'widgets/cursor.dart';
@@ -223,6 +224,29 @@ class QuillEditorState extends State<QuillEditor>
     });
   }
 
+  /// 构建上下文菜单构建器，简化嵌套逻辑
+  QuillEditorContextMenuBuilder? _buildContextMenuBuilder(bool showSelectionToolbar) {
+    if (!showSelectionToolbar) {
+      return null;
+    }
+
+    if (config.useSystemContextMenuItems) {
+      return (context, state) {
+        if (QuillSystemContextMenu.isSupported(context)) {
+          return QuillSystemContextMenu.quillEditor(
+            quillEditorState: state,
+          );
+        }
+        return (config.contextMenuBuilder ??
+                QuillRawEditorConfig.defaultContextMenuBuilder)(
+            context, state);
+      };
+    }
+
+    return config.contextMenuBuilder ??
+        QuillRawEditorConfig.defaultContextMenuBuilder;
+  }
+
   @override
   Widget build(BuildContext context) {
     final theme = Theme.of(context);
@@ -280,10 +304,7 @@ class QuillEditorState extends State<QuillEditor>
         disableClipboard: config.disableClipboard,
         placeholder: config.placeholder,
         onLaunchUrl: config.onLaunchUrl,
-        contextMenuBuilder: showSelectionToolbar
-            ? (config.contextMenuBuilder ??
-                QuillRawEditorConfig.defaultContextMenuBuilder)
-            : null,
+        contextMenuBuilder: _buildContextMenuBuilder(showSelectionToolbar),
         showSelectionHandles: isMobile,
         showCursor: config.showCursor ?? true,
         cursorStyle: CursorStyle(

lib/src/editor/raw_editor/system_context_menu.dart renamed to lib/src/editor/raw_editor/quill_system_context_menu.dart

@@ -8,6 +8,8 @@ library;
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 
+import 'raw_editor_state.dart';
+
 /// Displays the system context menu on top of the Flutter view.
 ///
 /// Currently, only supports iOS 16.0 and above and displays nothing on other
@@ -45,10 +47,10 @@ import 'package:flutter/services.dart';
 ///
 ///  * [SystemContextMenuController], which directly controls the hiding and
 ///    showing of the system context menu.
-class SystemContextMenu extends StatefulWidget {
+class QuillSystemContextMenu extends StatefulWidget {
   /// Creates an instance of [SystemContextMenu] that points to the given
   /// [anchor].
-  const SystemContextMenu._({
+  const QuillSystemContextMenu._({
     super.key,
     required this.anchor,
     required this.items,
@@ -57,15 +59,15 @@ class SystemContextMenu extends StatefulWidget {
 
   /// Creates an instance of [SystemContextMenu] for the field indicated by the
   /// given [EditableTextState].
-  factory SystemContextMenu.editableText({
+  factory QuillSystemContextMenu.editableText({
     Key? key,
     required EditableTextState editableTextState,
     List<IOSSystemContextMenuItem>? items,
   }) {
     final (startGlyphHeight: double startGlyphHeight, endGlyphHeight: double endGlyphHeight) =
     editableTextState.getGlyphHeights();
 
-    return SystemContextMenu._(
+    return QuillSystemContextMenu._(
       key: key,
       anchor: TextSelectionToolbarAnchors.getSelectionRect(
         editableTextState.renderEditable,
@@ -80,6 +82,42 @@ class SystemContextMenu extends StatefulWidget {
     );
   }
 
+
+  /// Creates an instance of [QuillSystemContextMenu] for the field indicated by the
+  /// given [QuillRawEditorState].
+  factory QuillSystemContextMenu.quillEditor({
+    Key? key,
+    required QuillRawEditorState quillEditorState,
+    List<IOSSystemContextMenuItem>? items,
+  }) {
+    final selection = quillEditorState.textEditingValue.selection;
+    final points = quillEditorState.renderEditor.getEndpointsForSelection(selection);
+
+    // Calculate glyph heights manually since _getGlyphHeights is private
+    double startGlyphHeight, endGlyphHeight;
+    if (selection.isValid && !selection.isCollapsed) {
+      final startCharacterRect = quillEditorState.renderEditor.getLocalRectForCaret(selection.base);
+      final endCharacterRect = quillEditorState.renderEditor.getLocalRectForCaret(selection.extent);
+      startGlyphHeight = startCharacterRect.height;
+      endGlyphHeight = endCharacterRect.height;
+    } else {
+      startGlyphHeight = quillEditorState.renderEditor.preferredLineHeight(selection.base);
+      endGlyphHeight = startGlyphHeight;
+    }
+
+    return QuillSystemContextMenu._(
+      key: key,
+      anchor: TextSelectionToolbarAnchors.getSelectionRect(
+        quillEditorState.renderEditor,
+        startGlyphHeight,
+        endGlyphHeight,
+        points,
+      ),
+      items: items ?? getDefaultItemsForQuill(quillEditorState),
+      onSystemHide: quillEditorState.hideToolbar,
+    );
+  }
+
   /// The [Rect] that the context menu should point to.
   final Rect anchor;
 
@@ -130,11 +168,23 @@ class SystemContextMenu extends StatefulWidget {
     ];
   }
 
+  /// Returns the default context menu items for the given [QuillRawEditorState].
+  static List<IOSSystemContextMenuItem> getDefaultItemsForQuill(QuillRawEditorState quillEditorState) {
+    return <IOSSystemContextMenuItem>[
+      if (quillEditorState.copyEnabled) const IOSSystemContextMenuItemCopy(),
+      if (quillEditorState.cutEnabled) const IOSSystemContextMenuItemCut(),
+      if (quillEditorState.pasteEnabled) const IOSSystemContextMenuItemPaste(),
+      if (quillEditorState.selectAllEnabled) const IOSSystemContextMenuItemSelectAll(),
+      if (quillEditorState.lookUpEnabled) const IOSSystemContextMenuItemLookUp(),
+      if (quillEditorState.searchWebEnabled) const IOSSystemContextMenuItemSearchWeb(),
+    ];
+  }
+
   @override
-  State<SystemContextMenu> createState() => _SystemContextMenuState();
+  State<QuillSystemContextMenu> createState() => _SystemContextMenuState();
 }
 
-class _SystemContextMenuState extends State<SystemContextMenu> {
+class _SystemContextMenuState extends State<QuillSystemContextMenu> {
   late final SystemContextMenuController _systemContextMenuController;
 
   @override