From a0fbbaf0afe6c9504560649c08ce159954fa5082 Mon Sep 17 00:00:00 2001 From: vitalets Date: Sat, 22 Jun 2013 21:01:26 +0400 Subject: [PATCH] select2 with ajax source, fixes #264 --- src/inputs/select2/lib/select2.js | 262 ++++++++++++++++++++---------- src/inputs/select2/select2.js | 139 ++++++++-------- test/index.html | 1 + test/mocks.js | 12 ++ test/unit/select2.js | 86 +++++++++- 5 files changed, 340 insertions(+), 160 deletions(-) diff --git a/src/inputs/select2/lib/select2.js b/src/inputs/select2/lib/select2.js index 992ba8b..60f8086 100644 --- a/src/inputs/select2/lib/select2.js +++ b/src/inputs/select2/lib/select2.js @@ -1,7 +1,7 @@ -/* +/* Copyright 2012 Igor Vaynberg -Version: 3.4.0 Timestamp: Tue May 14 08:27:33 PDT 2013 +Version: @@ver@@ Timestamp: @@timestamp@@ This software is licensed under the Apache License, Version 2.0 (the "Apache License") or the GNU General Public License version 2 (the "GPL License"). You may choose either license to govern your @@ -47,7 +47,7 @@ the specific language governing permissions and limitations under the Apache Lic } var KEY, AbstractSelect2, SingleSelect2, MultiSelect2, nextUid, sizer, - lastMousePosition, $document, scrollBarDimensions, + lastMousePosition={x:0,y:0}, $document, scrollBarDimensions, KEY = { TAB: 9, @@ -172,7 +172,8 @@ the specific language governing permissions and limitations under the Apache Lic } $document.on("mousemove", function (e) { - lastMousePosition = {x: e.pageX, y: e.pageY}; + lastMousePosition.x = e.pageX; + lastMousePosition.y = e.pageY; }); /** @@ -355,6 +356,22 @@ the specific language governing permissions and limitations under the Apache Lic markup.push(escapeMarkup(text.substring(match + tl, text.length))); } + function defaultEscapeMarkup(markup) { + var replace_map = { + '\\': '\', + '&': '&', + '<': '<', + '>': '>', + '"': '"', + "'": ''', + "/": '/' + }; + + return String(markup).replace(/[&<>"'\/\\]/g, function (match) { + return replace_map[match]; + }); + } + /** * Produces an ajax-based query function * @@ -399,7 +416,7 @@ the specific language governing permissions and limitations under the Apache Lic data = data ? data.call(self, query.term, query.page, query.context) : null; url = (typeof url === 'function') ? url.call(self, query.term, query.page, query.context) : url; - if( null !== handler) { handler.abort(); } + if (handler) { handler.abort(); } if (options.params) { if ($.isFunction(options.params)) { @@ -526,7 +543,7 @@ the specific language governing permissions and limitations under the Apache Lic function checkFormatter(formatter, formatterName) { if ($.isFunction(formatter)) return true; if (!formatter) return false; - throw new Error("formatterName must be a function or a falsy value"); + throw new Error(formatterName +" must be a function or a falsy value"); } function evaluate(val) { @@ -746,21 +763,24 @@ the specific language governing permissions and limitations under the Apache Lic // abstract destroy: function () { - var select2 = this.opts.element.data("select2"); + var element=this.opts.element, select2 = element.data("select2"); if (this.propertyObserver) { delete this.propertyObserver; this.propertyObserver = null; } if (select2 !== undefined) { - select2.container.remove(); select2.dropdown.remove(); - select2.opts.element + element .removeClass("select2-offscreen") .removeData("select2") .off(".select2") - .attr({"tabindex": this.elementTabIndex}) - .prop("autofocus", this.autofocus||false) - .show(); + .prop("autofocus", this.autofocus || false); + if (this.elementTabIndex) { + element.attr({tabindex: this.elementTabIndex}); + } else { + element.removeAttr("tabindex"); + } + element.show(); } }, @@ -874,7 +894,7 @@ the specific language governing permissions and limitations under the Apache Lic opts.query = this.bind(function (query) { var data = { results: [], more: false }, term = query.term, - children, firstChild, process; + children, placeholderOption, process; process=function(element, collection) { var group; @@ -895,9 +915,9 @@ the specific language governing permissions and limitations under the Apache Lic // ignore the placeholder option if there is one if (this.getPlaceholder() !== undefined && children.length > 0) { - firstChild = children[0]; - if ($(firstChild).text() === "") { - children=children.not(firstChild); + placeholderOption = this.getPlaceholderOption(); + if (placeholderOption) { + children=children.not(placeholderOption); } } @@ -1201,7 +1221,7 @@ the specific language governing permissions and limitations under the Apache Lic scroll = "scroll." + cid, resize = "resize."+cid, orient = "orientationchange."+cid, - mask; + mask, maskCss; this.container.addClass("select2-dropdown-open").addClass("select2-container-active"); @@ -1218,7 +1238,7 @@ the specific language governing permissions and limitations under the Apache Lic mask.attr("id","select2-drop-mask").attr("class","select2-drop-mask"); mask.hide(); mask.appendTo(this.body()); - mask.on("mousedown touchstart", function (e) { + mask.on("mousedown touchstart click", function (e) { var dropdown = $("#select2-drop"), self; if (dropdown.length > 0) { self=dropdown.data("select2"); @@ -1242,20 +1262,22 @@ the specific language governing permissions and limitations under the Apache Lic this.dropdown.attr("id", "select2-drop"); // show the elements - mask.css(_makeMaskCss()); - mask.show(); + maskCss=_makeMaskCss(); + + mask.css(maskCss).show(); + this.dropdown.show(); this.positionDropdown(); this.dropdown.addClass("select2-drop-active"); - this.ensureHighlightVisible(); // attach listeners to events that can change the position of the container and thus require // the position of the dropdown to be updated as well so it does not come unglued from the container var that = this; this.container.parents().add(window).each(function () { $(this).on(resize+" "+scroll+" "+orient, function (e) { - $("#select2-drop-mask").css(_makeMaskCss()); + var maskCss=_makeMaskCss(); + $("#select2-drop-mask").css(maskCss); that.positionDropdown(); }); }); @@ -1294,6 +1316,16 @@ the specific language governing permissions and limitations under the Apache Lic this.opts.element.trigger($.Event("select2-close")); }, + /** + * Opens control, sets input value, and updates results. + */ + // abstract + externalSearch: function (term) { + this.open(); + this.search.val(term); + this.updateResults(false); + }, + // abstract clearSearch: function () { @@ -1487,7 +1519,6 @@ the specific language governing permissions and limitations under the Apache Lic } function postRender() { - results.scrollTop(0); search.removeClass("select2-active"); self.positionDropdown(); } @@ -1512,7 +1543,7 @@ the specific language governing permissions and limitations under the Apache Lic } else { render(""); } - if (initial) this.showSearch(true); + if (initial && this.showSearch) this.showSearch(true); return; } @@ -1586,7 +1617,7 @@ the specific language governing permissions and limitations under the Apache Lic postRender(); - this.opts.element.trigger({ type: "select2-loaded", data:data }); + this.opts.element.trigger({ type: "select2-loaded", items: data }); })}); }, @@ -1623,15 +1654,34 @@ the specific language governing permissions and limitations under the Apache Lic if (data) { this.highlight(index); this.onSelect(data, options); + } else if (options.noFocus) { + this.close(); } }, // abstract getPlaceholder: function () { + var placeholderOption; return this.opts.element.attr("placeholder") || this.opts.element.attr("data-placeholder") || // jquery 1.4 compat this.opts.element.data("placeholder") || - this.opts.placeholder; + this.opts.placeholder || + ((placeholderOption = this.getPlaceholderOption()) !== undefined ? placeholderOption.text() : undefined); + }, + + // abstract + getPlaceholderOption: function() { + if (this.select) { + var firstOption = this.select.children().first(); + if (this.opts.placeholderOption !== undefined ) { + //Determine the placeholder option based on the specified placeholderOption setting + return (this.opts.placeholderOption === "first" && firstOption) || + (typeof this.opts.placeholderOption === "function" && this.opts.placeholderOption(this.select)); + } else if (firstOption.text() === "" && firstOption.val() === "") { + //No explicit placeholder option specified, use the first if it's blank + return firstOption; + } + } }, /** @@ -1662,12 +1712,12 @@ the specific language governing permissions and limitations under the Apache Lic } } - // next check if css('width') can resolve a width that is percent based, this is sometimes possible - // when attached to input type=hidden or elements hidden via css - style = this.opts.element.css('width'); - if (style && style.length > 0) return style; - if (this.opts.width === "resolve") { + // next check if css('width') can resolve a width that is percent based, this is sometimes possible + // when attached to input type=hidden or elements hidden via css + style = this.opts.element.css('width'); + if (style.indexOf("%") > 0) return style; + // finally, fallback on the calculated width of the element return (this.opts.element.outerWidth(false) === 0 ? 'auto' : this.opts.element.outerWidth(false) + 'px'); } @@ -1702,7 +1752,7 @@ the specific language governing permissions and limitations under the Apache Lic "", "
" , " " , " " , @@ -1719,8 +1769,14 @@ the specific language governing permissions and limitations under the Apache Lic // single opening: function () { - var el, range; + var el, range, len; + + if (this.opts.minimumResultsForSearch >= 0) { + this.showSearch(true); + } + this.parent.opening.apply(this, arguments); + if (this.showSearchInput !== false) { // IE appends focusser.val() at the end of field :/ so we manually insert it at the beginning using a range // all other browsers handle this just fine @@ -1728,13 +1784,16 @@ the specific language governing permissions and limitations under the Apache Lic this.search.val(this.focusser.val()); } this.search.focus(); - // in IE we have to move the cursor to the end after focussing, otherwise it will be at the beginning and + // move the cursor to the end after focussing, otherwise it will be at the beginning and // new text will appear *before* focusser.val() el = this.search.get(0); if (el.createTextRange) { range = el.createTextRange(); range.collapse(false); range.select(); + } else if (el.setSelectionRange) { + len = this.search.val().length; + el.setSelectionRange(len, len); } this.focusser.prop("disabled", true).val(""); @@ -1779,7 +1838,11 @@ the specific language governing permissions and limitations under the Apache Lic container = this.container, dropdown = this.dropdown; - this.showSearch(false); + if (this.opts.minimumResultsForSearch < 0) { + this.showSearch(false); + } else { + this.showSearch(true); + } this.selection = selection = container.find(".select2-choice"); @@ -1846,6 +1909,9 @@ the specific language governing permissions and limitations under the Apache Lic if (e.which == KEY.DOWN || e.which == KEY.UP || (e.which == KEY.ENTER && this.opts.openOnEnter)) { + + if (e.altKey || e.ctrlKey || e.shiftKey || e.metaKey) return; + this.open(); killEvent(e); return; @@ -1863,9 +1929,11 @@ the specific language governing permissions and limitations under the Apache Lic installKeyUpChangeEvent(this.focusser); this.focusser.on("keyup-change input", this.bind(function(e) { - e.stopPropagation(); - if (this.opened()) return; - this.open(); + if (this.opts.minimumResultsForSearch >= 0) { + e.stopPropagation(); + if (this.opened()) return; + this.open(); + } })); selection.on("mousedown", "abbr", this.bind(function (e) { @@ -1925,7 +1993,8 @@ the specific language governing permissions and limitations under the Apache Lic clear: function(triggerChange) { var data=this.selection.data("select2-data"); if (data) { // guard against queued quick consecutive clicks - this.opts.element.val(""); + var placeholderOption = this.getPlaceholderOption(); + this.opts.element.val(placeholderOption ? placeholderOption.val() : ""); this.selection.find("span").empty(); this.selection.removeData("select2-data"); this.setPlaceholder(); @@ -1943,7 +2012,7 @@ the specific language governing permissions and limitations under the Apache Lic // single initSelection: function () { var selected; - if (this.opts.element.val() === "" && this.opts.element.text() === "") { + if (this.isPlaceholderOptionSelected()) { this.updateSelection([]); this.close(); this.setPlaceholder(); @@ -1959,6 +2028,14 @@ the specific language governing permissions and limitations under the Apache Lic } }, + isPlaceholderOptionSelected: function() { + var placeholderOption; + return ((placeholderOption = this.getPlaceholderOption()) !== undefined && placeholderOption.is(':selected')) || + (this.opts.element.val() === "") || + (this.opts.element.val() === undefined) || + (this.opts.element.val() === null); + }, + // single prepareOpts: function () { var opts = this.parent.prepareOpts.apply(this, arguments), @@ -1997,9 +2074,9 @@ the specific language governing permissions and limitations under the Apache Lic // single getPlaceholder: function() { - // if a placeholder is specified on a single select without the first empty option ignore it + // if a placeholder is specified on a single select without a valid placeholder option ignore it if (this.select) { - if (this.select.find("option").first().text() !== "") { + if (this.getPlaceholderOption() === undefined) { return undefined; } } @@ -2011,10 +2088,10 @@ the specific language governing permissions and limitations under the Apache Lic setPlaceholder: function () { var placeholder = this.getPlaceholder(); - if (this.opts.element.val() === "" && placeholder !== undefined) { + if (this.isPlaceholderOptionSelected() && placeholder !== undefined) { - // check for a first blank option if attached to a select - if (this.select && this.select.find("option:first").text() !== "") return; + // check for a placeholder option if attached to a select + if (this.select && this.getPlaceholderOption() === undefined) return; this.selection.find("span").html(this.opts.escapeMarkup(placeholder)); @@ -2039,22 +2116,27 @@ the specific language governing permissions and limitations under the Apache Lic // and highlight it if (noHighlightUpdate !== false) { - this.highlight(selected); - } - - // show the search box if this is the first we got the results and there are enough of them for search - - if (initial === true && this.showSearchInput === false) { - var min=this.opts.minimumResultsForSearch; - if (min>=0) { - this.showSearch(countResults(data.results)>=min); + if (initial === true && selected >= 0) { + this.highlight(selected); + } else { + this.highlight(0); } } + // hide the search box if this is the first we got the results and there are enough of them for search + + if (initial === true) { + var min = this.opts.minimumResultsForSearch; + if (min >= 0) { + this.showSearch(countResults(data.results) >= min); + } + } }, // single showSearch: function(showSearchInput) { + if (this.showSearchInput === showSearchInput) return; + this.showSearchInput = showSearchInput; this.dropdown.find(".select2-search").toggleClass("select2-search-hidden", !showSearchInput); @@ -2087,7 +2169,7 @@ the specific language governing permissions and limitations under the Apache Lic // single updateSelection: function (data) { - var container=this.selection.find("span"), formatted; + var container=this.selection.find("span"), formatted, cssClass; this.selection.data("select2-data", data); @@ -2096,6 +2178,10 @@ the specific language governing permissions and limitations under the Apache Lic if (formatted !== undefined) { container.append(this.opts.escapeMarkup(formatted)); } + cssClass=this.opts.formatSelectionCssClass(data, container); + if (cssClass !== undefined) { + container.addClass(cssClass); + } this.selection.removeClass("select2-default"); @@ -2135,14 +2221,14 @@ the specific language governing permissions and limitations under the Apache Lic this.triggerChange({added: data, removed:oldData}); } } else { - if (this.opts.initSelection === undefined) { - throw new Error("cannot call val() if initSelection() is not defined"); - } // val is an id. !val is true for [undefined,null,'',0] - 0 is legal if (!val && val !== 0) { this.clear(triggerChange); return; } + if (this.opts.initSelection === undefined) { + throw new Error("cannot call val() if initSelection() is not defined"); + } this.opts.element.val(val); this.opts.initSelection(this.opts.element, function(data){ self.opts.element.val(!data ? "" : self.id(data)); @@ -2374,6 +2460,7 @@ the specific language governing permissions and limitations under the Apache Lic return; case KEY.TAB: this.selectHighlighted({noFocus:true}); + this.close(); return; case KEY.ESC: this.cancel(e); @@ -2424,7 +2511,7 @@ the specific language governing permissions and limitations under the Apache Lic this.opts.element.trigger($.Event("select2-blur")); })); - this.container.on("mousedown", selector, this.bind(function (e) { + this.container.on("click", selector, this.bind(function (e) { if (!this.isInterfaceEnabled()) return; if ($(e.target).closest(".select2-search-choice").length > 0) { // clicked inside a select2 search choice, do not open @@ -2632,11 +2719,16 @@ the specific language governing permissions and limitations under the Apache Lic var choice = enableChoice ? enabledItem : disabledItem, id = this.id(data), val = this.getVal(), - formatted; + formatted, + cssClass; formatted=this.opts.formatSelection(data, choice.find("div")); if (formatted != undefined) { - choice.find("div").replaceWith("
"+this.opts.escapeMarkup(formatted)+"
"); + choice.find("div").replaceWith("
"+this.opts.escapeMarkup(formatted)+"
"); + } + cssClass=this.opts.formatSelectionCssClass(data, choice.find("div")); + if (cssClass != undefined) { + choice.addClass(cssClass); } if(enableChoice){ @@ -2729,7 +2821,11 @@ the specific language governing permissions and limitations under the Apache Lic //If all results are chosen render formatNoMAtches if(!this.opts.createSearchChoice && !choices.filter('.select2-result:not(.select2-selected)').length > 0){ - this.results.append("
  • " + self.opts.formatNoMatches(self.search.val()) + "
  • "); + if(!data || data && !data.more && this.results.find(".select2-no-results").length === 0) { + if (checkFormatter(self.opts.formatNoMatches, "formatNoMatches")) { + this.results.append("
  • " + self.opts.formatNoMatches(self.search.val()) + "
  • "); + } + } } }, @@ -2852,7 +2948,7 @@ the specific language governing permissions and limitations under the Apache Lic } this.opts.initSelection(this.opts.element, function(data){ - var ids=$(data).map(self.id); + var ids=$.map(data, self.id); self.setVal(ids); self.updateSelection(data); self.clearSearch(); @@ -2924,9 +3020,10 @@ the specific language governing permissions and limitations under the Apache Lic var args = Array.prototype.slice.call(arguments, 0), opts, select2, - value, multiple, - allowedMethods = ["val", "destroy", "opened", "open", "close", "focus", "isFocused", "container", "onSortStart", "onSortEnd", "enable", "readonly", "positionDropdown", "data"], - valueMethods = ["val", "opened", "isFocused", "container", "data"]; + method, value, multiple, + allowedMethods = ["val", "destroy", "opened", "open", "close", "focus", "isFocused", "container", "dropdown", "onSortStart", "onSortEnd", "enable", "readonly", "positionDropdown", "data", "search"], + valueMethods = ["val", "opened", "isFocused", "container", "data"], + methodsMap = { search: "externalSearch" }; this.each(function () { if (args.length === 0 || typeof(args[0]) === "object") { @@ -2951,10 +3048,17 @@ the specific language governing permissions and limitations under the Apache Lic value = undefined; select2 = $(this).data("select2"); if (select2 === undefined) return; - if (args[0] === "container") { - value=select2.container; + + method=args[0]; + + if (method === "container") { + value = select2.container; + } else if (method === "dropdown") { + value = select2.dropdown; } else { - value = select2[args[0]].apply(select2, args.slice(1)); + if (methodsMap[method]) method = methodsMap[method]; + + value = select2[method].apply(select2, args.slice(1)); } if (indexOf(args[0], valueMethods) >= 0) { return false; @@ -2988,6 +3092,7 @@ the specific language governing permissions and limitations under the Apache Lic return results; }, formatResultCssClass: function(data) {return undefined;}, + formatSelectionCssClass: function(data, container) {return undefined;}, formatNoMatches: function () { return "No matches found"; }, formatInputTooShort: function (input, min) { var n = min - input.length; return "Please enter " + n + " more character" + (n == 1? "" : "s"); }, formatInputTooLong: function (input, max) { var n = input.length - max; return "Please delete " + n + " character" + (n == 1? "" : "s"); }, @@ -3005,21 +3110,7 @@ the specific language governing permissions and limitations under the Apache Lic separator: ",", tokenSeparators: [], tokenizer: defaultTokenizer, - escapeMarkup: function (markup) { - var replace_map = { - '\\': '\', - '&': '&', - '<': '<', - '>': '>', - '"': '"', - "'": ''', - "/": '/' - }; - - return String(markup).replace(/[&<>"'\/\\]/g, function (match) { - return replace_map[match]; - }); - }, + escapeMarkup: defaultEscapeMarkup, blurOnChange: false, selectOnBlur: false, adaptContainerCssClass: function(c) { return c; }, @@ -3043,7 +3134,8 @@ the specific language governing permissions and limitations under the Apache Lic tags: tags }, util: { debounce: debounce, - markMatch: markMatch + markMatch: markMatch, + escapeMarkup: defaultEscapeMarkup }, "class": { "abstract": AbstractSelect2, "single": SingleSelect2, diff --git a/src/inputs/select2/select2.js b/src/inputs/select2/select2.js index f68b606..271d212 100644 --- a/src/inputs/select2/select2.js +++ b/src/inputs/select2/select2.js @@ -6,19 +6,19 @@ You should manually include select2 distributive: -For make it **Bootstrap-styled** you can use css from [here](https://github.com/t0m/select2-bootstrap-css): +To make it **Bootstrap-styled** you can use css from [here](https://github.com/t0m/select2-bootstrap-css): -**Note:** currently `ajax` source for select2 is not supported, as it's not possible to load it in closed select2 state. -The solution is to load source manually and assign statically. +**Note:** currently `autotext` feature does not work for select2 with `ajax` remote source. +You need initially put both `data-value` and element's text youself. @class select2 @extends abstractinput @since 1.4.1 @final @example - +