DIV CSS 佈局教程網

jQuery AutoComplete 自動完成外掛的使用方法
編輯:JQuery特效代碼     

自動完成(Autocomplete)是搜尋框、輸入欄位最常見的輔助功能。bassistance.de 的 jQuery Autocomplete 是早期相當流行的一個實作,設定項目齊全,這裡把用法整理一遍。

前置設定

<script type="text/javascript" src="/js/jquery-1.4.2.min.js"></script>
<script type="text/javascript" src="/js/jquery.autocomplete.min.js"></script>
<link rel="Stylesheet" href="/js/jquery.autocomplete.css" />

三個檔案缺一不可,特別是 CSS——少了它,提示列表會變成沒有定位的裸清單。

最簡單的版本

$(function() {
    var data = "Core Selectors Attributes Traversing Manipulation CSS Events Effects Ajax Utilities".split(" ");

    $('#keyword').autocomplete(data).result(function(event, data, formatted) {
        alert(data);
    });
});

資料來源只是一個字串陣列,輸入時就會即時比對並顯示提示。

result 是這個外掛的核心方法,在使用者選定某個項目時觸發。三個參數分別是事件物件、選中的原始資料、以及格式化後的文字。

較複雜的版本:自訂提示內容

var emails = [
    { name: "Peter Pan", to: "peter@pan.de" },
    { name: "Molly", to: "molly@yahoo.com" },
    { name: "Forneria Marconi", to: "live@japan.jp" },
    { name: "Master <em>Sync</em>", to: "205bw@samsung.com" },
    { name: "Dr. <strong>Tech</strong> de Log", to: "g15@logitech.com" },
    { name: "Don Corleone", to: "don@vegas.com" },
    { name: "Mc Chick", to: "info@donalds.org" },
    { name: "Donnie Darko", to: "dd@timeshift.info" },
    { name: "Quake The Net", to: "webmaster@quakenet.org" },
    { name: "Dr. Write", to: "write@writable.com" },
    { name: "GG Bond", to: "Bond@qq.com" },
    { name: "Zhuzhu Xia", to: "zhuzhu@qq.com" }
];

$(function() {
    $('#keyword').autocomplete(emails, {
        max: 12,               // 列表最多顯示幾筆
        minChars: 0,           // 至少輸入幾字才啟動
        width: 400,            // 提示寬度,溢出隱藏
        scrollHeight: 300,     // 提示高度,溢出顯示捲軸
        matchContains: true,   // 包含比對
        autoFill: false,       // 自動填入
        formatItem: function(row, i, max) {
            return i + '/' + max + ':"' + row.name + '"[' + row.to + ']';
        },
        formatMatch: function(row, i, max) {
            return row.name + row.to;
        },
        formatResult: function(row) {
            return row.to;
        }
    }).result(function(event, row, formatted) {
        alert(row.to);
    });
});

三個 format 函式的分工

這 trio 是自訂提示資訊的關鍵,很容易搞混,釐清如下:

  • formatItem:決定「列表裡每一筆長什麼樣子」。範例中加了序號與方括號,還塞進了 em 與 strong 標籤讓部分文字呈現斜體與粗體。
  • formatMatch:決定「用什麼內容去比對使用者的輸入」。因為 formatItem 已經把顯示內容改過了(多了序號、標籤),如果直接拿它來比對,使用者輸入 "Bond" 時就可能對不上。formatMatch 就是把比對用的字串還原回有意義的原始資料。
  • formatResult:決定「選中之後實際填回輸入框的是什麼」。範例中選擇的是 email 位址(row.to),而不是 formatItem 顯示的那一整串。

記法:formatItem 管顯示、formatMatch 管比對、formatResult 管結果。三者分工明確,一旦理解就不會再混淆。

現在的選擇

這個外掛已停止維護多年,最後版本停在 jQuery 1.4 的時代。新專案建議改用 jQuery UI 的 autocomplete,它是官方維護、支援 AJAX 資料來源、鍵盤操作與無障礙屬性都完整得多;若不使用 jQuery,也有若干輕量且持續更新的獨立套件可以考慮。

不過作為學習素材,這個外掛的設定分層設計仍然值得參考——把「顯示」「比對」「結果」三件事拆成獨立可設定的函式,是相當清晰的 API 抽象。

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