AutoComplete Editor
Note Deprecated and probably removed, please use AutoComplete (Kraaden lib) instead
- Using fixed
collectionorcollectionAsync - Editor Options (
AutocompleteOptioninterface) - Using Remote API
- Force User Input
onSelectcallback-
Animated Gif Demo
- See the Editors - Wiki for more general info about Editors (validators, event handlers, ...)
AutoComplete is a functionality that let the user start typing characters and the autocomplete will try to give suggestions according to the characters entered. The collection can be a fixed JSON files (collection of strings or objects) or can also be an external remote resource to an external API. For a demo of what that could look like, take a look at the animated gif demo below.
If you want to pass the entire list to the AutoComplete (like a JSON file or a Web API call), you can do so using the collection or the collectionAsync (the latter will load it asynchronously). You can also see that the Editor and Filter have almost the exact same configuration (apart from the model that is obviously different).
export class GridBasicComponent {
columnDefinitions: Column[];
gridOptions: GridOption;
dataset: any[];
attached(): void {
// your columns definition
this.columnDefinitions = [
{
id: 'countryOfOrigin', name: 'Country of Origin', field: 'countryOfOrigin',
formatter: Formatters.complexObject,
dataKey: 'code', // our list of objects has the structure { code: 'CA', name: 'Canada' }, since we want to use the code`, we will set the dataKey to "code"
labelKey: 'name', // while the displayed value is "name"
type: FieldType.object,
sorter: Sorters.objectString, // since we have set dataKey to "code" our output type will be a string, and so we can use this objectString, this sorter always requires the dataKey
filterable: true,
sortable: true,
minWidth: 100,
editor: {
model: Editors.autoComplete,
customStructure: { label: 'name', value: 'code' },
collectionAsync: this.http.get('assets/data/countries.json'), // this demo will load the JSON file asynchronously
},
filter: {
model: Filters.autoComplete,
customStructure: { label: 'name', value: 'code' },
collectionAsync: this.http.get('assets/data/countries.json'),
}
}
];
this.gridOptions = {
// your grid options config
}
}
}By default HTML is not rendered and the label will simply show HTML as text. But in some cases you might want to render it, you can do so by enabling the enableRenderHtml flag.
NOTE: this is currently only used by the Editors that have a collection which are the MultipleSelect & SingleSelect Editors.
this.columnDefinitions = [
{
id: 'effort-driven', name: 'Effort Driven', field: 'effortDriven',
formatter: Formatters.checkmark,
type: FieldType.boolean,
editor: {
model: Editors.autoComplete,
placeholder: '🔍 search city',
type: FieldType.string,
// example with a fixed Collection (or collectionAsync)
editorOptions: {
openSearchListOnFocus: true, // display the list on focus of the autocomplete (without the need to type anything)
},
enableRenderHtml: true, // this flag only works with a fixed Collection
// collectionAsync: this.http.get(URL_COUNTRIES_COLLECTION),
collection: [
{ value: '', label: '' },
{ value: true, label: 'True', labelPrefix: `<i class="mdi mdi-plus"></i> ` },
{ value: false, label: 'False', labelPrefix: `<i class="mdi mdi-minus"></i> ` }
],
}
}
];All the available options that can be provided as editorOptions to your column definitions can be found under this AutocompleteOption interface and you should cast your editorOptions to that interface to make sure that you use only valid options of the jQueryUI autocomplete library.
editor: {
model: Editors.autoComplete,
editorOptions: {
minLength: 3,
} as AutocompleteOption
}You could also use external 3rd party Web API (can be JSONP query or regular JSON). This will make a much shorter result since it will only return a small subset of what will be displayed in the AutoComplete Editor or Filter. For example, we could use GeoBytes which provide a JSONP Query API for the cities of the world, you can imagine the entire list of cities would be way too big to download locally, so this is why we use such API.
The basic functionality will use built-in jQuery UI styling that is to display a label/value pair item result.
export class GridBasicComponent {
columnDefinitions: Column[];
gridOptions: GridOption;
dataset: any[];
initializeGrid() {
// your columns definition
this.columnDefinitions = [
{
id: 'product', name: 'Product', field: 'product',
filterable: true,
minWidth: 100,
editor: {
model: Editors.autoComplete,
alwaysSaveOnEnterKey: true,
editorOptions: {
openSearchListOnFocus: true,
minLength: 1,
source: (request, response) => {
// assuming your API call returns a label/value pair
yourAsyncApiCall(request.term) // typically you'll want to return no more than 10 results
.then(result => response((results.length > 0) ? results : [{ label: 'No match found.', value: '' }]); })
.catch(error => console.log('Error:', error);
},
} as AutocompleteOption,
},
}
];
this.gridOptions = {
// your grid options config
}
}
}This is the preferred way of dealing with the AutoComplete, the main reason is because the AutoComplete uses an <input/> and that means we can only keep 1 value and if we do then we lose the text label and so using an Object Result makes more sense. Note however that you'll need a bit more code that is because we'll use the FieldType.Object and so we need to provide a custom SortComparer and also a custom Formatters and for them to work we also need to provide a dataKey (the value) and a labelKey (text label) as shown below.
this.columnDefinitions = [
{
id: 'product', name: 'Product', field: 'product',
dataKey: 'id',
labelKey: 'name', // (id/name) pair to override default (value/label) pair
editor: {
model: Editors.autoComplete,
alwaysSaveOnEnterKey: true,
type: 'object',
sortComparer: SortComparers.objectString,
editorOptions: {
openSearchListOnFocus: true,
minLength: 1,
source: (request, response) => {
// assuming your API call returns a label/value pair
yourAsyncApiCall(request.term) // typically you'll want to return no more than 10 results
.then(result => response((results.length > 0) ? results : [{ label: 'No match found.', value: '' }]); })
.catch(error => console.log('Error:', error);
},
} as AutocompleteOption,
},
}
];See animated gif (twoRows or fourCorners)
The lib comes with 2 built-in custom layouts, these 2 layouts also have SASS variables if anyone wants to style it differently. When using the renderItem, it will require the user to provide a layout (2 possible options twoRows or fourCorners) and also a templateCallback that will be executed when rendering the AutoComplete Search List Item. For example:
export class GridBasicComponent {
columnDefinitions: Column[];
gridOptions: GridOption;
dataset: any[];
initializeGrid() {
// your columns definition
this.columnDefinitions = [
{
id: 'product', name: 'Product', field: 'product',
filterable: true,
minWidth: 100,
editor: {
model: Editors.autoComplete,
alwaysSaveOnEnterKey: true,
customStructure: {
label: 'itemName',
value: 'id'
},
editorOptions: {
openSearchListOnFocus: true,
minLength: 1,
source: (request, response) => {
yourAsyncApiCall(request.term) // typically you'll want to return no more than 10 results
.then(result => response((results.length > 0) ? results : [{ label: 'No match found.', value: '' }]); })
.catch(error => console.log('Error:', error);
},
renderItem: {
layout: 'twoRows',
templateCallback: (item: any) => `<div class="autocomplete-container-list">
<div class="autocomplete-left">
<span class="mdi ${item.icon} mdi-26px"></span>
</div>
<div>
<span class="autocomplete-top-left">
<span class="mdi ${item.itemTypeName === 'I' ? 'mdi-information-outline' : 'mdi-content-copy'} mdi-14px"></span>
${item.itemName}
</span>
<div>
</div>
<div>
<div class="autocomplete-bottom-left">${item.itemNameTranslated}</div>
</div>`,
},
} as AutocompleteOption,
},
}
];
this.gridOptions = {
// your grid options config
}
}
}See animated gif (twoRows or fourCorners)
The previous example can also be written using the jQuery UI _renderItem callback and adding classes, this is actually what Aurelia-Slickgrid does internally, you can do it yourself if you wish to have more control on the render callback result.
export class GridBasicComponent {
columnDefinitions: Column[];
gridOptions: GridOption;
dataset: any[];
initializeGrid() {
// your columns definition
this.columnDefinitions = [
{
id: 'product', name: 'Product', field: 'product',
filterable: true,
minWidth: 100,
editor: {
model: Editors.autoComplete,
alwaysSaveOnEnterKey: true,
customStructure: {
label: 'itemName',
value: 'id'
},
editorOptions: {
openSearchListOnFocus: true,
minLength: 1,
classes: {
// choose a custom style layout
// 'ui-autocomplete': 'autocomplete-custom-two-rows',
'ui-autocomplete': 'autocomplete-custom-four-corners',
},
source: (request, response) => {
yourAsyncApiCall(request.term) // typically you'll want to return no more than 10 results
.then(result => response((results.length > 0) ? results : [{ label: 'No match found.', value: '' }]); })
.catch(error => console.log('Error:', error);
},
renderItem: {
layout: 'twoRows',
templateCallback: (item: any) => `<div class="autocomplete-container-list">
<div class="autocomplete-left">
<span class="mdi ${item.icon} mdi-26px"></span>
</div>
<div>
<span class="autocomplete-top-left">
<span class="mdi ${item.itemTypeName === 'I' ? 'mdi-information-outline' : 'mdi-content-copy'} mdi-14px"></span>
${item.itemName}
</span>
<div>
</div>
<div>
<div class="autocomplete-bottom-left">${item.itemNameTranslated}</div>
</div>`,
},
} as AutocompleteOption,
callbacks: {
// callback on the jQuery UI AutoComplete on the instance, example from https://jqueryui.com/autocomplete/#custom-data
_renderItem: (ul: HTMLElement, item: any) => {
const template = `<div class="autocomplete-container-list">
<div class="autocomplete-left">
<!--<img src="http://i.stack.imgur.com/pC1Tv.jpg" width="50" />-->
<span class="mdi ${item.icon} mdi-26px"></span>
</div>
<div>
<span class="autocomplete-top-left">
<span class="mdi ${item.itemTypeName === 'I' ? 'mdi-information-outline' : 'mdi-content-copy'} mdi-14px"></span>
${item.itemName}
</span>
<div>
</div>
<div>
<div class="autocomplete-bottom-left">${item.itemNameTranslated}</div>
</div>`;
return $('<li></li>')
.data('item.autocomplete', item)
.append(template)
.appendTo(ul);
}
},
},
}
];
this.gridOptions = {
// your grid options config
}
}
}Example from an external remote API (geobytes) returning a JSONP response.
export class GridBasicComponent {
columnDefinitions: Column[];
gridOptions: GridOption;
dataset: any[];
attached(): void {
// your columns definition
this.columnDefinitions = [
{
id: 'cityOfOrigin', name: 'City of Origin', field: 'cityOfOrigin',
filterable: true,
minWidth: 100,
editor: {
model: Editors.autoComplete,
placeholder: 'search city', // you can provide an optional placeholder to help your users
// use your own autocomplete options, instead of $.ajax, use http
// here we use $.ajax just because I'm not sure how to configure http with JSONP and CORS
editorOptions: {
minLength: 3, // minimum count of character that the user needs to type before it queries to the remote
source: (request, response) => {
$.ajax({
url: 'http://gd.geobytes.com/AutoCompleteCity',
dataType: 'jsonp',
data: {
q: request.term // geobytes requires a query with "q" queryParam representing the chars typed (e.g.: gd.geobytes.com/AutoCompleteCity?q=van
},
success: (data) => response(data)
});
}
},
},
filter: {
model: Filters.autoComplete,
// placeholder: '🔍 search city', // 🔍 is a search icon, this provide an option placeholder
// use your own autocomplete options, instead of $.ajax, use http
// here we use $.ajax just because I'm not sure how to configure http with JSONP and CORS
filterOptions: {
minLength: 3, // minimum count of character that the user needs to type before it queries to the remote
source: (request, response) => {
$.ajax({
url: 'http://gd.geobytes.com/AutoCompleteCity',
dataType: 'jsonp',
data: {
q: request.term
},
success: (data) => {
response(data);
}
});
}
},
}
}
];
this.gridOptions = {
// your grid options config
}
}
}If you want to add the autocomplete functionality but want the user to be able to input a new option, then follow the example below:
this.columnDefinitions = [{
id: 'area',
name: 'Area',
field: 'area',
type: FieldType.string,
editor: {
model: Editors.autoComplete,
editorOptions: {
minLength: 0,
forceUserInput: true,
source: this.areas, // add here the array
}
}
},
];You can also use the minLength to limit the autocomplete text to 0 characters or more, the default number is 3.
The onSelect will give you the item that was selected from the autocomplete list, it will return it as a label/value pair.
NOTE: you might be tempted to use directly the select callback method from jQueryUI AutoComplete, however doing so will break the internal code of Aurelia-Slickgrid. So the onSelect was really added to still give the user callback with the item selected without overriding and breaking Aurelia-Slickgrid internals and it also includes some extra arguments (row, cell, columnDef, dataContext).
this.columnDefinitions = [{
id: 'area',
name: 'Area',
field: 'area',
type: FieldType.string,
editor: {
model: Editors.autoComplete,
editorOptions: {
minLength: 0,
source: this.areas, // add here the array
onSelect: (e, ui) => {
// the ui object will typically be a `label` and `value` pair
console.log(ui.label, ui.value),
}
}
}
},
];
