Quill富文本編輯器入坑指北

公司項(xiàng)目需要支持簡(jiǎn)單表格艾恼、圖片上傳著蟹、樣式不丑的富文本編輯器蛾扇。

當(dāng)時(shí)選擇Quill這個(gè)富文本編輯器了也是看了一些附帶的插件的Demo(quill-better-table刀疙、quill-image-resize-module)违寿,還有自定義的toolbar湃交。

中間碰到很多坑查了很多資料,也做了很多妥協(xié)藤巢。

個(gè)人而言覺(jué)得這個(gè)還不夠完善搞莺,生態(tài)也不夠大,版本也有點(diǎn)亂

Quill 的使用

開(kāi)局一張圖

image

快速開(kāi)始

我是直接在Vue項(xiàng)目中使用的 Quill
index.html 引入(可以直接引入cdn) 也可以使用vue-quill-editor不過(guò)中間碰到問(wèn)題最終妥協(xié)了

展示效果:


效果
<!-- 引入主題css文件 -->
<link  rel="stylesheet">

<!-- 引入js文件 -->
<script src="https://cdn.quilljs.com/1.0.0/quill.js"></script>

<!-- 自定義編輯器工具欄 -->
<div id="toolbar">
  <button class="ql-bold">Bold</button>
  <button class="ql-italic">Italic</button>
</div>

<!-- 創(chuàng)建編輯容器 -->
<div id="editor">
  <p>Hello World!</p>
</div>

<!-- 初始化編輯器掂咒,snow主題 -->
<script>
  const editor = new Quill('#editor', {
    modules: { toolbar: '#toolbar' },
    theme: 'snow'
  });
</script>

自定義toolbar

部分模塊名

背景顏色 - background
加粗- bold
顏色 - color
字體 - font
內(nèi)聯(lián)代碼 - code
斜體 - italic
鏈接 - link
大小 - size
刪除線(xiàn) - strike
上標(biāo)/下標(biāo) - script
下劃線(xiàn) - underline
引用- blockquote
標(biāo)題 - header
縮進(jìn) - indent
列表 - list
文本對(duì)齊 - align
文本方向 - direction
代碼塊 - code-block
公式 - formula
圖片 - image
視頻 - video
清除字體樣式- clean

配置方式

有兩種方式:

  1. 通過(guò)寫(xiě)入html結(jié)構(gòu)從而定制工具欄(我現(xiàn)在用的這個(gè))
    一般已ql-開(kāi)頭才沧,如果是點(diǎn)擊觸發(fā)的一般是button,字體這種一般是select
image
<!-- 自定義編輯器工具欄 -->
<div id="toolbar">
  <!--粗體-->
  <button class="ql-bold"></button>
  <!--斜體-->
  <button class="ql-italic"></button>
  <!--字體-->
  <select class="ql-font">
    <option value="monospace"></option>
    <option value="consolas"></option>
    <option value="serif"></option>
   </select>
</div>

<!-- 創(chuàng)建編輯容器 -->
<div id="editor">
  <p>Hello World!</p>
</div>

const editor = new Quill('#editor', {
    modules: { toolbar: '#toolbar' },
    theme: 'snow'
});
  1. 通過(guò)配置toolbar的數(shù)組選項(xiàng)從而定制工具欄
image
const toolbarOptions = [
  ['bold', 'italic', 'underline', 'strike'],        // toggled buttons
  ['blockquote', 'code-block'],

  [{ 'header': 1 }, { 'header': 2 }],               // custom button values
  [{ 'list': 'ordered'}, { 'list': 'bullet' }],
  [{ 'script': 'sub'}, { 'script': 'super' }],      // superscript/subscript
  [{ 'indent': '-1'}, { 'indent': '+1' }],          // outdent/indent
  [{ 'direction': 'rtl' }],                         // text direction

  [{ 'size': ['small', false, 'large', 'huge'] }],  // custom dropdown
  [{ 'header': [1, 2, 3, 4, 5, 6, false] }],

  [{ 'color': [] }, { 'background': [] }],          // dropdown with defaults from theme
  [{ 'font': [] }],
  [{ 'align': [] }],

  ['clean']                                         // remove formatting button
];

const quill = new Quill('#editor', {
  modules: {
    toolbar: toolbarOptions
  },
  theme: 'snow'
});

增加自定義字體绍刮、自定義圖標(biāo)温圆、英文轉(zhuǎn)改中文

自定義字體

步驟:

  1. js部分
// Add fonts to whitelist
const Font = Quill.import('formats/font');
// We do not add Aref Ruqaa since it is the default
Font.whitelist = [
  'SimSun',
  'SimHei',
  'Microsoft-YaHei',
  'KaiTi',
  'FangSong',
  'Arial',
  'Times-New-Roman',
  'sans-serif',
  'monospace',
  'serif',
  'consolas'
];
  1. css 部分

格式就在下面,應(yīng)該一看就能明白吧
保持到font.css 引入就能使用了孩革,該怎么自定義就看自己的了

/* 默認(rèn)字體 具體可能需要修改 */ 
#editor {
  font-family: 'Microsoft-YaHei';
}
.ql-snow .ql-picker.ql-font .ql-picker-label[data-value=SimSun]::before,
.ql-snow .ql-picker.ql-font .ql-picker-item[data-value=SimSun]::before {
    content: "宋體";
    font-family: "SimSun";
}
.ql-snow .ql-picker.ql-font .ql-picker-label[data-value=SimHei]::before,
.ql-snow .ql-picker.ql-font .ql-picker-item[data-value=SimHei]::before {
    content: "黑體";
    font-family: "SimHei";
}
.ql-snow .ql-picker.ql-font .ql-picker-label[data-value=Microsoft-YaHei]::before,
.ql-snow .ql-picker.ql-font .ql-picker-item[data-value=Microsoft-YaHei]::before {
    content: "微軟雅黑";
    font-family: "Microsoft YaHei";
}
.ql-snow .ql-picker.ql-font .ql-picker-label[data-value=consolas]::before,
.ql-snow .ql-picker.ql-font .ql-picker-item[data-value=consolas]::before {
    content: "consolas";
    font-family: "consolas";
}
.ql-snow .ql-picker.ql-font .ql-picker-label[data-value=KaiTi]::before,
.ql-snow .ql-picker.ql-font .ql-picker-item[data-value=KaiTi]::before {
    content: "楷體";
    font-family: "KaiTi";
}
.ql-snow .ql-picker.ql-font .ql-picker-label[data-value=FangSong]::before,
.ql-snow .ql-picker.ql-font .ql-picker-item[data-value=FangSong]::before {
    content: "仿宋";
    font-family: "FangSong";
}
.ql-snow .ql-picker.ql-font .ql-picker-label[data-value=Arial]::before,
.ql-snow .ql-picker.ql-font .ql-picker-item[data-value=Arial]::before {
    content: "Arial";
    font-family: "Arial";
}
.ql-snow .ql-picker.ql-font .ql-picker-label[data-value=Times-New-Roman]::before,
.ql-snow .ql-picker.ql-font .ql-picker-item[data-value=Times-New-Roman]::before {
    content: "New Roman";
    font-family: "Times New Roman";
}
.ql-snow .ql-picker.ql-font .ql-picker-label[data-value=sans-serif]::before,
.ql-snow .ql-picker.ql-font .ql-picker-item[data-value=sans-serif]::before {
    content: "sans-serif";
    font-family: "sans-serif";
}

.ql-font-SimSun {
    font-family: "SimSun";
}
.ql-font-SimHei {
    font-family: "SimHei";
}
.ql-font-Microsoft-YaHei {
    font-family: "Microsoft YaHei";
}
.ql-font-KaiTi {
    font-family: "KaiTi";
}
.ql-font-FangSong {
    font-family: "FangSong";
}
.ql-font-Arial {
    font-family: "Arial";
}
.ql-font-Times-New-Roman {
    font-family: "Times New Roman";
}
.ql-font-sans-serif {
    font-family: "sans-serif";
}
.ql-font-consolas {
    font-family: "consolas";
}

自定義圖標(biāo)

icons[actionName] and icons[actionName].childrenName

// 引入icons
const icons = Quill.import('ui/icons');
// 修改
icons['color'] = `<i class="ql-stroke ql-color-label font_family icon-icon_pc_a"></i>`;
icons['background'] = `<i class="ql-color-label font_family icon-icon_pc_background_color"></i>`;
icons['image'] = `<i class="font_family icon-icon_pc_import_image"></i>`;
icons['list'].bullet = `xxxxx`;
icons['list'].ordered = `xxxxx`;

將英文提示轉(zhuǎn)換成中文

修改 content 即可岁歉,參照下方的,其他基本類(lèi)似

  1. 超鏈接英文
.ql-snow .ql-tooltip::before {
  content: '訪問(wèn)鏈接:';
}
.ql-snow .ql-tooltip[data-mode='link']::before {
  content: '輸入鏈接:';
}
.ql-snow .ql-tooltip.ql-editing a.ql-action::after {
  content: '保存';
}
.ql-snow .ql-tooltip a.ql-action::after {
  content: '編輯';
}
.ql-snow .ql-tooltip a.ql-remove::before {
  content: '移除';
}

圖片縮放

東西是好東西膝蜈,只是后來(lái)因?yàn)槠渌δ芡讌f(xié)了锅移,使用很簡(jiǎn)單。具體下面參照鏈接饱搏。
https://github.com/kensnyder/quill-image-resize-module

表格支持

直接看官方例子更直接
要求:quilljs v2.0.0-dev.3
https://github.com/soccerloway/quill-better-table

問(wèn)題

圖片縮放組件 是基于 quill@1.x非剃,但是現(xiàn)在需要編輯器能支持插入表格,這個(gè)需求 quill@1.x 做不到 但是 quill@2.0.0-dev.3 支持在編輯器中插入表格推沸,不過(guò)這不是正式版备绽,而是開(kāi)發(fā)版,而且 quill 的版本一直停留在 1.x

相關(guān)鏈接

https://quilljs.com/

https://github.com/kensnyder/quill-image-resize-module

https://blog.csdn.net/asing1elife/article/details/103659403

http://www.reibang.com/p/b237372f15cc

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末坤学,一起剝皮案震驚了整個(gè)濱河市疯坤,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌深浮,老刑警劉巖压怠,帶你破解...
    沈念sama閱讀 212,884評(píng)論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異飞苇,居然都是意外死亡菌瘫,警方通過(guò)查閱死者的電腦和手機(jī)蜗顽,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,755評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)雨让,“玉大人雇盖,你說(shuō)我怎么就攤上這事∑苤遥” “怎么了崔挖?”我有些...
    開(kāi)封第一講書(shū)人閱讀 158,369評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)庵寞。 經(jīng)常有香客問(wèn)我狸相,道長(zhǎng),這世上最難降的妖魔是什么捐川? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 56,799評(píng)論 1 285
  • 正文 為了忘掉前任脓鹃,我火速辦了婚禮,結(jié)果婚禮上古沥,老公的妹妹穿的比我還像新娘瘸右。我一直安慰自己,他們只是感情好岩齿,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,910評(píng)論 6 386
  • 文/花漫 我一把揭開(kāi)白布太颤。 她就那樣靜靜地躺著,像睡著了一般纯衍。 火紅的嫁衣襯著肌膚如雪栋齿。 梳的紋絲不亂的頭發(fā)上苗胀,一...
    開(kāi)封第一講書(shū)人閱讀 50,096評(píng)論 1 291
  • 那天襟诸,我揣著相機(jī)與錄音,去河邊找鬼基协。 笑死歌亲,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的澜驮。 我是一名探鬼主播陷揪,決...
    沈念sama閱讀 39,159評(píng)論 3 411
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼杂穷!你這毒婦竟也來(lái)了悍缠?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 37,917評(píng)論 0 268
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤耐量,失蹤者是張志新(化名)和其女友劉穎飞蚓,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體廊蜒,經(jīng)...
    沈念sama閱讀 44,360評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡趴拧,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,673評(píng)論 2 327
  • 正文 我和宋清朗相戀三年溅漾,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片著榴。...
    茶點(diǎn)故事閱讀 38,814評(píng)論 1 341
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡添履,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出脑又,到底是詐尸還是另有隱情暮胧,我是刑警寧澤,帶...
    沈念sama閱讀 34,509評(píng)論 4 334
  • 正文 年R本政府宣布问麸,位于F島的核電站叔壤,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏口叙。R本人自食惡果不足惜炼绘,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,156評(píng)論 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望妄田。 院中可真熱鬧俺亮,春花似錦、人聲如沸疟呐。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,882評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)启具。三九已至本讥,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間鲁冯,已是汗流浹背拷沸。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,123評(píng)論 1 267
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留薯演,地道東北人撞芍。 一個(gè)月前我還...
    沈念sama閱讀 46,641評(píng)論 2 362
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像跨扮,于是被迫代替她去往敵國(guó)和親序无。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,728評(píng)論 2 351