富文本編輯器（Rich Text Editor）是在網(wǎng)頁上使用的一種所見即所得的文本編輯器，是 Web 應用開發(fā)中很常見的需求。
富文本實現(xiàn)
在 HTML 文檔上共有 2 中方式實現(xiàn)富文本編輯器。一種是使用 iframe，另一種是使用 contenteditable 屬性指定 HTML 文檔元素。
iframe
第一種方式是使用 iframe 標簽。
在空白的 HTML 文檔中嵌入一個 iframe，并將 designMode 屬性設置為 "on"，文檔就會變成可編輯的，實際編輯的則是 <body> 元素的 HTML，默認值是 "off"。文檔變成可編輯后，就可以像使用文字處理程序一樣編輯文本，通過鍵盤將文本標記為粗體、斜體等等。
作為 iframe 源的是一個非常簡單的空白 HTML 頁面。下面是一個例子：
<!DOCTYPE html>
<html>
<head>
<title>Blank Page for Rich Text Editing</title>
</head>
<body>
</body>
</html>
這個頁面會像其他任何頁面一樣加載到 iframe 里。為了可以編輯，必須將文檔的 designMode 屬性設置為 "on"。不過，只有在文檔完全加載之后可以設置。在這個包含頁面內(nèi)，需要使用 onload 事件處理程序在適當時機設置 designMode，如下面的例子所示：
<iframe name="editor" style="height: 100px; width: 100px"></iframe>
<script>
window.addEventListener("load", () => {
frames["editor"].document.designMode = "on";
});
</script>
以上代碼加載之后，可以在頁面上看到一個類似文本框的區(qū)域。這個框的樣式具有網(wǎng)頁默認樣式，不過可以通過 CSS 調(diào)整。
contenteditable
第二種方式是使用 contenteditable 屬性指定 HTML 文檔中的元素。該方式是 IE 最早實現(xiàn)的。使用方式是在一個元素上添加 contenteditable 屬性并設置為 true 或者空字符串""，然后該元素會立即被用戶編輯。如下所示：
<div class="editor" id="editorId" contenteditable="true"></div>
元素中包含的任何文本都會自動被編輯， 元素本身類似于<textarea> 元素。通過設置contentEditable 屬性，也可以隨時切換元素的可編輯狀態(tài)：
let div = document.getElementById("editorId");
richedit.contentEditable = "true";
contentEditable 屬性有3 個可能的值："true" 表示開啟，"false" 表示關閉，"inherit" 表示繼承父元素的設置。主流瀏覽器都支持 contentEditable 屬性。
<small>注意：contenteditable 是一個非常多才多藝的屬性。比如，訪問偽 URL data:text/html, <html contenteditable>可以把瀏覽器窗口轉換為一個記事本。這是因為這樣會臨時創(chuàng)建 DOM 樹并將整個文檔變成可編輯區(qū)域。<small>
與富文本交互
上面講到了如何在 HTML 文檔中實現(xiàn)富文本編輯器，而現(xiàn)在需要了解要使用什么方式與富文本編輯器交互。document 提供了 execCommand() 方法，該方法會影響使用 contentEditable 屬性實現(xiàn)可編輯區(qū)域的元素。方法說明如下所示：
execCommand(commandId: string, showUI?: boolean, value?: string): boolean;
-
commandId：參數(shù)是string值，表示要執(zhí)行的命令。下面會列出可用命令。 -
showUI：參數(shù)是boolean的可選值，表示瀏覽器是否為命令提供用戶界面，一般為false。為兼容的話，該參數(shù)需要始終為false，因為 Mozilla 沒有實現(xiàn)，會在其為true時拋出錯誤。 -
value：參數(shù)是string的可選值，是一些命令需要額外的參數(shù)，默認為null。
該方法執(zhí)行后，會返回 boolean 值，如果是 false，表示操作不被支持或未被啟用。
<small>注意：在調(diào)用一個命令前，不要嘗試使用返回值去校驗瀏覽器的兼容性</small>
不同瀏覽器支持的命令也不一樣。下標列出了最常用的命令。
| 命令 | 作用 | 可選值 |
|---|---|---|
| backColor | 設置文檔背景顏色。在styleWithCss模式下，則只影響容器元素的背景顏色。 |
顏色值<color>字符串（IE使用這個命令設置文本背景色） |
| bold | 切換選中文本的粗體樣式 | null |
| copy | 將選中內(nèi)容復制到剪貼板 | null |
| createLink | 將選中內(nèi)容轉換為指向給定URL的鏈接 | URL鏈接值，至少包含一個字符 |
| cut | 將選中內(nèi)容剪切到剪貼板 | null |
| delete | 刪除選中的內(nèi)容 | null |
| fontName | 將選中文本改為使用指定字體 | 字體名(例如："Arial") |
| fontSize | 將選中文本改為指定字體大小 | 提供HTML字體尺寸(1-7) |
| foreColor | 將選中文本改為指定顏色 | 顏色值<color>字符串 |
| formatBlock | 將選中文本包含在指定的HTML標簽中 | 提供HTML標簽，如<h1>
|
| indent | 縮進文本 | null |
| insertHorizontalRule | 在光標位置插入<hr>元素 |
null |
| insertImage | 在光標位置插入圖片 | 圖片的URL鏈接 |
| insertOrderedList | 在光標位置插入<ol>元素 |
null |
| insertunorderedlist | 在光標位置插入<ul>元素 |
null |
| insertParagraph | 在光標位置插入<p>元素 |
null |
| italic | 切換選中文本的斜體樣式 | null |
| justifyCenter | 在光標位置或者所選內(nèi)容進行文字居中 | null |
| justifyFull | 在光標位置或者所選內(nèi)容進行文本對齊 | null |
| justifyLeft | 在光標位置或者所選內(nèi)容進行左對齊 | null |
| justifyRight | 在光標位置或者所選內(nèi)容進行右對齊 | null |
| outdent | 減小縮進 | null |
| paste | 在光標位置粘貼剪貼板內(nèi)容，如果有被選中的內(nèi)容，會被替換 | null |
| redo | 重做被撤銷的操作 | null |
| removeFormat | 對所選內(nèi)容去除HTML格式。這是formatBlock的反操作 | null |
| selectAll | 選中編輯區(qū)里的全部內(nèi)容 | null |
| strikeThrough | 切換刪除線 | null |
| subscript | 切換下角標 | null |
| superscript | 切換上角標 | null |
| underline | 切換下劃線 | null |
| undo | 撤銷最近執(zhí)行的命令 | null |
| unlink | 取出所選鏈接的<a>標簽 |
null |
| styleWithCSS | 用這個取代useCSS命令。切換使用HTML tags還是CSS來生成標記。 |
Boolean值，false使用CSS，true使用HTML |
剪貼板相關的命令與瀏覽器關系密切。雖然這些命令并不都可以通過 document.execCommand() 使用，但相應的鍵盤快捷鍵都是可以用的。
這些命令可以用于修改 iframe 中富文本區(qū)域的外觀，如下面的例子所示：
// 在內(nèi)嵌窗格中切換粗體文本樣式
frames["editor"].document.execCommand("bold", false, null);
// 在內(nèi)嵌窗格中切換斜體文本樣式
frames["editor"].document.execCommand("italic", false, null);
// 在內(nèi)嵌窗格中創(chuàng)建指向www.wrox.com 的鏈接
frames["editor"].document.execCommand("createlink", false, "http://www.wrox.com");
// 在內(nèi)嵌窗格中為內(nèi)容添加<h1>標簽
frames["editor"].document.execCommand("formatblock", false, "<h1>");
同樣的方法也可以用于頁面中添加了 contenteditable 屬性的元素，只不過要使用當前窗口而不是內(nèi)嵌窗格中的 document 對象：
// 切換粗體文本樣式
document.execCommand("bold", false, null);
// 切換斜體文本樣式
document.execCommand("italic", false, null);
// 創(chuàng)建指向www.wrox.com 的鏈接
document.execCommand("createlink", false, "http://www.wrox.com");
// 為內(nèi)容添加<h1>標簽
document.execCommand("formatblock", false, "<h1>");
<small>注意：使用bold的命令在瀏覽器中生成的 HTML 差別很大。如在 IE 和 Opera 中使用<strong>標簽，在 Safari 和 Chrome 中使用<b>標簽，在 Firefox 中使用 <span> 標簽。</small>
document 中提供了 queryCommandEnabled() 方法：
queryCommandEnabled(commandId: string): boolean;
-
commandId：接收string類型參數(shù)，是待查詢是否可用的命令。
該方法用于確定對當前選中文本或光標所在位置是否可以執(zhí)行相關命令。true 指令可用，false 不可用。如下所示：
let result = document.queryCommandEnabled("selectAll");
但要注意，返回 true 并不代表允許執(zhí)行相關命令，只代表當前選區(qū)適合執(zhí)行相關命令。在 Firefox 中，queryCommandEnabled("cut") 即使默認不允許剪切也會返回 true。
document 還提供 queryCommandState() 方法：
queryCommandState(commandId: string): boolean;
-
commandId：參數(shù)是要確定的命令。
該方法用于確定相關命令是否應用到了當前文本選區(qū)。如下所示：
let isBold = document.queryCommandState("selectAll");
富文本編輯器可以利用這個方法更新粗體、斜體等按鈕。
在介紹一下 queryCommandValue() 方法：
queryCommandValue(commandId: string): string;
這個方法用于返回執(zhí)行命令時使用的值，參考 execCommand() 方法使用的第三個參數(shù)。如下所示，如果一段選中文本應用了值為 5 的 "fontsize" 命令，使用該方法會返回 5：
let fontSize = document.queryCommandValue("fontsize");
這個方法可用于確定如何將命令應用于文本選區(qū)，從而進一步?jīng)Q定是否需要執(zhí)行下一個命令。
富文件選區(qū)
Selection 對象表示用戶選中的文本范圍或光標的位置，它代表頁面中的文本選區(qū)?？梢允褂?window 或 document 對象調(diào)用 getSelection() 方法獲取文本選區(qū)。Selection 對象擁有以下屬性。
-
anchorNode：只讀屬性，描述選區(qū)起點所在的節(jié)點。 -
anchorOffset：只讀屬性，返回的是選區(qū)起點在anchorNode中的位置偏移量 。 -
focusNode：只讀屬性，返回選區(qū)終點所在的節(jié)點。 -
focusOffset：只讀屬性，返回的是選區(qū)終點在focusNode中的位置偏移量。 -
isCollapsed：只讀屬性，返回boolean值，用來表示選區(qū)起點和終點是否在同一個位置。 -
rangeCount：只讀屬性，返回選區(qū)所包含的DOM范圍數(shù)量。
Selection 的屬性并沒有包含很多有用的信息。好在它的以下方法提供了更多信息，并允許操作選區(qū)。
-
addRange(range)：把給定的DOM范圍添加到選區(qū)。 -
collapse(node, offset)：將選區(qū)折疊到給定節(jié)點中給定的文本偏移處。 -
collapseToEnd()：將選區(qū)折疊到終點。 -
collapseToStart()：將選區(qū)折疊到起點。 -
containsNode(node)：判斷給定節(jié)點是否包含在選區(qū)中。 -
deleteFromDocument()：從文檔中刪除選區(qū)內(nèi)容。與執(zhí)行execCommand("delete", false, null)命令結果相同。 -
extend(node, offset)：通過將focusNode和focusOffset移動到指定值來擴展選區(qū)。 -
getRangeAt(index)：返回選區(qū)中指定索引處的DOM范圍。 -
removeAllRanges()：將所有的區(qū)域都從選區(qū)中移除。 -
removeRange(range)：從選區(qū)中移除指定的DOM范圍。 -
selectAllChildren(node)：清除選區(qū)并選擇給定節(jié)點的所有子節(jié)點。 -
toString()：返回選區(qū)中的純文本內(nèi)容。
下面介紹一個例子，是使用 Selection 對象實現(xiàn)選中文本高亮：
function highlight() {
let selection = document.getSelection();
// 取得表示選區(qū)的范圍
let range = selection.getRangeAt(0);
// 高亮選中的文本
let span = document.createElement("span");
span.style.backgroundColor = "yellow";
// 給選中文本添加背景為黃色的<span>標簽
range.surroundContents(span);
}
效果如下：
通過表單提交富文本
因為富文本編輯不是在表單控件中實現(xiàn)，這意味著要將富文本編輯結果提交給服務器，就要手動進行。我們會在表單中添加一個 type="hidden" 的字段，在提交表單時，通過監(jiān)聽器，從元素中提取出 HTML 并插入隱藏字段中。如下所示：
// form 實例是`<form>` 元素，可以使用DOM獲取
form.addEventListener("submit", (event) => {
let target = event.target;
target.elements["content"].value = frames["editor"].document.body.innerHTML;
});
上述從編輯器中獲取了 HTML 后，將其插入名為 content 的字段中。下面是對于 contenteditable 元素實現(xiàn)的方式：
這里，代碼使用文檔主體的 innerHTML 屬性取得了 iframe 的 HTML，然后將其插入名為 "comments" 的表單字段中。這樣做可以確保在提交表單之前給表單字段賦值。如果使用 submit() 方法手工提交表單，那么要注意在提交前先執(zhí)行上述操作。對于 contenteditable 元素，執(zhí)行這一操作的代碼是類似的：
// form 實例是`<form>` 元素，可以使用DOM獲取
form.addEventListener("submit", (event) => {
let target = event.target;
target.elements["content"].value = document.getElementsByClassName("editor")[0].innerHTML;
});
總結
本文介紹了實現(xiàn)富文本編輯器有兩種方式：使用 iframe 和 contenteditable 屬性。介紹了使用 document.execCommand() 方法來實現(xiàn)加粗、斜體樣式等功能，還有一些相應的功能。而且富文本編輯的內(nèi)容要上傳到服務器，還要將內(nèi)容先復制到表單中的一個字段上，然后在提交。
更多內(nèi)容請關注公眾號「海人為記」
