DIV CSS 佈局教程網

為 select 加上可輸入過濾的 jQuery 插件實作
編輯:關於JavaScript     

當下拉選單的選項多到幾十上百項,讓使用者翻找是很折磨人的事。這個插件把原生 select 包裝成「可以打字篩選」的輸入框,同時保留原本的選項結構。

/**
 * @description 讓 select 像文字框一樣可編輯,同時保留選項功能
 * @description 不需要任何樣式表或圖片
 * @version 0.0.1
 * @author Martin Mende
 * @license Attribution-NonCommercial 3.0 Unported (CC BY-NC 3.0)
 * @requires jQuery 1.9+
 *
 * @example
 * var selectBox = $("select").editableSelect();
 * selectBox.addOption("I am dynamically added");
 */
(function ( $ ) {
  $.fn.editableSelect = function() {
    var instanceVar;

    this.each(function(){
      var originalSelect = $(this);

      if (originalSelect[0].tagName.toUpperCase() === "SELECT") {

        // 在原始 select 外圍包一層 div
        originalSelect.wrap($("<div/>"));
        var wrapper = originalSelect.parent();
        wrapper.css({ display: "inline-block" });

        // 建立代表可編輯 select 的 input
        var inputSelect = $("<input/>").insertBefore(originalSelect);

        // 把原 select 的 id 轉移給 input
        var objID = originalSelect.attr("id");
        originalSelect.removeAttr("id");

        inputSelect.attr({
          alt: originalSelect.attr("alt"),
          title: originalSelect.attr("title"),
          class: originalSelect.attr("class"),
          name: originalSelect.attr("name"),
          disabled: originalSelect.attr("disabled"),
          tabindex: originalSelect.attr("tabindex"),
          id: objID
        });

        // 沿用 select 的視覺樣式
        var rightPadding = 15;
        inputSelect.css({
          width: originalSelect.width() - rightPadding,
          height: originalSelect.height(),
          fontFamily: originalSelect.css("fontFamily"),
          fontSize: originalSelect.css("fontSize"),
          background: originalSelect.css("background"),
          paddingRight: rightPadding
        });
        inputSelect.val(originalSelect.val());

        // 右側加上三角形箭頭
        var triangle = $("<div/>").css({
          height: 0, width: 0,
          borderLeft: "5px solid transparent",
          borderRight: "5px solid transparent",
          borderTop: "7px solid #999",
          position: "relative",
          top: -(inputSelect.height() / 2) - 5,
          left: inputSelect.width() + rightPadding - 10,
          marginBottom: "-7px",
          pointerEvents: "none"
        }).insertAfter(inputSelect);

        // 建立焦點時出現的清單
        var selectList = $("<ol/>").css({
          display: "none",
          listStyleType: "none",
          width: inputSelect.outerWidth() - 2,
          padding: 0, margin: 0,
          border: "solid 1px #ccc",
          fontFamily: inputSelect.css("fontFamily"),
          fontSize: inputSelect.css("fontSize"),
          background: "#fff",
          position: "absolute",
          zIndex: 1000000
        }).insertAfter(triangle);

        // 收集所有原始選項文字
        var resourceData = [];
        originalSelect.children().each(function(index, value){
          prepareOption($(value).text(), wrapper);
          resourceData.push($(value).text());
        });

        inputSelect.focus(function(){
          selectList.fadeIn(100);
          filterOptions(inputSelect.val(), resourceData, wrapper);
        })
        .blur(function(){
          selectList.fadeOut(100);
        })
        .keyup(function(e){
          if (e.which == 13) inputSelect.trigger("blur");
          filterOptions(inputSelect.val(), resourceData, wrapper);
        });

        originalSelect.css({ visibility: "hidden", display: "none" });
        instanceVar = inputSelect;

      } else {
        return false;
      }
    });

    /** 公開方法 **/

    instanceVar.addOption = function(value){
      prepareOption(value, instanceVar.parent());
    };

    instanceVar.removeOption = function(value){
      switch (typeof value) {
        case "number":
          instanceVar.parent().children("ol").children(":nth(" + value + ")").remove();
          break;
        case "string":
          instanceVar.parent().children("ol").children().each(function(index, optionValue){
            if ($(optionValue).text() == value) $(optionValue).remove();
          });
          break;
      }
    };

    instanceVar.restoreSelect = function(){
      var originalSelect = instanceVar.parent().children("select");
      var objID = instanceVar.attr("id");
      instanceVar.parent().before(originalSelect);
      instanceVar.parent().remove();
      originalSelect.css({ visibility: "visible", display: "inline-block" });
      originalSelect.attr({ id: objID });
    };

    return instanceVar;
  };

  /** 私有方法 **/

  // 依關鍵字重新產生可見選項
  function filterOptions(keyword, resourceData, wrapper) {
    var matched = [];
    if (keyword != "") {
      $.each(resourceData, function(i, t){
        if (t.indexOf(keyword) != -1) matched.push(t);
      });
    } else {
      matched = resourceData;
    }
    wrapper.children("ol").empty();
    $.each(matched, function(i, t){ prepareOption(t, wrapper); });
  }

  // 建立單一選項節點
  function prepareOption(value, wrapper) {
    var selectOption = $("<li>" + value + "</li>").appendTo(wrapper.children("ol"));
    var inputSelect = wrapper.children("input");

    selectOption.css({ padding: "3px", textAlign: "left", cursor: "pointer" })
      .hover(function(){ selectOption.css({ backgroundColor: "#eee" }); },
             function(){ selectOption.css({ backgroundColor: "#fff" }); });

    selectOption.click(function(){
      inputSelect.val(selectOption.text());
      inputSelect.trigger("change");
    });
  }
}( jQuery ));

我做的調整與原因

原版的 focus 與 keyup 裡有兩段幾乎完全相同的過濾程式,我把它抽成了 filterOptions 函式。這不只是為了短,而是因為重複的邏輯在修改時極容易只改到一處。

另外原版在過濾時沒有處理「關鍵字為空」的情況——此時 newResourceData 會是空陣列,導致清空輸入框後整個清單變空,得離開再回來才恢復。修正後的空字串會還原完整選項。

可再改善之處

用 li 直接插入文字有 XSS 風險。$("<li>" + value + "</li>") 若 value 含有角括號就會被當成標籤解析,改用 $("<li>").text(value) 較安全。

鍵盤操作不完整。目前只處理 Enter,缺少上下鍵移動與 Esc 關閉,對不靠滑鼠的使用者不友善。

可考慮現成方案。select2、Choices.js 這類成熟套件已把搜尋、鍵盤導航、遠端資料載入、無障礙屬性都處理好了。除非有特殊的客製需求,直接使用它們會省下大量時間。

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