agerix/jQuery-Autocomplete
2
0
Fork 0
mirror of https://github.com/devbridge/jQuery-Autocomplete.git synced 2024-11-09 23:01:00 +00:00
Code Issues Releases Activity

Call transformResult on the value returned from the server. Fixes #49

Browse Source
This commit is contained in:
Tomas Kirda 2013-02-21 16:25:07 -06:00
parent 52151c267b
commit a362ce1b06
3 changed files with 66 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
readme.md
View File

@ -34,7 +34,7 @@ The standard jquery.autocomplete.js file is around 2.7KB when minified via Closu
* `onSearchComplete`: `function (query) {}` called after ajax response is processed. `this` is bound to input element.
* `tabDisabled`: Default `false`. Set to true to leave the cursor in the input field after the user tabs to select a suggestion.
* `paramName`: Default `query`. The name of the request parameter that contains the query.
* `transformResult`: `function(response) {}` called after the result of the query is ready. Converts the result into response.suggestions format.
* `transformResult`: `function(response, originalQuery) {}` called after the result of the query is ready. Converts the result into response.suggestions format.
* `autoSelectFirst`: if set to `true`, first item will be selected when showing suggestions. Default value `false`.
* `appendTo`: container where suggestions will be appended. Default value `body`. Can be jQuery object, selector or html element. Make sure to set `position: absolute` or `position: relative` for that element.
* `dataType`: type of data returned from server. Either 'text' (default) or 'jsonp', which will cause the autocomplete to use jsonp. You may return a json object in your callback when using jsonp.
@ -115,10 +115,13 @@ you can supply the "paramName" and "transformResult" options:
$('#autocomplete').autocomplete({
paramName: 'searchString',
transformResult: function(response) {
return $.map(response.myData, function(dataItem) {
transformResult: function(response, originalQuery) {
return {
query: originalQuery,
suggestions: $.map(response.myData, function(dataItem) {
return { value: dataItem.valueField, data: dataItem.dataField };
});
})
};
}
})

39
spec/autocompleteBehavior.js
View File

@ -171,6 +171,45 @@ describe('Autocomplete', function () {
});
});
it('Should transform results', function () {
var input = document.createElement('input'),
ajaxExecuted = false,
url = '/test-transform',
autocomplete = new $.Autocomplete(input, {
serviceUrl: url,
transformResult: function (result, query) {
return {
query: query,
suggestions: $.map(result.split(','), function (item) {
return { value: item, data: null };
})
};
}
});
$.mockjax({
url: url,
responseTime: 50,
response: function () {
ajaxExecuted = true;
this.responseText = 'Andora,Angola,Argentina';
}
});
input.value = 'A';
autocomplete.onValueChange();
waitsFor(function () {
return ajaxExecuted;
}, 'Ajax call never completed.', 100);
runs(function () {
expect(ajaxExecuted).toBe(true);
expect(autocomplete.suggestions.length).toBe(3);
expect(autocomplete.suggestions[0].value).toBe('Andora');
});
});
it('Should should not preventDefault when tabDisabled is set to false', function () {
var input = document.createElement('input'),
autocomplete = new $.Autocomplete(input, {

27
src/jquery.autocomplete.js
View File

@ -94,8 +94,8 @@
return suggestion.value.toLowerCase().indexOf(queryLowerCase) !== -1;
},
paramName: 'query',
transformResult: function (response) {
return response.suggestions;
transformResult: function (response, originalQuery) {
return typeof response === 'string' ? $.parseJSON(response) : response;
}
};
@ -408,8 +408,8 @@
data: options.params,
type: options.type,
dataType: options.dataType
}).done(function (txt) {
that.processResponse(txt);
}).done(function (data) {
that.processResponse(data, q);
options.onSearchComplete.call(that.element, q);
});
}
@ -475,23 +475,24 @@
return suggestions;
},
processResponse: function (text) {
processResponse: function (response, originalQuery) {
var that = this,
response = typeof text == 'string' ? $.parseJSON(text) : text;
options = that.options,
result = that.options.transformResult(response, originalQuery);
response.suggestions = that.verifySuggestionsFormat(that.options.transformResult(response));
result.suggestions = that.verifySuggestionsFormat(result.suggestions);
// Cache results if cache is not disabled:
if (!that.options.noCache) {
that.cachedResponse[response[that.options.paramName]] = response;
if (response.suggestions.length === 0) {
that.badQueries.push(response[that.options.paramName]);
if (!options.noCache) {
that.cachedResponse[result[options.paramName]] = result;
if (result.suggestions.length === 0) {
that.badQueries.push(result[options.paramName]);
}
}
// Display suggestions only if returned query matches current value:
if (response[that.options.paramName] === that.getQuery(that.currentValue)) {
that.suggestions = response.suggestions;
if (result[options.paramName] === that.getQuery(that.currentValue)) {
that.suggestions = result.suggestions;
that.suggest();
}
},