From ac5a8234405164ff9fb79ffa853f9c58d2f385b0 Mon Sep 17 00:00:00 2001 From: Cat <114286961+CatHood0@users.noreply.github.com> Date: Thu, 25 Jul 2024 10:34:19 -0400 Subject: [PATCH] Feat: support for customize copy and cut Embeddables to Clipboard (#2067) * Feat: custom behavior while copying or cutting a embeddable * dart fixes * fix: removed unnecessary optional return for CopyCutAction * fix: invalid null_aware_operator * added doc comments --------- Co-authored-by: CatHood0 --- lib/flutter_quill.dart | 3 +++ lib/src/document/nodes/line.dart | 17 ++++++++++++++++- .../copy_cut_service/copy_cut_service.dart | 13 +++++++++++++ .../copy_cut_service_provider.dart | 19 +++++++++++++++++++ .../default_copy_cut_service.dart | 14 ++++++++++++++ 5 files changed, 65 insertions(+), 1 deletion(-) create mode 100644 lib/src/editor_toolbar_controller_shared/copy_cut_service/copy_cut_service.dart create mode 100644 lib/src/editor_toolbar_controller_shared/copy_cut_service/copy_cut_service_provider.dart create mode 100644 lib/src/editor_toolbar_controller_shared/copy_cut_service/default_copy_cut_service.dart diff --git a/lib/flutter_quill.dart b/lib/flutter_quill.dart index be514a81..e3c0d42b 100644 --- a/lib/flutter_quill.dart +++ b/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'; diff --git a/lib/src/document/nodes/line.dart b/lib/src/document/nodes/line.dart index d442cde6..71119347 100644 --- a/lib/src/document/nodes/line.dart +++ b/lib/src/document/nodes/line.dart @@ -5,6 +5,7 @@ import 'package:collection/collection.dart'; import '../../../../quill_delta.dart'; import '../../common/structs/offset_value.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'; @@ -520,7 +521,21 @@ base class Line extends QuillContainer { int _getNodeText(Leaf node, StringBuffer buffer, int offset, int remaining) { final text = node.toPlainText(); 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; } diff --git a/lib/src/editor_toolbar_controller_shared/copy_cut_service/copy_cut_service.dart b/lib/src/editor_toolbar_controller_shared/copy_cut_service/copy_cut_service.dart new file mode 100644 index 00000000..81dc77a3 --- /dev/null +++ b/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); +} diff --git a/lib/src/editor_toolbar_controller_shared/copy_cut_service/copy_cut_service_provider.dart b/lib/src/editor_toolbar_controller_shared/copy_cut_service/copy_cut_service_provider.dart new file mode 100644 index 00000000..99194d47 --- /dev/null +++ b/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(); + } +} diff --git a/lib/src/editor_toolbar_controller_shared/copy_cut_service/default_copy_cut_service.dart b/lib/src/editor_toolbar_controller_shared/copy_cut_service/default_copy_cut_service.dart new file mode 100644 index 00000000..5b2469bb --- /dev/null +++ b/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; + } +}