Quill富文本编辑器自定义分割线实现详解

背景介绍

Quill是一款流行的富文本编辑器框架，它提供了强大的扩展能力，允许开发者自定义各种编辑功能。在实际开发中，我们经常需要为编辑器添加自定义功能，比如分割线(Divider)就是一个常见的需求。

问题分析

在Quill中实现自定义分割线时，开发者可能会遇到一个常见问题：点击分割线按钮时会弹出输入提示框，而不是直接插入分割线。这实际上是因为Quill默认会为未注册处理程序的自定义按钮显示提示框。

解决方案

1. 创建自定义分割线Blot

首先需要创建一个自定义的Blot(Quill中的文档对象模型)来表示分割线：

let BlockEmbed = Quill.import("blots/block/embed");

class DividerBlot extends BlockEmbed {
  static create() {
    return super.create();
  }
}

DividerBlot.blotName = "divider";
DividerBlot.tagName = "hr";
Quill.register(DividerBlot);

这段代码定义了一个继承自BlockEmbed的DividerBlot类，指定了它的名称和使用的HTML标签(hr)。

2. 配置工具栏

在工具栏配置中添加分割线按钮：

const modules = {
  toolbar: [
    // 其他工具按钮...
    ["divider"] // 添加分割线按钮
  ]
};

3. 注册按钮处理程序

关键步骤是为分割线按钮注册处理程序，避免弹出提示框：

const toolbar = quill.getModule("toolbar");
toolbar.addHandler("divider", () => {
  const range = quill.getSelection();
  quill.insertEmbed(range.index, "divider", true, "user");
  quill.setSelection(range.index + 1);
});

这个处理程序会在点击按钮时：

1. 获取当前光标位置
2. 在光标处插入分割线
3. 将光标移动到分割线后面

完整实现示例

import ReactQuill from "react-quill";

// 1. 定义分割线Blot
const BlockEmbed = Quill.import("blots/block/embed");

class DividerBlot extends BlockEmbed {
  static create() {
    return super.create();
  }
}

DividerBlot.blotName = "divider";
DividerBlot.tagName = "hr";
Quill.register(DividerBlot);

// 2. 配置编辑器
const modules = {
  toolbar: [
    ["bold", "italic", "underline"],
    ["divider"]
  ]
};

function RichTextEditor() {
  const [value, setValue] = useState("");
  
  const editorRef = useRef(null);
  
  useEffect(() => {
    if (editorRef.current) {
      const editor = editorRef.current.getEditor();
      const toolbar = editor.getModule("toolbar");
      
      // 3. 注册处理程序
      toolbar.addHandler("divider", () => {
        const range = editor.getSelection();
        editor.insertEmbed(range.index, "divider", true);
        editor.setSelection(range.index + 1);
      });
    }
  }, []);
  
  return (
    <ReactQuill
      ref={editorRef}
      value={value}
      onChange={setValue}
      modules={modules}
    />
  );
}

注意事项

1. Blot注册时机：确保在编辑器初始化前完成Blot的注册
2. 光标处理：插入元素后要正确处理光标位置
3. ReactQuill使用：在React中使用时要注意ref的处理时机
4. SSR兼容：在Next.js等SSR框架中使用时要注意动态导入

扩展思考

这种自定义Blot的模式不仅适用于分割线，还可以用于实现各种自定义元素，如图片占位符、特殊标记等。理解Quill的Blot系统和工具栏处理机制，可以大大扩展编辑器的功能。

通过本文介绍的方法，开发者可以优雅地在Quill编辑器中实现分割线功能，避免不必要的提示框干扰，提升用户体验。