僅用1行核心JS代碼實(shí)現(xiàn)一個(gè)輕量級富文本編輯器

歡迎光臨我的博客拓跋的前端客棧,這個(gè)是原文地址。如果您發(fā)現(xiàn)我文章中存在錯(cuò)誤,請盡情向我吐槽,大家一起學(xué)習(xí)一起進(jìn)步φ(>ω<*)

引子


富文本編輯器是我們在生活中非常常用到的編輯工具,現(xiàn)在有很多功能完備且強(qiáng)大的編輯器,比如Quill Rich Text Editorueditor等,都是很優(yōu)秀的富文本編輯器。甚至說我們每個(gè)人都會(huì)用到的word,才是最優(yōu)秀、國民度最高的富文本編輯器。

今天我們要實(shí)現(xiàn)一個(gè)輕量級的編輯器,主要利用的是document.execCommand

當(dāng)一個(gè)HTML文檔切換到設(shè)計(jì)模式(designMode)時(shí),文檔對象暴露 execCommand方法,該方法允許運(yùn)行命令來操縱可編輯區(qū)域的內(nèi)容。大多數(shù)命令影響文檔的選擇(粗體,斜體等),而其他命令插入新元素(添加鏈接)或影響整行(縮進(jìn))。當(dāng)使用 contentEditable時(shí),調(diào)用 execCommand() 將影響當(dāng)前活動(dòng)的可編輯元素。

用document.execCommand和contentEditable相互配合,就可以實(shí)現(xiàn)我們想要實(shí)現(xiàn)的功能。

在查閱了execCommand的文檔后,我們決定實(shí)現(xiàn)以下功能

  1. 選中文字樣式調(diào)整
    • 斜體
    • 粗體
    • 下劃線
    • 刪除線
  2. 對齊方式調(diào)整
    • 左對齊
    • 右對齊
    • 居中
    • 兩端對齊
  3. 縮進(jìn)調(diào)整
    • 右縮進(jìn)
    • 左縮進(jìn)
  4. 列表操作
    • 有序列表
    • 無序列表
  5. 上下標(biāo)
  6. 文字操作
    • 全選
    • 復(fù)制
    • 粘貼
  7. 基本的字號調(diào)整
  8. 基本的顏色調(diào)整
  9. 基本的字體調(diào)整
  10. undo&redo

實(shí)現(xiàn)


說到編輯器,最基本的會(huì)分為上下兩部分

  • 上部分為控制區(qū)域,用于對文本進(jìn)行各種控制修改
  • 下部分為文本區(qū)域,用于輸入和展示文本的樣式

因此我們可以先在HTML里把兩部分簡單畫出來

<div id="wrapper">
    <div id="control-area"></div>
    <div id="text-area" contenteditable></div>
</div>

注意,既然文本區(qū)域要可編輯,要加上contenteditable屬性,這樣就可以自如的在文本區(qū)域輸入文字了。OK,編輯器雛形已經(jīng)出來了~

接下來要對兩部分分別進(jìn)行操作,在控制區(qū)域,應(yīng)該就是各種按鈕。參考document.execCommand的語法:


execCommand.png

主要控制到樣式的有兩個(gè)api:aCommandName和aValueArgument。同時(shí),命令名aCommandName每條execCommand都會(huì)有,aCommandName和aValueArgument。因此我們需要在每個(gè)按鈕上傳遞兩個(gè)變量。第一個(gè)是必填項(xiàng)aCommandName,第二個(gè)是選填項(xiàng)aValueArgument。我們考慮采用HTML5的新屬性data-*傳遞這兩個(gè)參數(shù):

    <!--調(diào)整為斜體-->
    <a href="#" data-command='italic' onclick="changeStyle(this.dataset)">斜體</a>
    <!--調(diào)整字號為1號-->
    <a href="#" data-command='fontSize' data-value="1" onclick="changeStyle(this.dataset)">1號</a>

上面是兩個(gè)基本按鈕示例,一個(gè)是不傳參的,一個(gè)是傳參的,然后在js端做一個(gè)判斷即可實(shí)現(xiàn)功能:

    const changeStyle = (data) => {
        //一行核心代碼即可實(shí)現(xiàn)基本編輯器功能
        data.value? document.execCommand(data.command, false, data.value):document.execCommand(data.command, false, null)
    }

是不是很簡單呢?

最后,只有兩個(gè)按鈕肯定是不夠的,我們要把按鈕數(shù)和編輯器的功能擴(kuò)充豐富起來。我們就按照第一節(jié)整理的決定要實(shí)現(xiàn)的功能列表列出來的功能,按照分類,一一來實(shí)現(xiàn)。最后,再把按鈕和文本區(qū)域的樣式美化一下,即可實(shí)現(xiàn)我們這個(gè)輕量級富文本編輯器啦~

這是我們的預(yù)覽圖:


zEditor.png

大家可以訪問我的博客嘗試一下這個(gè)小小富文本編輯器,也希望能去我的github項(xiàng)目上點(diǎn)顆star,謝謝啦~

結(jié)語


實(shí)際上,我們這個(gè)富文本編輯器是一種最最簡單的實(shí)現(xiàn),僅僅是對contentEditable和document.execCommand進(jìn)行了一層封裝,所有的樣式實(shí)現(xiàn)都是調(diào)用的這同一條api。

在當(dāng)前流行的真正功能強(qiáng)大的富文本編輯器中,基本都是實(shí)現(xiàn)了自己的contentEditable,拋棄了對瀏覽器原生的contentEditable特性的依賴。大家都說富文本編輯器是個(gè)天坑,事實(shí)也正是如此,原生的document.execCommand實(shí)現(xiàn)的功能太少,BUG太多,如果使用自己寫的功能來編輯文字,又會(huì)破壞contentEditable的undo/redo棧。總之,contentEditable最大的特點(diǎn)就是樣式、html語意環(huán)境跟調(diào)用頁面混合在一起,非常容易出現(xiàn)覆蓋現(xiàn)象,而牛逼的富文本編輯器基本上都會(huì)使用一套自己的事件監(jiān)聽機(jī)制來實(shí)現(xiàn)類似contentEditable的功能,這些東西太繁瑣太復(fù)雜,不在這里的討論范圍之內(nèi)了~

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲(chǔ)服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,619評論 6 539
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 99,155評論 3 425
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,635評論 0 382
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,539評論 1 316
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 72,255評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,646評論 1 326
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,655評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,838評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,399評論 1 335
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 41,146評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 43,338評論 1 372
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,893評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,565評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,983評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,257評論 1 292
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 52,059評論 3 397
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 48,296評論 2 376

推薦閱讀更多精彩內(nèi)容