Flutter-Quill 自定义 Widget 文本复制功能实现指南

问题背景

在使用 Flutter-Quill 富文本编辑器时，开发者经常需要实现自定义的嵌入组件（Embed Widget）。然而，当这些自定义组件中包含文本内容时，用户可能会遇到无法直接复制这些文本的问题。本文将详细介绍如何为 Flutter-Quill 的自定义组件实现文本复制功能。

自定义组件实现

首先，我们来看一个典型的内容标签自定义组件实现：

class ContentTagEmbed extends Embeddable {
  const ContentTagEmbed(String value) : super('content_tag', value);

  static const String timeStampType = 'content_tag';

  static ContentTagEmbed fromDocument(Document document) =>
      ContentTagEmbed(jsonEncode(document.toDelta().toJson()));

  Document get document => Document.fromJson(jsonDecode(data));
}

class ContentTagEmbedBuilderWidget extends EmbedBuilder {
  @override
  String get key => 'content_tag';

  @override
  String toPlainText(Embed node) {
    return node.value.data;
  }

  @override
  Widget build(BuildContext context, QuillController controller, Embed node,
      bool readOnly, bool inline, TextStyle textStyle) {
    Map<String, dynamic> data = json.decode(node.value.data as String);
    String tagValue = data["tagValue"];
    int tagColor = int.parse(data["tagColor"]);

    return UnconstrainedBox(
      child: Container(
        decoration: BoxDecoration(
          color: GetThemeColor(context)
              .primaryColorLerp(0.01, start: Color(tagColor)),
          borderRadius: const BorderRadius.all(Radius.circular(5))),
        padding: const EdgeInsets.symmetric(vertical: 2, horizontal: 5),
        child: Row(
          children: [
            Text(tagValue, style: const TextStyle(color: Colors.white, fontSize: 10)),
            const SizedBox(width: 3),
            const Icon(IconData(0xe6f8, fontFamily: "ali"), size: 12, color: Colors.white),
          ],
        ),
      ),
    );
  }
}

在这个实现中，组件显示了一个带有特定样式的标签文本，但用户无法通过常规的复制操作获取标签中的文本内容。

解决方案

Flutter-Quill 提供了 CopyCutService 机制来解决自定义组件的复制问题。以下是实现步骤：

1. 创建自定义的 CopyCutService 实现类

class CustomCopyCutService extends CopyCutService {
  @override
  CopyCutAction? getCopyCutAction(String type) {
    if (type == 'content_tag') {
      return (data) => data.toString(); // 返回自定义组件中的文本内容
    }
    // 对于其他类型的嵌入组件，保持默认行为
    return (data) => '\uFFFC';
  }
}

2. 在应用初始化时设置自定义服务

void main() {
  // 在应用启动时设置自定义的复制服务
  CopyCutServiceProvider.setInstance(CustomCopyCutService());
  runApp(MyApp());
}

实现原理

1. CopyCutService 机制：Flutter-Quill 通过这个服务来控制富文本内容的复制行为。当用户执行复制操作时，编辑器会查询当前服务来处理不同类型的内容。

2. 类型匹配：服务通过 getCopyCutAction 方法根据嵌入组件的类型返回相应的处理函数。对于自定义的 'content_tag' 类型，我们返回组件中的实际文本内容。

3. 默认行为：对于其他类型的嵌入组件，返回 Unicode 占位符 '\uFFFC' 保持默认行为。

实际效果

实现后，用户可以直接通过系统复制操作获取自定义组件中的文本内容，而无需额外的交互设计。这对于需要频繁复制特定格式内容的应用程序非常有用。

扩展思考

虽然本文解决了复制功能的问题，但开发者可能还会遇到其他相关需求，例如：

1. 搜索功能：当前实现的自定义组件内容可能无法被编辑器内置的搜索功能识别，这需要额外的实现。

2. 选择性复制：在某些场景下，可能需要控制哪些部分的内容可以被复制。

3. 格式化复制：复制时可能需要保留一定的格式信息，而不仅仅是纯文本。

这些问题都可以通过扩展 CopyCutService 的功能来实现，开发者可以根据具体需求进行定制。