无法在Select2下拉列表中选择项目

时间:2014-09-27 11:57:33

标签: javascript html jquery-select2

我正在开发一款使用Select2(版本3.5.1)的应用。设置此下拉/自动填充字段的HTML如下所示:

<input id="mySelect" class="form-control" type="hidden">

此代码段中的form-control类来自Bootstrap。我正在使用以下代码从JavaScript初始化此字段:

function getItemFormat(item) {
  var format = '<div>' + item.ItemName + '</div>';
  return format;
}

$(function() {
  $('#mySelect').select2({
    minimumInputLength: 5,
    placeholder: 'Search for an item',
    allowClear: true,
    ajax: {
      url: '/api/getItems',
      dataType: 'json',
      quietMillis: 250,
      data: function (term, page) {
        return {
          query: term
        };
      },
      results: function (data, page) {
        return { results: data, id: 'ItemId', text: 'ItemText' };
      }
    },
    formatResult: getItemFormat,
    dropdownCssClass: "bigdrop",
    escapeMarkup: function (m) { return m; }
  });
});

当我的选择字段加载时,它会成功渲染。一旦我输入至少第五个字符,它就会成功从服务器中提取项目并将它们列为选项。但是,如果我尝试选择其中一个,则没有任何反应。下拉弹出窗口保持打开状态。在实际领域没有任何东西。 JavaScript控制台中没有错误。就像我没有点击任何东西一样。

此外,我注意到当我将鼠标放在某个项目上或尝试使用箭头键导航选项列表时,没有任何内容突出显示。

我做错了什么?

4 个答案:

答案 0 :(得分:45)

发生了什么:

默认情况下,您在results中返回的对象的ajax.results应该是此结构[{id:1,text:"a"},{id:2,text:"b"}, ...]中的数组。

  results: function (data, page) {
    var array = data.results; //depends on your JSON
    return { results: array };
  }


Select2.js中,它实际上说明了:

* @param options.results a function(remoteData, pageNumber, query) that converts data returned form the remote request to the format expected by Select2.
*      The expected format is an object containing the following keys:
*      results array of objects that will be used as choices
*      more (optional) boolean indicating whether there are more results available
*      Example: {results:[{id:1, text:'Red'},{id:2, text:'Blue'}], more:true}


阅读源代码,我们可以看到在AJAX成功时调用了ajax.results

   success: function (data) {
                        // TODO - replace query.page with query so users have access to term, page, etc.
                        // added query as third paramter to keep backwards compatibility
                        var results = options.results(data, query.page, query);
                        query.callback(results);
                    }


所以ajax.results实际上只是一种函数,可以在将数据传递给[{id:a,text:"a"},{id:b,text:"b"}, ...]之前将数据格式化为适当的结构(例如query.callback):

 callback: this.bind(function (data) {

                    // ignore a response if the select2 has been closed before it was received
                    if (!self.opened()) return;


                    self.opts.populateResults.call(this, results, data.results, {term: term, page: page, context:context});
                    self.postprocessResults(data, false, false);

                    if (data.more===true) {
                        more.detach().appendTo(results).html(self.opts.escapeMarkup(evaluate(self.opts.formatLoadMore, self.opts.element, page+1)));
                        window.setTimeout(function() { self.loadMoreIfNeeded(); }, 10);
                    } else {
                        more.remove();
                    }
                    self.positionDropdown();
                    self.resultsPage = page;
                    self.context = data.context;
                    this.opts.element.trigger({ type: "select2-loaded", items: data });
                })});


query.callback最终做的是正确设置逻辑,以便在您选择其中一个项目并触发.selectChoice时一切正常。

selectChoice: function (choice) {

            var selected = this.container.find(".select2-search-choice-focus");
            if (selected.length && choice && choice[0] == selected[0]) {

            } else {
                if (selected.length) {
                    this.opts.element.trigger("choice-deselected", selected);
                }
                selected.removeClass("select2-search-choice-focus");
                if (choice && choice.length) {
                    this.close();
                    choice.addClass("select2-search-choice-focus");
                    this.opts.element.trigger("choice-selected", choice);
                }
            }
        } 


因此,如果有一些错误配置(例如results不在正确的结构中)导致在调用.select2-search-choice-focus之前不将类.selectChoice添加到DOM元素,是怎么回事:

  

下拉弹出窗口保持打开状态。在实际领域没有任何东西。 JavaScript控制台中没有错误。就像我没有点击任何东西一样。


解决方案

有很多解决方案。当然,其中一个是ajax.results中的一些数组键操作。

  results: function (data, page) {
  //data = { results:[{ItemId:1,ItemText:"a"},{ItemId:2,ItemText:"b"}] };
    var array = data.results;
    var i = 0;
    while(i < array.length){
        array[i]["id"] = array[i]['ItemId'];
        array[i]["text"] = array[i]['ItemText'];
        delete array[i]["ItemId"];
        delete array[i]["ItemText"];
    i++;
    }
    return { results: array };
  }

但你可能会问:为什么id必须是&#34; id&#34;并且文本是&#34; text&#34;在阵列?

[{id:1,text:"a"},{id:2,text:"b"}] 

数组是否可以使用此结构?

[{ItemId:1,ItemText:"a"},{ItemId:2,ItemText:"b"}]

答案是肯定的。您只需要使用自己的函数覆盖idtext函数。


以下是Select2.js.selecte2的原始函数:

    id: function (e) { return e == undefined ? null : e.id; },
    text: function (e) {
      if (e && this.data && this.data.text) {
        if ($.isFunction(this.data.text)) {
          return this.data.text(e);
        } else {
          return e[this.data.text];
        }
      } else {
        return e.text;
      }
    },


要覆盖它们,只需在传递给.selecte2的对象中添加自己的函数:

$('#mySelect').select2({
id: function (item) { return item.ItemId },
text: function (item) { return item.ItemText }
......
});

更新

还发生了什么:

  

但是,列表关闭后,所选项目的文本不会出现在字段中。

这意味着.selectChoice已成功执行。现在问题在于.updateSelection。在源代码中:

   updateSelection: function (data) {

        var container=this.selection.find(".select2-chosen"), formatted, cssClass;

        this.selection.data("select2-data", data);

        container.empty();
        if (data !== null) {
            formatted=this.opts.formatSelection(data, container, this.opts.escapeMarkup);
        }
        if (formatted !== undefined) {
            container.append(formatted);
        }
        cssClass=this.opts.formatSelectionCssClass(data, container);
        if (cssClass !== undefined) {
            container.addClass(cssClass);
        }

        this.selection.removeClass("select2-default");

        if (this.opts.allowClear && this.getPlaceholder() !== undefined) {
            this.container.addClass("select2-allowclear");
        }
    }


从这里我们可以看到,在将相应的文本字符串放入输入之前,它会调用formatSelection

formatSelection: function (data, container, escapeMarkup) {
            return data ? escapeMarkup(this.text(data)) : undefined;
        },

更新:解决方案

以前我认为this.text(data)可以通过在参数中加text: funcion(item){ ... }来覆盖,但遗憾的是它不会那样工作。

因此,要在字段中正确呈现文本,您应该通过执行

覆盖formatSelection
$('#mySelect').select2({
id: function (item) { return item.ItemId },
formatSelection: function (item) { return item.ItemText }
//......
});

而不是试图覆盖text(应该具有相同的效果但是这种覆盖方式尚未在库中支持/实现)

$('#mySelect').select2({
id: function (item) { return item.ItemId },
text: function (item) { return item.ItemText }  //this will not work.
//......
});

答案 1 :(得分:8)

您面临的问题是select2希望您的所有结果都拥有id属性。如果它们不需要,则需要使用id函数初始化,该函数返回每个结果的id。

除非您满足其中一项,否则不允许您选择结果。所以就你的例子而言:

function getItemFormat(item) {
  var format = '<div>' + item.ItemName + '</div>';
  return format;
}

$(function() {
  $('#mySelect').select2({
    minimumInputLength: 5,
    placeholder: 'Search for an item',
    allowClear: true,
    id: function(item) { return item.ItemId; },    /* <-- ADDED FUNCTION */
    ajax: {
      url: '/api/getItems',
      dataType: 'json',
      quietMillis: 250,
      data: function (term, page) {
        return {
          query: term
        };
      },
      results: function (data, page) {
        return { results: data, id: 'ItemId', text: 'ItemText' };
      }
    },
    formatResult: getItemFormat,
    dropdownCssClass: "bigdrop",
    escapeMarkup: function (m) { return m; }
  });
});

答案 2 :(得分:2)

你需要提供一个从你的API返回的ID,如@itsmejodie所说。 另一个问题是,您必须提供select2 formatResultformatSelection函数,一旦从Ajax加载它,但您无法将html放在其上。 e.g:

function format (item) { 
  return item.name; 
}

$(function() {
    $('#mySelect').select2({
      minimumInputLength: 2,
      placeholder: 'Search for an item',
      allowClear: true,
      ajax: {
        url: '/api/getItems',
        dataType: 'jsonp',
        quietMillis: 250,
        data: function (term, page) {
          return {
            query: term
          };
        },
        results: function (data, page) {
          return { results: data };
        }
      },
      formatResult: format,
      formatSelection: format
    });
});

答案 3 :(得分:0)

对于Select2的版本4使用

processResults: function (data) { 

代替

results: function (data) {