Merge remote-tracking branch 'origin/embedBuilder' into embedBuilder

CHANGELOG.md

@@ -4,6 +4,29 @@
 
 All notable changes to this project will be documented in this file.
 
+## 10.1.1
+
+* Toolbar dividers fixes + Docs updates by @troyanskiy in https://github.com/singerdmx/flutter-quill/pull/2071
+
+## New Contributors
+* @troyanskiy made their first contribution in https://github.com/singerdmx/flutter-quill/pull/2071
+
+**Full Changelog**: https://github.com/singerdmx/flutter-quill/compare/v10.1.0...v10.1.1
+
+## 10.1.0
+
+* Feat: support for customize copy and cut Embeddables to Clipboard by @CatHood0 in https://github.com/singerdmx/flutter-quill/pull/2067
+
+
+**Full Changelog**: https://github.com/singerdmx/flutter-quill/compare/v10.0.10...v10.1.0
+
+## 10.0.10
+
+* fix: Hide selection toolbar if editor loses focus by @huandu in https://github.com/singerdmx/flutter-quill/pull/2066
+
+
+**Full Changelog**: https://github.com/singerdmx/flutter-quill/compare/v10.0.9...v10.0.10
+
 ## 10.0.9
 
 * Fix: manual checking of directionality by @CatHood0 in https://github.com/singerdmx/flutter-quill/pull/2063

README.md

@@ -94,7 +94,8 @@ dependencies:
 ```yaml
 dependencies:
   flutter_quill:
-    git: https://github.com/singerdmx/flutter-quill.git
+    git: 
+      url: https://github.com/singerdmx/flutter-quill.git
       ref: v<latest-version-here>
 ```
 

dart_quill_delta/CHANGELOG.md

@@ -4,6 +4,29 @@
 
 All notable changes to this project will be documented in this file.
 
+## 10.1.1
+
+* Toolbar dividers fixes + Docs updates by @troyanskiy in https://github.com/singerdmx/flutter-quill/pull/2071
+
+## New Contributors
+* @troyanskiy made their first contribution in https://github.com/singerdmx/flutter-quill/pull/2071
+
+**Full Changelog**: https://github.com/singerdmx/flutter-quill/compare/v10.1.0...v10.1.1
+
+## 10.1.0
+
+* Feat: support for customize copy and cut Embeddables to Clipboard by @CatHood0 in https://github.com/singerdmx/flutter-quill/pull/2067
+
+
+**Full Changelog**: https://github.com/singerdmx/flutter-quill/compare/v10.0.10...v10.1.0
+
+## 10.0.10
+
+* fix: Hide selection toolbar if editor loses focus by @huandu in https://github.com/singerdmx/flutter-quill/pull/2066
+
+
+**Full Changelog**: https://github.com/singerdmx/flutter-quill/compare/v10.0.9...v10.0.10
+
 ## 10.0.9
 
 * Fix: manual checking of directionality by @CatHood0 in https://github.com/singerdmx/flutter-quill/pull/2063

dart_quill_delta/pubspec.yaml

@@ -1,6 +1,6 @@
 name: dart_quill_delta
 description: A port of quill-js-delta from typescript to dart
-version: 10.0.9
+version: 10.1.1
 homepage: https://github.com/singerdmx/flutter-quill/tree/master/dart_quill_delta/
 repository: https://github.com/singerdmx/flutter-quill/tree/master/dart_quill_delta/
 issue_tracker: https://github.com/singerdmx/flutter-quill/issues/

flutter_quill_extensions/CHANGELOG.md

@@ -4,6 +4,29 @@
 
 All notable changes to this project will be documented in this file.
 
+## 10.1.1
+
+* Toolbar dividers fixes + Docs updates by @troyanskiy in https://github.com/singerdmx/flutter-quill/pull/2071
+
+## New Contributors
+* @troyanskiy made their first contribution in https://github.com/singerdmx/flutter-quill/pull/2071
+
+**Full Changelog**: https://github.com/singerdmx/flutter-quill/compare/v10.1.0...v10.1.1
+
+## 10.1.0
+
+* Feat: support for customize copy and cut Embeddables to Clipboard by @CatHood0 in https://github.com/singerdmx/flutter-quill/pull/2067
+
+
+**Full Changelog**: https://github.com/singerdmx/flutter-quill/compare/v10.0.10...v10.1.0
+
+## 10.0.10
+
+* fix: Hide selection toolbar if editor loses focus by @huandu in https://github.com/singerdmx/flutter-quill/pull/2066
+
+
+**Full Changelog**: https://github.com/singerdmx/flutter-quill/compare/v10.0.9...v10.0.10
+
 ## 10.0.9
 
 * Fix: manual checking of directionality by @CatHood0 in https://github.com/singerdmx/flutter-quill/pull/2063

flutter_quill_extensions/README.md

@@ -50,9 +50,10 @@ dependencies:
 ```yaml
 dependencies:
   flutter_quill_extensions:
-    git: https://github.com/singerdmx/flutter-quill.git
-    path: flutter_quill_extensions
+    git: 
+      url: https://github.com/singerdmx/flutter-quill.git
       ref: v<latest-version-here>
+      path: flutter_quill_extensions
 ```
 
 ## 🛠 Platform Specific Configurations
@@ -103,8 +104,8 @@ Set the `embedBuilders` and `embedToolbar` params in configurations of `QuillEdi
 
 **Quill Toolbar**:
 ```dart
-QuillToolbar(
-  configurations: QuillToolbarConfigurations(
+QuillToolbar.simple(
+  configurations: QuillSimpleToolbarConfigurations(
     embedButtons: FlutterQuillEmbeds.toolbarButtons(),
   ),
 ),

flutter_quill_extensions/pubspec.yaml

@@ -1,6 +1,6 @@
 name: flutter_quill_extensions
 description: Embed extensions for flutter_quill including image, video, formula and etc.
-version: 10.0.9
+version: 10.1.1
 homepage: https://github.com/singerdmx/flutter-quill/tree/master/flutter_quill_extensions/
 repository: https://github.com/singerdmx/flutter-quill/tree/master/flutter_quill_extensions/
 issue_tracker: https://github.com/singerdmx/flutter-quill/issues/

flutter_quill_test/CHANGELOG.md

@@ -4,6 +4,29 @@
 
 All notable changes to this project will be documented in this file.
 
+## 10.1.1
+
+* Toolbar dividers fixes + Docs updates by @troyanskiy in https://github.com/singerdmx/flutter-quill/pull/2071
+
+## New Contributors
+* @troyanskiy made their first contribution in https://github.com/singerdmx/flutter-quill/pull/2071
+
+**Full Changelog**: https://github.com/singerdmx/flutter-quill/compare/v10.1.0...v10.1.1
+
+## 10.1.0
+
+* Feat: support for customize copy and cut Embeddables to Clipboard by @CatHood0 in https://github.com/singerdmx/flutter-quill/pull/2067
+
+
+**Full Changelog**: https://github.com/singerdmx/flutter-quill/compare/v10.0.10...v10.1.0
+
+## 10.0.10
+
+* fix: Hide selection toolbar if editor loses focus by @huandu in https://github.com/singerdmx/flutter-quill/pull/2066
+
+
+**Full Changelog**: https://github.com/singerdmx/flutter-quill/compare/v10.0.9...v10.0.10
+
 ## 10.0.9
 
 * Fix: manual checking of directionality by @CatHood0 in https://github.com/singerdmx/flutter-quill/pull/2063

flutter_quill_test/pubspec.yaml

@@ -1,6 +1,6 @@
 name: flutter_quill_test
 description: Test utilities for flutter_quill which includes methods to simplify interacting with the editor in test cases.
-version: 10.0.9
+version: 10.1.1
 homepage: https://github.com/singerdmx/flutter-quill/tree/master/flutter_quill_test/
 repository: https://github.com/singerdmx/flutter-quill/tree/master/flutter_quill_test/
 issue_tracker: https://github.com/singerdmx/flutter-quill/issues/

lib/flutter_quill.dart

@@ -28,6 +28,9 @@ export 'src/editor/style_widgets/style_widgets.dart';
 export 'src/editor/widgets/cursor.dart';
 export 'src/editor/widgets/default_styles.dart';
 export 'src/editor/widgets/link.dart';
+export 'src/editor_toolbar_controller_shared/copy_cut_service/copy_cut_service.dart';
+export 'src/editor_toolbar_controller_shared/copy_cut_service/copy_cut_service_provider.dart';
+export 'src/editor_toolbar_controller_shared/copy_cut_service/default_copy_cut_service.dart';
 export 'src/editor_toolbar_controller_shared/quill_configurations.dart';
 export 'src/editor_toolbar_shared/quill_configurations_ext.dart';
 export 'src/toolbar/base_toolbar.dart';

lib/src/document/nodes/line.dart

@@ -6,6 +6,7 @@ import '../../../../quill_delta.dart';
 import '../../common/structs/offset_value.dart';
 import '../../editor/config/editor_configurations.dart';
 import '../../editor/embed/embed_editor_builder.dart';
+import '../../editor_toolbar_controller_shared/copy_cut_service/copy_cut_service_provider.dart';
 import '../attribute.dart';
 import '../style.dart';
 import 'block.dart';
@@ -524,7 +525,21 @@ base class Line extends QuillContainer<Leaf?> {
     final text =
         node.toPlainText(config?.embedBuilders, config?.unknownEmbedBuilder);
     if (text == Embed.kObjectReplacementCharacter) {
-      buffer.write(Embed.kObjectReplacementCharacter);
+      final embed = node.value as Embeddable;
+      final provider = CopyCutServiceProvider.instance;
+      // By default getCopyCutAction just return the same operation
+      // returning Embed.kObjectReplacementCharacter for the buffer
+      final action = provider.getCopyCutAction(embed.type);
+      final data = action.call(embed.data);
+      // This conditional avoid an issue where the plain data copied
+      // to the clipboard, when it is pasted on the editor
+      // the content has a unexpected behaviors
+      if (data != Embed.kObjectReplacementCharacter) {
+        buffer.write(data);
+        return remaining;
+      } else {
+        buffer.write(action.call(data));
+      }
       return remaining - node.length;
     }
 

lib/src/editor_toolbar_controller_shared/copy_cut_service/copy_cut_service.dart

@@ -0,0 +1,13 @@
+import 'package:flutter/foundation.dart';
+
+typedef CopyCutAction = Object? Function(dynamic data);
+
+/// An abstraction to make it easy to provide different implementations
+/// For copy or cut actions from a Line (just for embeddable blocks)
+@immutable
+abstract class CopyCutService {
+  /// Get the CopyCutAction by the type
+  /// of the embeddable (this type is decided by
+  /// the property type of that class)
+  CopyCutAction getCopyCutAction(String type);
+}

lib/src/editor_toolbar_controller_shared/copy_cut_service/copy_cut_service_provider.dart

@@ -0,0 +1,19 @@
+import 'package:flutter/foundation.dart' show immutable;
+import 'copy_cut_service.dart';
+import 'default_copy_cut_service.dart';
+
+@immutable
+class CopyCutServiceProvider {
+  const CopyCutServiceProvider._();
+  static CopyCutService _instance = DefaultCopyCutService();
+
+  static CopyCutService get instance => _instance;
+
+  static void setInstance(CopyCutService service) {
+    _instance = service;
+  }
+
+  static void setInstanceToDefault() {
+    _instance = DefaultCopyCutService();
+  }
+}

lib/src/editor_toolbar_controller_shared/copy_cut_service/default_copy_cut_service.dart

@@ -0,0 +1,14 @@
+import '../../document/nodes/leaf.dart';
+import 'copy_cut_service.dart';
+
+/// Default implementation for [CopyCutService]
+///
+/// This implementation always return the default embed character
+/// replacemenet ([\uFFFC]) to work with the embeds from the internal
+/// flutter quill plugins
+class DefaultCopyCutService extends CopyCutService {
+  @override
+  CopyCutAction getCopyCutAction(String type) {
+    return (data) => Embed.kObjectReplacementCharacter;
+  }
+}

lib/src/toolbar/simple_toolbar.dart

@@ -23,34 +23,6 @@ class QuillSimpleToolbar extends StatelessWidget
   Widget build(BuildContext context) {
     final theEmbedButtons = configurations.embedButtons;
 
-    final isButtonGroupShown = [
-      configurations.showFontFamily ||
-          configurations.showFontSize ||
-          configurations.showBoldButton ||
-          configurations.showItalicButton ||
-          configurations.showSmallButton ||
-          configurations.showUnderLineButton ||
-          configurations.showLineHeightButton ||
-          configurations.showStrikeThrough ||
-          configurations.showInlineCode ||
-          configurations.showColorButton ||
-          configurations.showBackgroundColorButton ||
-          configurations.showClearFormat ||
-          theEmbedButtons?.isNotEmpty == true,
-      configurations.showLeftAlignment ||
-          configurations.showCenterAlignment ||
-          configurations.showRightAlignment ||
-          configurations.showJustifyAlignment ||
-          configurations.showDirection,
-      configurations.showHeaderStyle,
-      configurations.showListNumbers ||
-          configurations.showListBullets ||
-          configurations.showListCheck ||
-          configurations.showCodeBlock,
-      configurations.showQuote || configurations.showIndent,
-      configurations.showLink || configurations.showSearchButton
-    ];
-
     List<Widget> childrenBuilder(BuildContext context) {
       final toolbarConfigurations =
           context.requireQuillSimpleToolbarConfigurations;
@@ -68,7 +40,8 @@ class QuillSimpleToolbar extends StatelessWidget
             space: configurations.sectionDividerSpace,
           ));
 
-      return [
+      final groups = [
+        [
           if (configurations.showUndo)
             QuillToolbarHistoryButton(
               isUndo: true,
@@ -163,18 +136,13 @@ class QuillSimpleToolbar extends StatelessWidget
                   globalIconSize ?? kDefaultIconSize,
                   context.quillToolbarBaseButtonOptions?.iconTheme,
                   configurations.dialogTheme),
-        if (configurations.showDividers &&
-            isButtonGroupShown[0] &&
-            (isButtonGroupShown[1] ||
-                isButtonGroupShown[2] ||
-                isButtonGroupShown[3] ||
-                isButtonGroupShown[4] ||
-                isButtonGroupShown[5]))
-          divider,
+        ],
+        [
           if (configurations.showAlignmentButtons)
             QuillToolbarSelectAlignmentButtons(
               controller: globalController,
-            options: toolbarConfigurations.buttonOptions.selectAlignmentButtons
+              options: toolbarConfigurations
+                  .buttonOptions.selectAlignmentButtons
                   .copyWith(
                 showLeftAlignment: configurations.showLeftAlignment,
                 showCenterAlignment: configurations.showCenterAlignment,
@@ -188,13 +156,8 @@ class QuillSimpleToolbar extends StatelessWidget
               options: toolbarConfigurations.buttonOptions.direction,
               controller: globalController,
             ),
-        if (configurations.showDividers &&
-            isButtonGroupShown[1] &&
-            (isButtonGroupShown[2] ||
-                isButtonGroupShown[3] ||
-                isButtonGroupShown[4] ||
-                isButtonGroupShown[5]))
-          divider,
+        ],
+        [
           if (configurations.showLineHeightButton)
             QuillToolbarSelectLineHeightStyleDropdownButton(
               controller: globalController,
@@ -211,17 +174,12 @@ class QuillSimpleToolbar extends StatelessWidget
             else
               QuillToolbarSelectHeaderStyleButtons(
                 controller: globalController,
-              options:
-                  toolbarConfigurations.buttonOptions.selectHeaderStyleButtons,
+                options: toolbarConfigurations
+                    .buttonOptions.selectHeaderStyleButtons,
               ),
           ],
-        if (configurations.showDividers &&
-            configurations.showHeaderStyle &&
-            isButtonGroupShown[2] &&
-            (isButtonGroupShown[3] ||
-                isButtonGroupShown[4] ||
-                isButtonGroupShown[5]))
-          divider,
+        ],
+        [
           if (configurations.showListNumbers)
             QuillToolbarToggleStyleButton(
               attribute: Attribute.ol,
@@ -245,11 +203,8 @@ class QuillSimpleToolbar extends StatelessWidget
               options: toolbarConfigurations.buttonOptions.codeBlock,
               controller: globalController,
             ),
-        if (configurations.showDividers &&
-            isButtonGroupShown[3] &&
-            (isButtonGroupShown[4] || isButtonGroupShown[5])) ...[
-          divider,
         ],
+        [
           if (configurations.showQuote)
             QuillToolbarToggleStyleButton(
               options: toolbarConfigurations.buttonOptions.quote,
@@ -268,10 +223,8 @@ class QuillSimpleToolbar extends StatelessWidget
               isIncrease: false,
               options: toolbarConfigurations.buttonOptions.indentDecrease,
             ),
-        if (configurations.showDividers &&
-            isButtonGroupShown[4] &&
-            isButtonGroupShown[5])
-          divider,
+        ],
+        [
           if (configurations.showLink)
             toolbarConfigurations.linkStyleType.isOriginal
                 ? QuillToolbarLinkStyleButton(
@@ -311,8 +264,8 @@ class QuillSimpleToolbar extends StatelessWidget
               controller: globalController,
               clipboardAction: ClipboardAction.paste,
             ),
-        if (configurations.customButtons.isNotEmpty) ...[
-          if (configurations.showDividers) divider,
+        ],
+        [
           for (final customButton in configurations.customButtons)
             QuillToolbarCustomButton(
               options: customButton,
@@ -320,6 +273,21 @@ class QuillSimpleToolbar extends StatelessWidget
             ),
         ],
       ];
+
+      final buttonsAll = <Widget>[];
+
+      for (var i = 0; i < groups.length; i++) {
+        final buttons = groups[i];
+
+        if (buttons.isNotEmpty) {
+          if (buttonsAll.isNotEmpty) {
+            buttonsAll.add(divider);
+          }
+          buttonsAll.addAll(buttons);
+        }
+      }
+
+      return buttonsAll;
     }
 
     return QuillSimpleToolbarProvider(

pubspec.yaml

@@ -1,6 +1,6 @@
 name: flutter_quill
 description: A rich text editor built for the modern Android, iOS, web and desktop platforms. It is the WYSIWYG editor and a Quill component for Flutter.
-version: 10.0.9
+version: 10.1.1
 homepage: https://1o24bbs.com/c/bulletjournal/108/
 repository: https://github.com/singerdmx/flutter-quill/
 issue_tracker: https://github.com/singerdmx/flutter-quill/issues/