因為工作需求,需要做到「點擊某個元素後,動態建立一個 DOM 節點並顯示在指定位置」。順手把相關的基礎函式都整理成一份可重複使用的小工具庫,記錄如下。
/* 取得元素:可傳 id 字串,也可直接傳 DOM 物件 */
function getElement(obj) {
return typeof obj == 'string' ? document.getElementById(obj) : obj;
}
/* 取得元素在頁面上的座標 */
function getObjectPosition(obj) {
obj = typeof obj === 'string' ? getElement(obj) : obj;
if (!obj) { return; }
if (obj.getBoundingClientRect) { // 標準瀏覽器 / IE
var position = obj.getBoundingClientRect();
return { x: position.left, y: position.top };
} else if (document.getBoxObjectFor) { // 舊 Firefox
var position = document.getBoxObjectFor(obj);
return { x: position.x, y: position.y };
} else { // 最保守的退路
var position = { x: obj.offsetLeft, y: obj.offsetTop };
var parent = obj.offsetParent;
while (parent) {
position.x += parent.offsetLeft;
position.y += parent.offsetTop;
parent = parent.offsetParent;
}
return position;
}
}
/* 綁定事件,sEventType 不帶 on 前綴,例如 'click' */
function addEventHandler(oTarget, sEventType, fnHandler) {
if (oTarget.addEventListener) {
oTarget.addEventListener(sEventType, fnHandler, false);
} else if (oTarget.attachEvent) { // 舊 IE
oTarget.attachEvent("on" + sEventType, fnHandler);
} else {
oTarget["on" + sEventType] = fnHandler;
}
}
/* 移除事件 */
function removeEventHandler(oTarget, sEventType, fnHandler) {
if (oTarget.removeEventListener) {
oTarget.removeEventListener(sEventType, fnHandler, false);
} else if (oTarget.detachEvent) {
oTarget.detachEvent(sEventType, fnHandler);
} else {
oTarget['on' + sEventType] = undefined;
}
}
核心函式 dynCreateDomObject 接受一個 JSON 參數,欄位說明如下:
parentNode:新節點的父層,可傳元素 id 或 DOM 物件domId:新節點的 iddomTag:標籤名稱,支援 div、span 等常見排版元素content:節點內容otherAttributes:額外屬性,形如 [{attrName:'style.color', attrValue:'red'}]eventRegisters:要綁定的事件,形如 [{eventType:'click', eventHandler:fn}]
function dynCreateDomObject(domParams) {
// 若同 id 已存在,先移除,避免重複
if (getElement(domParams.domId)) {
childNodeAction('remove', domParams.parentNode, domParams.domId);
}
var dynObj = document.createElement(domParams.domTag);
with (dynObj) {
// id 也可以透過 otherAttributes 傳入,但因其特殊性,此處仍用 JSON 傳入
id = domParams.domId;
innerHTML = domParams.content; // innerHTML 是 DOM 屬性,id 是元素屬性,注意區別
}
/* 加上額外屬性 */
if (null != domParams.otherAttributes) {
for (var i = 0; i < domParams.otherAttributes.length; i++) {
var otherAttribute = domParams.otherAttributes[i];
dynObj.setAttribute(otherAttribute.attrName, otherAttribute.attrValue);
}
}
/* 加上事件 */
if (null != domParams.eventRegisters) {
for (var i = 0; i < domParams.eventRegisters.length; i++) {
var eventRegister = domParams.eventRegisters[i];
addEventHandler(dynObj, eventRegister.eventType, eventRegister.eventHandler);
}
}
try {
childNodeAction('append', domParams.parentNode, dynObj);
} catch ($e) {}
return dynObj;
}
/* 從父節點新增或移除子節點 */
function childNodeAction(actionType, parentNode, childNode) {
if (!parentNode) { return; }
parentNode = typeof parentNode === 'string' ? getElement(parentNode) : parentNode;
childNode = typeof childNode === 'string' ? getElement(childNode) : childNode;
if (!parentNode || !childNode) { return; }
var action = actionType.toLowerCase();
if (null == actionType || action.length <= 0 || action == 'append') {
action = 'parentNode.appendChild';
} else {
action = 'parentNode.removeChild';
}
try {
eval(action)(childNode);
} catch ($e) {
alert($e.message);
}
}
var htmlAttributes = [
{ attrName: 'class', attrValue: '樣式名稱' }, // for IE
{ attrName: 'className', attrValue: '樣式名稱' } // for Firefox
];
var domParams = {
domTag: 'div',
content: '動態 div 的 innerHTML',
otherAttributes: htmlAttributes
};
var newHtmlDom = dynCreateDomObject(domParams);
// 注意:用 setAttribute('style', 'position:absolute;...') 在舊瀏覽器上沒有效果
// 必須逐一指定 style 屬性
newHtmlDom.style.zIndex = '8888';
newHtmlDom.style.position = 'absolute';
newHtmlDom.style.left = '100px';
newHtmlDom.style.top = '200px';
這份程式碼寫於 attachEvent 還得考慮的年代,今天使用上有兩處可以簡化:
with 語句在嚴格模式下已被禁用,建議改成 dynObj.id = ...; dynObj.innerHTML = ...;。eval(action)(childNode) 完全可以用 parentNode.appendChild(childNode)/parentNode.removeChild(childNode) 的 if-else 取代,避免 eval 帶來的效能與安全性疑慮。