
本文详细介绍了如何在 Quill.js 富文本编辑器中,通过自定义其链接和标题模块,以实现自动生成页面内目录 (TOC) 的基础能力。核心在于修改链接默认行为以支持页面内锚点跳转,并为标题标签自动生成唯一 ID,从而为后续的目录生成奠定基础。
Quill.js 是一款功能强大的富文本编辑器,提供了丰富的编辑功能。然而,在某些场景下,例如长篇文章或技术文档,我们常常需要一个页面内目录 (Table of Contents, TOC) 来帮助用户快速导航。Quill.js 默认情况下并不直接支持自动生成 TOC,主要存在两个挑战:
为了克服这些限制,我们需要对 Quill.js 的核心模块进行定制。
为了让页面内锚点链接能够在当前页面跳转,我们需要修改 Quill.js 链接模块的 target 属性行为。具体来说,当链接值以 # 开头时(表示一个页面内锚点),我们应该移除 target 属性或将其设置为 _self;对于其他外部链接,则保留 target="_blank"。
以下是定制链接模块的代码示例:
var Link = Quill.import('formats/link');
class MyLink extends Link {
/**
* 创建链接节点时的处理逻辑。
* @param {string} value - 链接的值 (href)。
* @returns {HTMLElement} - 创建的链接 DOM 节点。
*/
static create(value) {
let node = Link.create(value);
value = Link.sanitize(value); // 清理链接值
node.setAttribute('href', value);
// 如果链接以 '#' 开头,则移除 target 属性,实现页面内跳转
if (value.startsWith("#")) {
node.removeAttribute('target');
} else {
// 否则,保持 target="_blank"
node.setAttribute("target", "_blank");
}
return node;
}
/**
* 格式化链接时的处理逻辑。
* @param {string} name - 格式名称。
* @param {string} value - 格式值。
*/
format(name, value) {
super.format(name, value);
if (name !== this.statics.blotName || !value) {
return;
}
// 再次检查并设置 target 属性,确保格式化后的行为正确
if (value.startsWith("#")) {
this.domNode.removeAttribute("target");
} else {
this.domNode.setAttribute("target", "_blank");
}
}
}
// 注册自定义的链接模块
Quill.register(MyLink, true); // 第二个参数为 true 表示覆盖默认模块代码解析:
为了让标题能够被锚点链接引用,每个标题标签都需要一个唯一的 id 属性。Quill.js 默认的标题模块并不会自动添加 id。我们需要扩展标题模块,在标题创建时为其分配一个唯一的 ID。
以下是定制标题模块的代码示例:
var Header = Quill.import('formats/header');
var ids = []; // 用于存储已生成的ID,确保唯一性
/**
* 生成一个简单的随机ID。
* 实际应用中可能需要更健壮的ID生成策略。
* @returns {string} - 唯一的ID字符串。
*/
function getRandomId() {
let _id = Math.random().toString(16).slice(2, 9);
// 简单检查冲突,实际应用中可能需要更复杂的循环或UUID库
while(ids.includes(_id)) {
_id = Math.random().toString(16).slice(2, 9);
}
ids.push(_id);
return _id;
}
class MyHeader extends Header {
/**
* 构造函数在标题 DOM 节点被创建并附加到文档时调用。
* @param {HTMLElement} domNode - 标题的 DOM 节点。
*/
constructor(domNode) {
super(domNode);
// 为标题节点设置唯一的ID
domNode.setAttribute('id', getRandomId());
this.cache = {}; // Quill 内部使用,保持一致
}
/**
* 静态方法 create() 用于创建新的 Blot 实例。
* 这里我们保持与父类一致,因为ID的设置主要在 constructor 中处理。
* @returns {HTMLElement} - 创建的标题 DOM 节点。
*/
static create() {
const node = super.create();
return node;
}
/**
* 静态方法 formats() 用于获取 Blot 的格式属性。
* 我们添加 id 属性以便于后续获取。
* @param {HTMLElement} domNode - 标题的 DOM 节点。
* @returns {object} - 包含 id 属性的对象。
*/
static formats(domNode) {
let formats = super.formats(domNode);
formats.id = domNode.getAttribute("id");
return formats;
}
}
// 注册自定义的标题模块
Quill.register("formats/header", MyHeader, true);
// 确保 blotName 正确,Quill 内部使用
MyHeader.blotName = "header";代码解析:
通过上述定制,我们的 Quill.js 编辑器现在具备了以下能力:
有了这些基础,接下来就是编写实际的 JavaScript 代码来生成目录。这通常涉及以下步骤:
获取编辑器内容:可以通过 quill.getContents() 获取 Quill 内部的 Delta 格式内容,或者直接访问编辑器 DOM (quill.root)。
遍历并提取标题:
构建目录结构:根据提取到的标题文本和 ID,动态生成一个 HTML 列表(通常是 <ul> 和 <li> 嵌套 <a> 标签)作为目录。例如:
<nav class="toc">
<ul>
<li><a href="#header-id-1">一级标题内容</a></li>
<li>
<ul>
<li><a href="#header-id-2">二级标题内容</a></li>
</ul>
</li>
</ul>
</nav>插入目录:将生成的目录 HTML 结构插入到页面的指定位置,例如文章内容的顶部。
示例(概念性代码,不直接包含在 Quill 定制中):
// 假设 quill 实例已经初始化
function generateTableOfContents(quill) {
const editorContent = quill.root; // 获取编辑器内容的 DOM 元素
const headers = editorContent.querySelectorAll('h1[id], h2[id], h3[id], h4[id], h5[id], h6[id]');
if (headers.length === 0) {
return ''; // 没有标题,不生成目录
}
let tocHtml = '<ul>';
let currentLevel = 0; // 跟踪当前标题级别
headers.forEach(header => {
const level = parseInt(header.tagName.substring(1)); // 获取标题级别 (h1 -> 1, h2 -> 2)
const id = header.getAttribute('id');
const text = header.textContent;
if (level > currentLevel) {
// 新的子级别,开始新的无序列表
for (let i = 0; i < (level - currentLevel); i++) {
tocHtml += '<ul>';
}
} else if (level < currentLevel) {
// 返回上级,关闭多余的无序列表
for (let i = 0; i < (currentLevel - level); i++) {
tocHtml += '</ul>';
}
}
tocHtml += `<li><a href="#${id}">${text}</a></li>`;
currentLevel = level;
});
// 关闭所有未闭合的无序列表
for (let i = 0; i < currentLevel; i++) {
tocHtml += '</ul>';
}
return tocHtml;
}
// 在页面加载或编辑器内容更新后调用
// const tocContainer = document.getElementById('toc-container');
// if (tocContainer) {
// tocContainer.innerHTML = generateTableOfContents(quill);
// }通过对 Quill.js 的链接和标题模块进行定制,我们成功解决了在编辑器中实现页面内目录导航的关键障碍。这展示了 Quill.js 强大的可扩展性,允许开发者根据特定需求深度定制其行为。在此基础上,结合额外的 JavaScript 逻辑来解析编辑器内容并动态渲染目录,即可实现一个完整的 Quill.js 自动目录生成功能。
以上就是Quill.js 富文本编辑器:通过自定义模块实现页面内目录导航 (TOC)的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号