DIV CSS 佈局教程網

用原生 JS 實作輸入框自動完成(AutoComplete)提示功能
編輯:關於JavaScript     

搜尋框打字時下方即時浮出候選清單,就是所謂的自動完成。本文示範不依賴任何框架,用原生 JavaScript 打造一個可複用的 autoComplete 元件。

一、外觀結構

<style type="text/css">
.autoComplete {margin:8px; position:relative; float:left;}
.autoComplete input {width:200px; height:25px; margin:0; padding:0; line-height:25px;}
.autoComplete ul {
    z-index:12; padding:0; margin:1px 0 0 0;
    border:1px #333 solid; width:200px; background:white;
    display:none; position:absolute; left:0; top:28px;
}
.autoComplete li {list-style:none;}
.autoComplete li a {display:block; color:#000; text-decoration:none; padding:1px 0 1px 5px;}
.autoComplete li a:hover {color:#000; background:#ccc; border:none;}
</style>

父容器 .autoComplete 設 position:relative,提示層 ul 才能以它為定位基準貼齊在輸入框下方。一開始 display:none,比對到結果才顯示。

二、兩個基礎工具函數

為了兼顧不支援 getElementsByClassName 的舊瀏覽器,需要自己實作一份:

var getElementsByClassName = function (searchClass, node, tag) {
    node = node || document;
    tag  = tag ? tag.toUpperCase() : "*";

    if (document.getElementsByClassName) {
        var temp = node.getElementsByClassName(searchClass);
        if (tag == "*") return temp;
        var ret = [];
        for (var i = 0; i < temp.length; i++)
            if (temp[i].nodeName == tag) ret.push(temp[i]);
        return ret;
    } else {
        var classes = searchClass.split(" "),
            elements = (tag === "*" && node.all) ? node.all
                     : node.getElementsByTagName(tag),
            patterns = [], returnElements = [];
        var i = classes.length;
        while (--i >= 0) patterns.push(new RegExp("(^|\\s)" + classes[i] + "(\\s|$)"));
        var j = elements.length;
        while (--j >= 0) {
            var current = elements[j], match = false;
            for (var k = 0, kl = patterns.length; k < kl; k++) {
                match = patterns[k].test(current.className);
                if (!match) break;
            }
            if (match) returnElements.push(current);
        }
        return returnElements;
    }
};

另一個是事件綁定,避免直接賦值 onXxx 造成覆蓋:

var addEvent = (function(){
    if (document.addEventListener) {
        return function(type, fn) { this.addEventListener(type, fn, false); };
    } else if (document.attachEvent) {
        return function(type, fn) {
            this.attachEvent('on' + type, function () {
                return fn.call(this, window.event);   // 兼容 IE 的 event 模型
            });
        };
    }
})();

三、元件主體

這裡用了一個類似 jQuery 的建構模式:把 handler 當成工廠函數,每次呼叫都透過 handler.prototype.init 產生一個獨立實例,這樣頁面上有多個輸入框需要自動完成時,彼此不會互相干擾。

;(function(window){
var autoComplete = function(o){
    var handler = (function(){
        var handler = function(e, o) {
            return new handler.prototype.init(e, o);
        };
        handler.prototype = {
            e: null, o: null, timer: null, show: 0, input: null, popup: null,

            init: function(e, o){
                this.e = e; this.o = o;
                this.input = this.e.getElementsByTagName(this.o.input)[0];
                this.popup = this.e.getElementsByTagName(this.o.popup)[0];
                this.initEvent();
            },

            // 依輸入值比對資料來源,動態產生提示項目
            match: function(quickExpr, value, source){
                var li = null;
                for (var i in source) {
                    if (value.length > 0 && quickExpr.exec(source[i]) != null) {
                        li = document.createElement("li");
                        li.innerHTML = '<a href="javascript:;">' + source[i] + '</a>';
                        this.popup.appendChild(li);
                    }
                }
                if (this.popup.getElementsByTagName("a").length)
                    this.popup.style.display = "block";
                else
                    this.popup.style.display = "none";
            },
            ...
        };
        return handler;
    })();
    return handler(o.e, o);
};
})(window);

四、比對規則的關鍵:quickExpr

元件的核心其實就是一個動態產生的正則:

var quickExpr = new RegExp("^" + value, "gi");

^ 表示「開頭相符」,也就是只提示以輸入內容開頭的項目;gi 讓比對不區分大小寫且考慮全部。若想做成模糊比對(包含即可),把 ^ 拿掉即可。

五、實務上必須補齊的細節

原始示範程式只示範了骨架,真正上線前建議補上這幾點:

  • 清空舊結果:每次比對前先 while (popup.firstChild) popup.removeChild(popup.firstChild);,否則提示會層層堆疊。
  • 鍵盤操作:上下鍵切換、Enter 選取、Esc 關閉,這是可【使用性】的關鍵,也關係到無障礙規範。
  • 點擊外部關閉:在 document 上監聽 click,判斷目標是否落在元件內。
  • ARIA 屬性:輸入框加上 role="combobox"、aria-autocomplete="list"、aria-expanded,清單加上 role="listbox"。
  • 避免 XSS:用 textContent 而非 innerHTML 填入候選文字。
  • 防抖動:輸入事件加上 200~300ms 的 debounce,避免每打一個字就查一次。

六、現代替代方案

若不打算自己維護,可考慮成熟的函式庫,例如 awesomplete(體積小、無依賴)或直接沿用 jQuery UI 的 autocomplete。它們已把鍵盤操作、ARIA、防抖動等細節處理妥當,除非有特殊需求,通常不值得重造輪子。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved