網站開發越來越講究使用者體驗,為使用者準備的工具也越來越多,而在線的 HTML 內容編輯器算是其中相當「古老」的一位。功能簡單的能控制文字顏色、字級大小;功能完整的甚至能提供近似 Word 的排版能力。市面上的開源編輯器很多,但真正好用的並不多,改進工作一直在進行。
現今多數編輯器功能強大,相對地也需要大量設定,程式碼自然比較「臃腫」。如果你其實不需要那麼強大的功能,自己實作一個並不難。以下是以 ExtJS 的 HTMLEditor 為例的個人經驗整理。
頁面載入完成後,向頁面加入一個 iframe(可選)。這裡務必判斷頁面狀態,等到完全載入後再操作,否則容易出現找不到元素的錯誤。
把 iframe 設為可編輯。關鍵是取得 iframe 內的 window 與 document 物件,然後開啟 designMode:
// 取得 iframe 的 window 物件
getWin: function () {
return Ext.isIE ? this.iframe.contentWindow : window.frames[this.iframe.name];
},
// 取得 iframe 的 document 物件
getDoc: function () {
return Ext.isIE ? this.getWin().document
: (this.iframe.contentDocument || this.getWin().document);
},
// 先 open 並寫入初始內容,以相容 Firefox
doc = this.getDoc();
doc.open();
doc.write('<html><head><style type="text/css">' +
'body{border:0;margin:0;padding:3px;height:98%;cursor:text;}</style>' +
'</head><body></body></html>');
// 開啟編輯模式
doc.designMode = "on";
doc.close();
完成後,就能往這個簡陋的編輯器裡寫入內容了。
// 取得編輯器的 body 物件 var body = doc.body || doc.documentElement; // 取得內容 var content = body.innerHTML; // 在這裡處理內容,例如替換特殊字元 // Some code return content;
上面的編輯器雖然能動,但太過樸素。document 的 execCommand 方法讓樣式控制變得可行:
// 統一的命令執行方法(doc 的取得方式同上)
function execCmd(cmd, value) {
doc.execCommand(cmd, false, value === undefined ? null : value);
}
execCmd('bold'); // 粗體
execCmd('underline'); // 底線
execCmd('italic'); // 斜體
execCmd('forecolor', Ext.isSafari || Ext.isIE ? '#' + color : color); // 文字顏色
// 在游標處插入內容
function insertAtCursor(text) {
if (Ext.isIE) {
win.focus();
var r = doc.selection.createRange();
if (r) {
r.collapse(true);
r.pasteHTML(text);
}
} else if (Ext.isGecko || Ext.isOpera) {
win.focus();
execCmd('InsertHTML', text);
} else if (Ext.isSafari) {
execCmd('InsertText', text);
}
}
現在樣式可變了。如果編輯器有工具列(通常有),我們還希望游標所在位置的樣式能反映到工具列按鈕上,讓按鈕呈現啟用或關閉狀態。document 的 queryCommandState() 正好派上用場:
// 游標處是否為粗體
var isBold = doc.queryCommandState('bold');
if (isBold) {
// 改變 Bold 按鈕的樣式
}
doc.queryCommandState('underline');
doc.queryCommandState('italic');
本文提供的是一個可行思路,其中不少程式碼可以直接取用。想自己實作編輯器的朋友,建議參考 ExtJS 的 HTMLEditor 原始碼,結構簡單清晰,很容易在其上擴充。
最後提醒兩點:一是務必提早處理瀏覽器相容性,不要等到快收尾才測試,龐大的 JavaScript 程式碼要調整起來相當痛苦;二是 document.execCommand 與 designMode 皆已標示為不建議使用(deprecated),新專案應優先評估 contenteditable 搭配 Selection/Range API,或直接採用成熟編輯器。