select2: show placeholder when value is empty

This commit is contained in:
vitalets 2013-11-02 22:28:45 +04:00
parent ef3378d274
commit c77ebf6cc7
3 changed files with 72 additions and 46 deletions
CHANGELOG.txt
src/inputs/select2
test/unit

@ -4,6 +4,7 @@ X-editable changelog
Version 1.5.1 wip Version 1.5.1 wip
---------------------------- ----------------------------
[bug] select2: placeholder not shown if value initially empty (vitalets)
[enh #400] allow `validate` to change submitted value, also fix #354 (vitalets) [enh #400] allow `validate` to change submitted value, also fix #354 (vitalets)
[enh #396] bs3 popover: placement `auto` (vitalets) [enh #396] bs3 popover: placement `auto` (vitalets)
[bug #357] select2: tags mode with space separator (vitalets) [bug #357] select2: tags mode with space separator (vitalets)

@ -38,7 +38,11 @@ $(function(){
}); });
//remote source (simple) //remote source (simple)
$('#country').editable({ $('#country').editable({
source: '/getCountries' source: '/getCountries',
select2: {
placeholder: 'Select Country',
minimumInputLength: 1
}
}); });
//remote source (advanced) //remote source (advanced)
$('#country').editable({ $('#country').editable({
@ -114,14 +118,14 @@ $(function(){
options.select2.data = this.sourceData; options.select2.data = this.sourceData;
} }
} }
//overriding objects in config (as by default jQuery extend() is not recursive) //overriding objects in config (as by default jQuery extend() is not recursive)
this.options.select2 = $.extend({}, Constructor.defaults.select2, options.select2); this.options.select2 = $.extend({}, Constructor.defaults.select2, options.select2);
//detect whether it is multi-valued //detect whether it is multi-valued
this.isMultiple = this.options.select2.tags || this.options.select2.multiple; this.isMultiple = this.options.select2.tags || this.options.select2.multiple;
this.isRemote = ('ajax' in this.options.select2); this.isRemote = ('ajax' in this.options.select2);
//store function returning ID of item //store function returning ID of item
//should be here as used inautotext for local source //should be here as used inautotext for local source
this.idFunc = this.options.select2.id; this.idFunc = this.options.select2.id;
@ -129,12 +133,12 @@ $(function(){
var idKey = this.idFunc || 'id'; var idKey = this.idFunc || 'id';
this.idFunc = function (e) { return e[idKey]; }; this.idFunc = function (e) { return e[idKey]; };
} }
//store function that renders text in select2 //store function that renders text in select2
this.formatSelection = this.options.select2.formatSelection; this.formatSelection = this.options.select2.formatSelection;
if (typeof(this.formatSelection) !== "function") { if (typeof(this.formatSelection) !== "function") {
this.formatSelection = function (e) { return e.text; }; this.formatSelection = function (e) { return e.text; };
} }
}; };
$.fn.editableutils.inherit(Constructor, $.fn.editabletypes.abstractinput); $.fn.editableutils.inherit(Constructor, $.fn.editabletypes.abstractinput);
@ -156,49 +160,49 @@ $(function(){
}, this)); }, this));
} }
//trigger resize of editableform to re-position container in multi-valued mode //trigger resize of editableform to re-position container in multi-valued mode
if(this.isMultiple) { if(this.isMultiple) {
this.$input.on('change', function() { this.$input.on('change', function() {
$(this).closest('form').parent().triggerHandler('resize'); $(this).closest('form').parent().triggerHandler('resize');
}); });
} }
}, },
value2html: function(value, element) { value2html: function(value, element) {
var text = '', data, var text = '', data,
that = this; that = this;
if(this.options.select2.tags) { //in tags mode just assign value if(this.options.select2.tags) { //in tags mode just assign value
data = value; data = value;
//data = $.fn.editableutils.itemsByValue(value, this.options.select2.tags, this.idFunc); //data = $.fn.editableutils.itemsByValue(value, this.options.select2.tags, this.idFunc);
} else if(this.sourceData) { } else if(this.sourceData) {
data = $.fn.editableutils.itemsByValue(value, this.sourceData, this.idFunc); data = $.fn.editableutils.itemsByValue(value, this.sourceData, this.idFunc);
} else { } else {
//can not get list of possible values //can not get list of possible values
//(e.g. autotext for select2 with ajax source) //(e.g. autotext for select2 with ajax source)
} }
//data may be array (when multiple values allowed) //data may be array (when multiple values allowed)
if($.isArray(data)) { if($.isArray(data)) {
//collect selected data and show with separator //collect selected data and show with separator
text = []; text = [];
$.each(data, function(k, v){ $.each(data, function(k, v){
text.push(v && typeof v === 'object' ? that.formatSelection(v) : v); text.push(v && typeof v === 'object' ? that.formatSelection(v) : v);
}); });
} else if(data) { } else if(data) {
text = that.formatSelection(data); text = that.formatSelection(data);
} }
text = $.isArray(text) ? text.join(this.options.viewseparator) : text; text = $.isArray(text) ? text.join(this.options.viewseparator) : text;
//$(element).text(text); //$(element).text(text);
Constructor.superclass.value2html.call(this, text, element); Constructor.superclass.value2html.call(this, text, element);
}, },
html2value: function(html) { html2value: function(html) {
return this.options.select2.tags ? this.str2value(html, this.options.viewseparator) : null; return this.options.select2.tags ? this.str2value(html, this.options.viewseparator) : null;
}, },
value2input: function(value) { value2input: function(value) {
// if value array => join it anyway // if value array => join it anyway
if($.isArray(value)) { if($.isArray(value)) {
@ -216,19 +220,23 @@ $(function(){
//Uncaught Error: cannot call val() if initSelection() is not defined //Uncaught Error: cannot call val() if initSelection() is not defined
//this.$input.select2('val', value); //this.$input.select2('val', value);
} }
// if defined remote source AND no multiple mode AND no user's initSelection provided --> // if defined remote source AND no multiple mode AND no user's initSelection provided -->
// we should somehow get text for provided id. // we should somehow get text for provided id.
// The solution is to use element's text as text for that id // The solution is to use element's text as text for that id (exclude empty)
if(this.isRemote && !this.isMultiple && !this.options.select2.initSelection) { if(this.isRemote && !this.isMultiple && !this.options.select2.initSelection) {
// customId and customText are methods to extract `id` and `text` from data object // customId and customText are methods to extract `id` and `text` from data object
// we can use this workaround only if user did not define these methods // we can use this workaround only if user did not define these methods
// otherwise we cant construct data object // otherwise we cant construct data object
var customId = this.options.select2.id, var customId = this.options.select2.id,
customText = this.options.select2.formatSelection; customText = this.options.select2.formatSelection;
if(!customId && !customText) {
var data = {id: value, text: $(this.options.scope).text()}; if(!customId && !customText) {
this.$input.select2('data', data); var $el = $(this.options.scope);
if (!$el.data('editable').isEmpty) {
var data = {id: value, text: $el.text()};
this.$input.select2('data', data);
}
} }
} }
}, },
@ -241,11 +249,11 @@ $(function(){
if(typeof str !== 'string' || !this.isMultiple) { if(typeof str !== 'string' || !this.isMultiple) {
return str; return str;
} }
separator = separator || this.getSeparator(); separator = separator || this.getSeparator();
var val, i, l; var val, i, l;
if (str === null || str.length < 1) { if (str === null || str.length < 1) {
return null; return null;
} }
@ -253,10 +261,10 @@ $(function(){
for (i = 0, l = val.length; i < l; i = i + 1) { for (i = 0, l = val.length; i < l; i = i + 1) {
val[i] = $.trim(val[i]); val[i] = $.trim(val[i]);
} }
return val; return val;
}, },
autosubmit: function() { autosubmit: function() {
this.$input.on('change', function(e, isInitial){ this.$input.on('change', function(e, isInitial){
if(!isInitial) { if(!isInitial) {
@ -268,7 +276,7 @@ $(function(){
getSeparator: function() { getSeparator: function() {
return this.options.select2.separator || $.fn.select2.defaults.separator; return this.options.select2.separator || $.fn.select2.defaults.separator;
}, },
/* /*
Converts source from x-editable format: {value: 1, text: "1"} to Converts source from x-editable format: {value: 1, text: "1"} to
select2 format: {id: 1, text: "1"} select2 format: {id: 1, text: "1"}
@ -282,26 +290,26 @@ $(function(){
} }
} }
} }
return source; return source;
}, },
destroy: function() { destroy: function() {
if(this.$input.data('select2')) { if(this.$input.data('select2')) {
this.$input.select2('destroy'); this.$input.select2('destroy');
} }
} }
}); });
Constructor.defaults = $.extend({}, $.fn.editabletypes.abstractinput.defaults, { Constructor.defaults = $.extend({}, $.fn.editabletypes.abstractinput.defaults, {
/** /**
@property tpl @property tpl
@default <input type="hidden"> @default <input type="hidden">
**/ **/
tpl:'<input type="hidden">', tpl:'<input type="hidden">',
/** /**
Configuration of select2. [Full list of options](http://ivaynberg.github.com/select2). Configuration of select2. [Full list of options](http://ivaynberg.github.com/select2).
@property select2 @property select2
@type object @type object
@default null @default null
@ -313,21 +321,21 @@ $(function(){
@property placeholder @property placeholder
@type string @type string
@default null @default null
**/ **/
placeholder: null, placeholder: null,
/** /**
Source data for select. It will be assigned to select2 `data` property and kept here just for convenience. Source data for select. It will be assigned to select2 `data` property and kept here just for convenience.
Please note, that format is different from simple `select` input: use 'id' instead of 'value'. Please note, that format is different from simple `select` input: use 'id' instead of 'value'.
E.g. `[{id: 1, text: "text1"}, {id: 2, text: "text2"}, ...]`. E.g. `[{id: 1, text: "text1"}, {id: 2, text: "text2"}, ...]`.
@property source @property source
@type array|string|function @type array|string|function
@default null @default null
**/ **/
source: null, source: null,
/** /**
Separator used to display tags. Separator used to display tags.
@property viewseparator @property viewseparator
@type string @type string
@default ', ' @default ', '
@ -335,6 +343,6 @@ $(function(){
viewseparator: ', ' viewseparator: ', '
}); });
$.fn.editabletypes.select2 = Constructor; $.fn.editabletypes.select2 = Constructor;
}(window.jQuery)); }(window.jQuery));

@ -317,7 +317,24 @@ $(function () {
start(); start();
}, timeout); }, timeout);
}, timeout); }, timeout);
}); });
test("remote: initially empty", function () {
var s = 2, text = groups[s],
newVal = 0, newText = groups[newVal],
e = $('<a href="#" data-type="select2" data-name="select2"></a>').appendTo(sfx).editable({
source: 'groupsArr2',
select2: {
placeholder: 'placeholder'
}
});
e.click();
var p = tip(e);
ok(p.is(':visible'), 'popover visible');
equal(p.find('.select2-choice span').text(), 'placeholder', 'placeholder shown in select2');
});
asyncTest("remote: custom id, custom text, init selection (not multiple)", function () { asyncTest("remote: custom id, custom text, init selection (not multiple)", function () {
var s = 2, var s = 2,