feat: Use quill_native_bridge as default impl in DefaultClipboardService, fix related bugs in the extensions package

.github/workflows/main.yml

@@ -33,8 +33,32 @@ jobs:
       - name: 📦 Install flutter_quill_test dependencies
         run: flutter pub get -C flutter_quill_test
 
+      # TODO: Remove quill_native_bridge packages from here once moved to it's own repo
+      # https://github.com/singerdmx/flutter-quill/pull/2230
+
       - name: 📦 Install quill_native_bridge dependencies
-        run: flutter pub get -C quill_native_bridge
+        run: flutter pub get -C quill_native_bridge/quill_native_bridge
+
+      - name: 📦 Install quill_native_bridge_platform_interface dependencies
+        run: flutter pub get -C quill_native_bridge/quill_native_bridge_platform_interface
+
+      - name: 📦 Install quill_native_bridge_android dependencies
+        run: flutter pub get -C quill_native_bridge/quill_native_bridge_android
+
+      - name: 📦 Install quill_native_bridge_ios dependencies
+        run: flutter pub get -C quill_native_bridge/quill_native_bridge_ios
+
+      - name: 📦 Install quill_native_bridge_macos dependencies
+        run: flutter pub get -C quill_native_bridge/quill_native_bridge_macos
+
+      - name: 📦 Install quill_native_bridge_windows dependencies
+        run: flutter pub get -C quill_native_bridge/quill_native_bridge_windows
+
+      - name: 📦 Install quill_native_bridge_web dependencies
+        run: flutter pub get -C quill_native_bridge/quill_native_bridge_web
+
+      - name: 📦 Install quill_native_bridge_linux dependencies
+        run: flutter pub get -C quill_native_bridge/quill_native_bridge_linux
 
       - name: 🔍 Run Flutter analysis
         run: flutter analyze

README.md

@@ -59,6 +59,7 @@ You can join our [Slack Group] for discussion.
 - [📦 Embed Blocks](#-embed-blocks)
 - [🔄 Conversion to HTML](#-conversion-to-html)
 - [📝 Spelling checker](#-spelling-checker)
+- [📝 Rich Text Paste](#-rich-text-paste)
 - [✂️ Shortcut events](#-shortcut-events)
 - [🌐 Translation](#-translation)
 - [🧪 Testing](#-testing)
@@ -108,20 +109,57 @@ dependencies:
 
 The `flutter_quill` package uses the following plugins:
 
-1. [`url_launcher`](https://pub.dev/packages/url_launcher) to open links.
-2. [`quill_native_bridge`](https://pub.dev/packages/quill_native_bridge) to access platform-specific APIs for the
+1. [`url_launcher`](https://pub.dev/packages/url_launcher): to open links.
+2. [`quill_native_bridge`](https://pub.dev/packages/quill_native_bridge): to access platform-specific APIs for the
    editor.
 3. [`flutter_keyboard_visibility_temp_fork`](https://pub.dev/packages/flutter_keyboard_visibility_temp_fork) to listen for keyboard
-   visibility
-   changes.
+   visibility changes.
 
-All of them don't require any platform-specific setup.
+### Android Configuration for `quill_native_bridge`
+
+To support copying images to the clipboard to be accessed by other apps, you need to configure your Android project.
+If not set up, a warning will appear in the log during debug mode only.
+
+> [!TIP]
+> This is only required on **Android** for this optional feature.
+> You should be able to copy images and paste them inside the editor without any additional configuration.
+
+**1. Update `AndroidManifest.xml`**
+
+Open `your_project/android/app/src/main/AndroidManifest.xml` and add the following inside the `<application>` tag:
+
+```xml
+<manifest>
+    <application>
+        ...
+        <provider
+            android:name="androidx.core.content.FileProvider"
+            android:authorities="${applicationId}.fileprovider"
+            android:exported="false"
+            android:grantUriPermissions="true" >
+            <meta-data
+                android:name="android.support.FILE_PROVIDER_PATHS"
+                android:resource="@xml/file_paths" />
+        </provider>
+        ...
+    </application>
+</manifest>
+```
+
+**2. Create `file_paths.xml`**
+
+Create the file `your_project/android/app/src/main/res/xml/file_paths.xml` with the following content:
+
+```xml
+<paths>
+    <cache-path name="cache" path="." />
+</paths>
+```
 
 > [!NOTE]
-> Starting from Flutter Quill `9.4.x`, [super_clipboard](https://pub.dev/packages/super_clipboard) has been moved
-> to [FlutterQuill Extensions], to use rich text pasting, support pasting images, and gif files from external apps or
-> websites, take a look
-> at `flutter_quill_extensions` Readme.
+> [super_clipboard](https://pub.dev/packages/super_clipboard) is no longer required
+> in recent versions of Flutter Quill in `flutter_quill` or `flutter_quill_extensions`.
+> `quill_native_bridge` is a plugin provide clipboard operations functionality for `flutter_quill`.
 
 ## 🚀 Usage
 
@@ -307,6 +345,21 @@ The following packages can be used:
 This feature is currently not implemented and is being planned. Refer to [#2246](https://github.com/singerdmx/flutter-quill/issues/2246)
 for discussion.
 
+## 📝 Rich Text Paste
+
+The Rich Text Pasting feature requires platform code to access HTML from
+the system clipboard, [`quill_native_bridge`](https://pub.dev/packages/quill_native_bridge) 
+is a plugin to provide this functionality.
+
+Rich clipboard operations are currently experimental and might be removed in future releases.
+
+<!-- TODO: Provide a clean way to disable each feature and document it in here -->
+
+> [!IMPORTANT]
+> Currently this feature is not supported on the web.
+> [Issue #1998](https://github.com/singerdmx/flutter-quill/issues/1998) and [Issue #2220](https://github.com/singerdmx/flutter-quill/issues/2220)
+ for more details
+
 ## ✂️ Shortcut events
 
 We can customize some Shorcut events, using the parameters `characterShortcutEvents` or `spaceShortcutEvents` from `QuillEditorConfigurations` to add more functionality to our editor. 

example/android/app/src/main/AndroidManifest.xml

@@ -62,5 +62,16 @@
             android:authorities="com.example.example.SuperClipboardDataProvider"
             android:exported="true"
             android:grantUriPermissions="true" />
+
+        <!-- For `quill_native_bridge` plugin https://github.com/singerdmx/flutter-quill#-platform-specific-configurations -->
+        <provider
+            android:name="androidx.core.content.FileProvider"
+            android:authorities="${applicationId}.fileprovider"
+            android:exported="false"
+            android:grantUriPermissions="true" >
+            <meta-data
+                android:name="android.support.FILE_PROVIDER_PATHS"
+                android:resource="@xml/file_paths" />
+        </provider>
     </application>
 </manifest>

example/android/app/src/main/res/xml/file_paths.xml

@@ -0,0 +1,3 @@
+<paths>
+    <cache-path name="cache" path="." />
+</paths>

example/lib/main.dart

@@ -7,7 +7,6 @@ import 'package:flutter_localizations/flutter_localizations.dart'
         GlobalWidgetsLocalizations;
 import 'package:flutter_quill/flutter_quill.dart' show Document;
 import 'package:flutter_quill/translations.dart' show FlutterQuillLocalizations;
-import 'package:flutter_quill_extensions/flutter_quill_extensions.dart';
 
 import 'screens/home/widgets/home_screen.dart';
 import 'screens/quill/quill_screen.dart';
@@ -20,8 +19,8 @@ import 'screens/settings/widgets/settings_screen.dart';
 
 void main() async {
   WidgetsFlutterBinding.ensureInitialized();
-  // ignore: deprecated_member_use
-  FlutterQuillExtensions.useSuperClipboardPlugin();
+  // TODO: https://github.com/singerdmx/flutter-quill/pull/2230 and related issues
+  // FlutterQuillExtensions.useSuperClipboardPlugin();
   runApp(const MyApp());
 }
 

example/macos/Flutter/GeneratedPluginRegistrant.swift

@@ -11,6 +11,7 @@ import file_selector_macos
 import gal
 import irondash_engine_context
 import path_provider_foundation
+import quill_native_bridge_macos
 import share_plus
 import sqflite
 import super_native_extensions
@@ -24,6 +25,7 @@ func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) {
   GalPlugin.register(with: registry.registrar(forPlugin: "GalPlugin"))
   IrondashEngineContextPlugin.register(with: registry.registrar(forPlugin: "IrondashEngineContextPlugin"))
   PathProviderPlugin.register(with: registry.registrar(forPlugin: "PathProviderPlugin"))
+  QuillNativeBridgePlugin.register(with: registry.registrar(forPlugin: "QuillNativeBridgePlugin"))
   SharePlusMacosPlugin.register(with: registry.registrar(forPlugin: "SharePlusMacosPlugin"))
   SqflitePlugin.register(with: registry.registrar(forPlugin: "SqflitePlugin"))
   SuperNativeExtensionsPlugin.register(with: registry.registrar(forPlugin: "SuperNativeExtensionsPlugin"))

example/macos/Podfile.lock

@@ -18,6 +18,8 @@ PODS:
   - path_provider_foundation (0.0.1):
     - Flutter
     - FlutterMacOS
+  - quill_native_bridge (0.0.1):
+    - FlutterMacOS
   - share_plus (0.0.1):
     - FlutterMacOS
   - sqflite (0.0.3):
@@ -40,6 +42,7 @@ DEPENDENCIES:
   - gal (from `Flutter/ephemeral/.symlinks/plugins/gal/darwin`)
   - irondash_engine_context (from `Flutter/ephemeral/.symlinks/plugins/irondash_engine_context/macos`)
   - path_provider_foundation (from `Flutter/ephemeral/.symlinks/plugins/path_provider_foundation/darwin`)
+  - quill_native_bridge (from `Flutter/ephemeral/.symlinks/plugins/quill_native_bridge/macos`)
   - share_plus (from `Flutter/ephemeral/.symlinks/plugins/share_plus/macos`)
   - sqflite (from `Flutter/ephemeral/.symlinks/plugins/sqflite/darwin`)
   - super_native_extensions (from `Flutter/ephemeral/.symlinks/plugins/super_native_extensions/macos`)
@@ -67,6 +70,8 @@ EXTERNAL SOURCES:
     :path: Flutter/ephemeral/.symlinks/plugins/irondash_engine_context/macos
   path_provider_foundation:
     :path: Flutter/ephemeral/.symlinks/plugins/path_provider_foundation/darwin
+  quill_native_bridge:
+    :path: Flutter/ephemeral/.symlinks/plugins/quill_native_bridge/macos
   share_plus:
     :path: Flutter/ephemeral/.symlinks/plugins/share_plus/macos
   sqflite:
@@ -88,6 +93,7 @@ SPEC CHECKSUMS:
   irondash_engine_context: da62996ee25616d2f01bbeb85dc115d813359478
   OrderedSet: aaeb196f7fef5a9edf55d89760da9176ad40b93c
   path_provider_foundation: 2b6b4c569c0fb62ec74538f866245ac84301af46
+  quill_native_bridge: 1a3a4bfab7cbe4ed0232a17d8aae201a3ce6d302
   share_plus: 36537c04ce0c3e3f5bd297ce4318b6d5ee5fd6cf
   sqflite: 673a0e54cc04b7d6dba8d24fb8095b31c3a99eec
   super_native_extensions: 85efee3a7495b46b04befcfc86ed12069264ebf3

example/pubspec.yaml

@@ -58,6 +58,18 @@ dependency_overrides:
     path: ../flutter_quill_extensions
   flutter_quill_test:
     path: ../flutter_quill_test
+  quill_native_bridge:
+    path: ../quill_native_bridge/quill_native_bridge
+  quill_native_bridge_platform_interface:
+    path: ../quill_native_bridge/quill_native_bridge_platform_interface
+  quill_native_bridge_linux:
+    path: ../quill_native_bridge/quill_native_bridge_linux
+  quill_native_bridge_android:
+    path: ../quill_native_bridge/quill_native_bridge_android
+  quill_native_bridge_ios:
+    path: ../quill_native_bridge/quill_native_bridge_ios
+  quill_native_bridge_macos:
+    path: ../quill_native_bridge/quill_native_bridge_macos
 
 
 dev_dependencies:

flutter_quill_extensions/README.md

@@ -50,11 +50,6 @@ The package uses the following plugins:
    platform-specific setup.
 2. [`image_picker`](https://pub.dev/packages/image_picker) for picking images.
    See the [Installation](https://pub.dev/packages/image_picker#installation) section.
-3. [`super_clipboard`](https://pub.dev/packages/super_clipboard) which needs some setup on Android only, it's used to
-   support copying images and pasting them into editor, it's also required to support rich text pasting feature on
-   non-web platforms, Open the [Android Support](https://pub.dev/packages/super_clipboard#android-support) page for
-   instructions.
-   The `minSdkVersion` for **Android** is `23` as `super_clipboard` requires it
 
 ### Loading Images from the Internet
 
@@ -151,35 +146,8 @@ This works only for non-web platforms.
 
 ### 📝 Rich Text Paste Feature
 
-The Rich Text Pasting feature requires native code to access
-the `Clipboard` data as HTML, the plugin `super_clipboard` is required on all platforms except Web.
-
-This package already includes `super_clipboard` and will be used internally in this package, to use it
-in `flutter_quill`, call this function before using any of the widgets or functionalities:
-
-```dart
-FlutterQuillExtensions.useSuperClipboardPlugin();
-```
-
-`super_clipboard` is a comprehensive plugin that provides many clipboard features for reading and writing rich text,
-images and other formats.
-
-Calling this function will allow `flutter_quill` to use modern rich text features to paste HTML and Markdown,
-support for GIF files, and other formats.
-
-> [!IMPORTANT]
-> On web platforms, you can only get the HTML from `Clipboard` on the
-> `paste` event, `super_clipboard`, or any plugin is not required.
-> The paste feature will not work using the standard paste hotkey logic.
-> As such, you will be unable to use the **Rich Text Paste Feature** on a button or in the web app itself.
-> So you might want to either display a dialog when pressing the paste button that explains the limitation and shows the
-> hotkey they need to press in order to paste or develop an extension for the browser that bypasses this limitation
-> similarly to **Google Docs** and provide a link to install the browser extension.
-> See [Issue #1998](https://github.com/singerdmx/flutter-quill/issues/1998) for more details.
-
-> [!NOTE]
-> We're still planning on how this should be implemented in
-> [Issue #1998](https://github.com/singerdmx/flutter-quill/issues/1998).
+The rich text paste feature is now supported directly in `flutter_quill` 
+as platform code is not bundled with the project.
 
 ### 🖼️ Image Assets
 

flutter_quill_extensions/lib/flutter_quill_extensions.dart

@@ -1,7 +1,7 @@
 library;
 
-// ignore: implementation_imports
-import 'package:flutter_quill/src/editor_toolbar_controller_shared/clipboard/clipboard_service_provider.dart';
+import 'package:flutter_quill/flutter_quill_internal.dart'
+    show ClipboardServiceProvider;
 import 'package:meta/meta.dart' show experimental;
 
 import 'src/editor_toolbar_controller_shared/clipboard/super_clipboard_service.dart';

flutter_quill_extensions/lib/src/common/utils/utils.dart

@@ -1,8 +1,6 @@
 import 'dart:io' show File;
 
-import 'package:cross_file/cross_file.dart';
-import 'package:flutter/foundation.dart' show Uint8List, immutable;
-import 'package:http/http.dart' as http;
+import 'package:flutter/foundation.dart' show immutable;
 
 import '../../editor/image/widgets/image.dart';
 import '../../editor_toolbar_shared/image_saver/s_image_saver.dart';
@@ -51,23 +49,6 @@ class SaveImageResult {
   final SaveImageResultMethod method;
 }
 
-Future<Uint8List?> convertImageToUint8List(String image) async {
-  if (isHttpBasedUrl(image)) {
-    final response = await http.get(Uri.parse(image));
-    if (response.statusCode == 200) {
-      return Uint8List.fromList(response.bodyBytes);
-    }
-    return null;
-  }
-  // TODO: Add support for all image providers like AssetImage
-  try {
-    final file = XFile(image);
-    return await file.readAsBytes();
-  } catch (e) {
-    return null;
-  }
-}
-
 Future<SaveImageResult> saveImage({
   required String imageUrl,
   required ImageSaverService imageSaverService,

flutter_quill_extensions/lib/src/editor/image/image_embed.dart

@@ -29,8 +29,6 @@ class QuillEditorImageEmbedBuilder extends EmbedBuilder {
     bool inline,
     TextStyle textStyle,
   ) {
-    // assert(!kIsWeb, 'Please provide image EmbedBuilder for Web');
-
     final imageSource = standardizeImageUrl(node.value.data);
     final ((imageSize), margin, alignment) = getElementAttributes(
       node,
@@ -40,7 +38,7 @@ class QuillEditorImageEmbedBuilder extends EmbedBuilder {
     final width = imageSize.width;
     final height = imageSize.height;
 
-    final image = getImageWidgetByImageSource(
+    final imageWidget = getImageWidgetByImageSource(
       context: context,
       imageSource,
       imageProviderBuilder: configurations.imageProviderBuilder,
@@ -72,6 +70,7 @@ class QuillEditorImageEmbedBuilder extends EmbedBuilder {
               imageSize: imageSize,
               isReadOnly: readOnly,
               imageSaverService: imageSaverService,
+              imageProvider: imageWidget.image,
             ),
           ),
         );
@@ -81,10 +80,10 @@ class QuillEditorImageEmbedBuilder extends EmbedBuilder {
           if (margin != null) {
             return Padding(
               padding: EdgeInsets.all(margin),
-              child: image,
+              child: imageWidget,
             );
           }
-          return image;
+          return imageWidget;
         },
       ),
     );