DIV CSS 佈局教程網

自製 jQuery 自動完成插件:支援本地陣列與 AJAX 兩種資料來源
編輯:JQuery特效代碼     

搜尋框的自動完成是常見需求。市面上插件很多,但自己寫一個的好處是:行為完全可控、樣式自由、也能同時支援「本地陣列」與「遠端 AJAX」兩種資料來源。以下是一個完整實作,並支援上下鍵在候選清單中移動。

一、測試頁面

<style type="text/css">
.autoComplete { margin:8px; position:relative; float:left; }
.autoComplete input { width:200px; height:25px; line-height:25px; margin:0; padding:0; }
.autoComplete ul {
  z-index:99; padding:0px; margin:0px; 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>

<script type="text/javascript" src="../javascript/lib/jquery-1.4.2.min.js"></script>
<script type="text/javascript" src="../javascript/autoComplete.js"></script>

<div class="autoComplete"><input value="input" /><ul><li></li></ul></div>
<div class="autoComplete"><input value="input" /><ul><li></li></ul></div>
<div class="autoComplete"><input value="input" /><ul><li></li></ul></div>
<div class="autoComplete"><input value="input" /><ul><li></li></ul></div>

注意結構約定:外層 div 帶 class,內含一個 input 與一個 ul 作為候選容器。同一頁可以放多組,互不干擾。

二、插件本體

;(function($){
  $.fn.autoComplete = function(o){
    if (o.ajax)
      o.ajax = $.extend({ url:'', dataType:'json', async:true }, o.ajax || {});
    o.elemCSS = $.extend({ focus:{'color':'#f00'}, blur:{'color':'#000'} }, o.elemCSS || {});

    o = $.extend({
      source: null,   /* 直接提供陣列作為比對來源 */
      ajax: {},       /* 提供 AJAX 設定;若 source 存在則此參數無效 */
      input: 'input', /* 輸入框的選擇器 */
      popup: 'ul',    /* 彈出層的選擇器,必須是 ul */
      elemCSS: {}     /* 候選項目 focus / blur 的樣式物件 */
    }, 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.o.input, this.e);
          this.$popup = $(this.o.popup, this.e);
          this.initEvent();
        },

        // 以「開頭比對」的方式篩出候選項目
        match: function(quickExpr, value, source){
          for (var i in source){
            if (value.length > 0 && quickExpr.exec(source[i]) != null)
              this.$popup.append('<li><a href="javascript:;">' + source[i] + '</a></li>');
          }
          if ($('li a', this.$popup[0]).length) { this.$popup.show(); }
          else { this.$popup.hide(); }
        },

        fetch: function(ajax, search, quickExpr){
          var that = this;
          $.ajax({
            url: ajax.url + search,
            dataType: ajax.dataType,
            async: ajax.async,
            error: function(data, es, et){ alert('error'); },
            success: function(data){ that.match(quickExpr, search, data); }
          });
        },

        initEvent: function(){
          var that = this;

          this.$input.focus(function(){
            var value = this.value,
                quickExpr = RegExp('^' + value, 'i'),
                self = this;
            // 輪詢輸入值,有變動才重新比對,可省下大量無效請求
            that.timer = setInterval(function(){
              if (value != self.value){
                value = self.value;
                that.$popup.html('');
                if (value != ''){
                  quickExpr = RegExp('^' + value);
                  if (that.o.source) that.match(quickExpr, value, that.o.source);
                  else if (that.o.ajax) that.fetch(that.o.ajax, value, quickExpr);
                }
              }
            }, 200);
          })
          .blur(function(){
            clearInterval(that.timer);
            var current = -1;
            var len = that.$popup.find("li a").length - 1;

            $("li a", that.$popup[0])
              .click(function(){
                that.$input[0].value = $(this).text();   // 選中後回填
                that.$popup.html('').hide();
              })
              .focus(function(){
                current = $(this).parent().index();
                $(this).css(that.o.elemCSS.focus);
              })
              .blur(function(){ $(this).css(that.o.elemCSS.blur); });

            // 候選項上下鍵切換(循環)
            $("li a", that.$popup[0]).keydown(function(event){
              if (event.keyCode == 40){          // 下
                current++;
                if (current < 0) current = len;
                if (current > len) current = 0;
                that.$popup.find("li a").get(current).focus();
              } else if (event.keyCode == 38){   // 上
                current--;
                if (current > len) current = 0;
                if (current < 0) current = len;
                that.$popup.find("li a").get(current).focus();
              }
            });
          })
          .keydown(function(event){
            if (event.keyCode == 40){            // 輸入框按「下」跳到第一個候選
              that.$popup.blur().find("li a").get(0).focus();
            }
          });

          $(this.e).hover(function(){ that.show = 1; }, function(){ that.show = 0; });
          // 點擊頁面其他地方時收起清單
          $(document).click(function(){ if (that.show == 0) { that.$popup.hide(); } });
        }
      };
      handler.prototype.init.prototype = handler.prototype;   /* 走 jQuery 風格的鏈式呼叫 */
      return handler;
    })();

    return this.each(function(){ handler(this, o); });
  };

  /* 呼叫方式 */
  $(document).ready(function(){
    $(".autoComplete").autoComplete({
      source: [123, 1234, 43563, 12346, 3464564, 3454, 7567, 956, 456, 9383, 893, 999],
      // ajax: { url:'./php/fetch.php?search=', dataType:'json', async:false },
      elemCSS: { focus:{'color':'#0f0'}, blur:{'color':'#f00'} }
    });
  });
})(jQuery);

三、改用 AJAX 資料來源

把 source 註解掉、開啟 ajax 設定即可,後端只要回傳一個 JSON 字串陣列。以下是用 PHP 讀資料庫的示範:

<?php
class DataFetch{
  private $conn, $rs;
  function __construct(){
    $this->conn = mysql_connect("localhost","root","pwd") or die("Cant't connect host~");
    mysql_select_db("studentinfo", $this->conn) or die("Cant't select database~");
  }
  public function data_list($s){
    $this->rs = mysql_query("select sno from student where sno like '$s%'") or die("Can't fetch~");
    $dataList = array();
    while($row = mysql_fetch_array($this->rs, MYSQL_ASSOC)){
      array_push($dataList, $row);
    }
    return $dataList;
  }
}

$search = isset($argv[1]) ? $argv[1]
       : ( isset($_GET['search']) ? $_GET['search'] : '' );
$fetch = new DataFetch();
$data  = $fetch->data_list($search);

echo '[';
foreach ($data as $key => $value){
  echo "\n\t" . '"' . $value['sno'] . '"';
  if ($key != count($data) - 1) echo ','; else echo "\n";
}
echo "]\n";
?>

四、這份實作的取捨與可改進處

  • 用 200ms 輪詢監看輸入值,而不是綁 keyup。好處是程式邏輯集中、不受各類鍵盤事件差異影響;缺點是多了一個持續的計時器,且輸入變動到清單更新之間有可感知的延遲。改用 keyup + 簡單 debounce 會更即時。
  • 點擊外部收起靠 hover 設定的 show 旗標判斷,在觸控裝置上會失效,建議改用 event.target 判斷是否落在元件內。
  • 示範的 PHP 使用已被淘汰的 mysql_* 擴充,且以字串拼接 SQL,同時有相容性與 SQL Injection 問題。實作時請改用 PDO 或 MySQLi 搭配參數化查詢,並對使用者輸入做驗證與轉義。
  • 候選項目直接以 innerHTML 拼接,若資料來源含使用者輸入內容,需先做 HTML 轉義以避免 XSS。
XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved