Flutter Quill 富文本编辑器默认样式设置指南

问题背景

在使用 Flutter Quill 富文本编辑器时，开发者经常需要设置默认文本样式（如字体颜色、大小等）。然而，目前该库在默认样式设置方面存在一些限制，特别是在样式持久化方面。

默认样式设置方法

目前 Flutter Quill 提供了两种设置默认样式的方式：

1. 通过控制器直接设置：

_controller.formatTextStyle(
  0, 
  0, 
  Style.fromJson({
    'color': '#fcba03',
    'size': 24.0
  })
);

2. 通过 QuillEditorConfigurations.customStyles 设置：

QuillEditor(
  configurations: QuillEditorConfigurations(
    customStyles: const DefaultStyles(
      paragraph: DefaultTextBlockStyle(
        TextStyle(color: Colors.purple), 
        VerticalSpacing(0,0), 
        VerticalSpacing(0, 0), 
        null
      ),
    ),
  ),
)

存在的问题

1. 样式持久性问题：当用户删除第一个字符后，通过控制器设置的样式会被重置。

2. 样式导出问题：通过 customStyles 设置的样式不会保存在导出的 Delta JSON 数据中，这意味着：

   • 在其他编辑器实例中无法保持相同的默认样式
   • 在读取模式下无法还原原始编辑时的默认样式

解决方案

临时解决方案（监听文本变化）

// 初始化监听
_controller.addListener(onTextChangeListener);

// 监听器实现
onTextChangeListener() {
  final isEmpty = _controller.document.isEmpty();
  final isBlank = _controller.document.toPlainText().trim().isEmpty;
  if (isEmpty || isBlank) {
    _controller.removeListener(onTextChangeListener);
    setDefaultTextStyle();
    _controller.addListener(onTextChangeListener);
  }
}

// 设置默认样式
setDefaultTextStyle() {
  if (widget.defaultTextStyle != null) {
    _controller.formatTextStyle(
      0,
      0,
      Style.fromJson({
        'font': widget.defaultTextStyle!.fontFamily,
        'size': widget.defaultTextStyle!.fontSize,
        'bold': widget.defaultTextStyle!.fontWeight == FontWeight.bold ? true : null,
      }));
  }
}

完整解决方案建议

1. 样式预处理：在保存数据前，遍历 Delta JSON 并为没有样式的段落添加默认样式属性。

2. 自定义导出：实现自定义的 toJson 方法，确保导出数据包含完整的样式信息。

3. 统一样式管理：在应用层面维护一个全局的默认样式配置，确保所有编辑器实例使用相同的默认样式。

最佳实践建议

1. 如果需要跨实例保持样式一致性，建议采用预处理方案。

2. 对于简单的单实例使用场景，监听器方案已经足够。

3. 考虑将样式信息与应用业务数据分开存储，便于灵活调整而不影响已有内容。

总结

Flutter Quill 的默认样式设置需要开发者根据具体场景选择合适的方案。目前官方尚未提供开箱即用的完美解决方案，但通过合理的变通方法，仍然可以实现预期的效果。期待未来版本能提供更完善的默认样式管理机制。