【亲测免费】 Quill 文档指南

2026-01-18 10:09:55作者：姚月梅Lane

项目介绍

Quill 是一个现代的富文本编辑器框架，它提供了丰富的 API 和直观的界面，旨在简化富文本处理。这个开源项目由 vickychijwani 维护，它采用了模块化设计，允许开发者高度定制编辑器的功能和外观，以满足不同场景下的需求。Quill 结合了轻量级的核心和强大的插件系统，使得在Web应用程序中集成富文本编辑功能变得既简单又高效。

项目快速启动

安装 Quill

首先，确保你的开发环境中已经安装了 Node.js。然后，可以通过npm来安装Quill：

npm install quill

或者如果你更喜欢使用yarn：

yarn add quill

引入并初始化Quill

在HTML文件中引入必要的样式和JavaScript库：

<!DOCTYPE html>
<html lang="en">
<head>
    <link href="https://cdn.quilljs.com/1.3.6/quill.snow.css" rel="stylesheet">
</head>
<body>

<div id="editor"></div>

<script src="https://cdn.quilljs.com/1.3.6/quill.min.js"></script>
<script>
    var quill = new Quill('#editor', {
        theme: 'snow' // 选择主题，这里选择了snow主题
    });
</script>

</body>
</html>

这段代码会在页面上创建一个名为“editor”的区域，并将其转换为Quill编辑器实例。

应用案例和最佳实践

基本文本格式化

Quill提供了一系列预定义的工具栏按钮来实现基本的文本格式化，如加粗、斜体、下划线等。通过配置工具栏，你可以决定哪些功能对用户可见：

var toolbarOptions = [
  ['bold', 'italic', 'underline', 'strike'], // 加粗、斜体、下划线、删除线
  [{'header': 1}, {'header': 2}], // H1, H2
  ['link', 'image'], // 链接和图片插入
  [{'list': 'ordered'}, {'list': 'bullet'}], // 有序列表，无序列表
];

// 初始化时设置工具栏选项
var quill = new Quill('#editor', {
  modules: { toolbar: toolbarOptions },
  theme: 'snow'
});

最佳实践：数据交互

保存编辑的内容时，Quill将编辑好的富文本转化为Delta对象或HTML字符串。建议使用Delta格式进行存储，因为它更加结构化，便于后续处理和解析。

var delta = quill.getContents();
// 接下来可以将delta通过API发送到服务器端存储

典型生态项目

Quill的生态系统广泛，包括了大量的社区贡献插件，这些插件扩展了其核心功能，例如公式编辑、代码块高亮、表格支持等。一些典型的例子有：

quill-image-resize-module：使图片自动适应编辑器宽度或手动调整大小。
quill-paste-strip：在粘贴内容时自动清理不必要的HTML格式，保持文档清洁。
quill-syntax：为代码块添加语法高亮显示。

开发者可以根据项目需求挑选合适的插件，通过npm安装并按需配置，进一步提升Quill编辑器的适用性和用户体验。

以上就是关于Quill的基本使用指南，从安装到快速启动，再到一些高级实践和生态系统概览。希望这能帮助你快速上手Quill，并在项目中灵活运用。

quill

:ghost: [MOVED TO https://github.com/TryGhost/Ghost-Android] The beautiful Android app for your Ghost blog.

项目地址：https://gitcode.com/gh_mirrors/quill/quill

登录后查看全文