Quill is a modern WYSIWYG editor built for compatibility and extensibility. https://quilljs.com
Quill 的使用
快速开始
开始构建一个quill编辑项目包括引入文件、创建自定义工具栏、创建编辑容器以及初始化这几部分。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | <!-- 引入css文件 --> <link href="https://cdn.quilljs.com/1.0.0/quill.snow.css" rel="stylesheet"> <!-- 自定义编辑器工具栏 --> <div id="toolbar"> <button class="ql-bold">Bold</button> <button class="ql-italic">Italic</button> </div> <!-- 创建编辑容器 --> <div id="editor"> <p>Hello World!</p> </div> <!-- 引入js文件 --> <script src="//i2.wp.com/cdn.quilljs.com/1.0.0/quill.js"></script> <!-- 初始化编辑器,snow主题 --> <script> var editor = new Quill('#editor', { modules: { toolbar: '#toolbar' }, theme: 'snow' }); </script> |
quill主要资源介绍
1 2 3 4 5 6 7 8 9 10 11 | <!-- 主要的库文件,js --> <script src="//cdn.quilljs.com/1.3.6/quill.js"></script> <script src="//cdn.quilljs.com/1.3.6/quill.min.js"></script> <!-- css文件,有两个主题,snow和bubble --> <link href="//cdn.quilljs.com/1.3.6/quill.snow.css" rel="stylesheet"> <link href="//cdn.quilljs.com/1.3.6/quill.bubble.css" rel="stylesheet"> <!-- 没有主题的核心构建, 不必要的模块(使用不需要引入) --> <link href="//cdn.quilljs.com/1.3.6/quill.core.css" rel="stylesheet"> <script src="//cdn.quilljs.com/1.3.6/quill.core.js"></script> |
以上就是quill的库文件了,但要实现代码高亮的话需要自己引入
1 2 3 4 5 6 7 8 9 10 | // 代码高亮采用dracula主题,可去highlight官网配置 <link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/dracula.min.css" rel="stylesheet"> // 采用snow主题 <link href="https://cdn.quilljs.com/1.3.6/quill.snow.css" rel="stylesheet"> // highlight.js的主要js文件 <script src="//i2.wp.com/cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/highlight.min.js"></script> // quill的主要js文件 <script src="//i2.wp.com/cdn.quilljs.com/1.3.6/quill.min.js"></script> |
创建编辑器
quill的使用也很简单,引入上面的资源之后就可以开始创建编辑器了。
首先需要定义编辑器的工具栏,有两种方式,一种是直接html创建,一种是通过js创建,相对来说html更加直观一些,这里就简单的放两个示例介绍一下。
通过一个js数组来配置初始化容器:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | var toolbarOptions = [ ['bold', 'italic', 'underline', 'strike'], // 切换按钮 ['blockquote', 'code-block'], [{ 'header': 1 }, { 'header': 2 }], // 用户自定义按钮值 [{ 'list': 'ordered'}, { 'list': 'bullet' }], [{ 'script': 'sub'}, { 'script': 'super' }], // 上标/下标 [{ 'indent': '-1'}, { 'indent': '+1' }], // 减少缩进/缩进 [{ 'direction': 'rtl' }], // 文本下划线 [{ 'size': ['small', false, 'large', 'huge'] }], // 用户自定义下拉 [{ 'header': [1, 2, 3, 4, 5, 6, false] }], [{ 'color': [] }, { 'background': [] }], // 主题默认下拉,使用主题提供的值 [{ 'font': [] }], [{ 'align': [] }], ['clean'] // 清除格式 ]; var quill = new Quill('#editor', { modules: { toolbar: toolbarOptions }, theme: 'snow' }); |
通过html来创建工具栏冰初始化容器:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | <div id="toolbar-container"> <span class="ql-formats"> <select class="ql-font"></select> <select class="ql-size"></select> </span> <span class="ql-formats"> <button class="ql-bold"></button> <button class="ql-italic"></button> <button class="ql-underline"></button> <button class="ql-strike"></button> </span> <span class="ql-formats"> <select class="ql-color"></select> <select class="ql-background"></select> </span> <span class="ql-formats"> <button class="ql-script" value="sub"></button> <button class="ql-script" value="super"></button> </span> <span class="ql-formats"> <button class="ql-header" value="1"></button> <button class="ql-header" value="2"></button> <button class="ql-blockquote"></button> <button class="ql-code-block"></button> </span> <span class="ql-formats"> <button class="ql-list" value="ordered"></button> <button class="ql-list" value="bullet"></button> <button class="ql-indent" value="-1"></button> <button class="ql-indent" value="+1"></button> </span> <span class="ql-formats"> <button class="ql-direction" value="rtl"></button> <select class="ql-align"></select> </span> <span class="ql-formats"> <button class="ql-link"></button> <button class="ql-image"></button> <button class="ql-video"></button> <button class="ql-formula"></button> </span> <span class="ql-formats"> <button class="ql-clean"></button> </span> </div> <div id="editor"></div> <script> var quill = new Quill('#editor', { modules: { toolbar: '#toolbar-container' } }); </script> |
ok,这样配置并初始化之后就可以完美展示编辑器了,来看一下成果图: