mattisg / mootools-meio-autocomplete

A complete mootools Autocomplete plugin

Meio.Autocomplete - Copyright (c) 2010 Fábio Miranda Costa

Meio.Autocomplete - a mootools plugin for creating autocomplete fields.

Introduction

Thats not just another autocomplete plugin. I made it because i needed it to work like a dom select element and because i wanted it to be flexible in a way that i could use anything as the autocomplete list. This plugin can also share the same list element, in a way that it will inject just one dom element on the document if you create more than one autocomplete instance in the same page.

Basic usage

var autocomplete = new Meio.Autocomplete('text_input_id', data, [options, [listInstance]]);

See below for more details on these arguments.

Options

This example shows most of this plugin's options. All the values are the default ones.

#JS
var data = [
	{"value": 0, "text": "Brazil"},
	{"value": 1, "text": "Ajax"},
];

var autocomplete = new Meio.Autocomplete('text_input_id', data, {
	delay: 200, 			// The delay before rendering the list of options. Usefull when you are using the autocomplete with ajax
	minChars: 0,			// The minimum number of characters the user has to input before the list of options to select is shown.
	cacheLength: 20,		// The cache length. Cache will decrease the number of ajax calls. Each time you make a different query it will be cached locally.
	cacheType: 'shared',	// 'shared' or 'own'. The cache instance can be shared with other Meio.Autocomplete instances or this instance can have its own cache.
	selectOnTab: true,		// If the user press the 'tab' key, the current focused option will be selected.
	maxVisibleItems: 10,	// Defines the height of the list. If its 10 the list will have its height adjusted to show 10 options, but you can scroll to the other of course.
	
	onNoItemToList: function(elements){},	// this event is fired when theres no option to list
	onSelect: function(elements, value){},	// this event is fired when you select an option
	onDeselect: function(elements){},		// this event is fired when you deselect an option
	
	filter: {
		/*
			its posible to pass the filters directly or by passing a type and optionaly a path.
			
			filter: function(text, data){}			// filters the data array
			formatMatch: function(text, data, i){}	// this function should return the text value of the data element
			formatItem: function(text, data){}		// the return of this function will be applied to the 'html' of the li's
			
			or
			
			type: 'startswith' or 'contains' // can be any defined on the Meio.Autocomplete.Filter object
			path: 'a.b.c' // path to the text value on each object thats contained on the data array
		*/
	},
	
	fieldOptions: {
		classes: {
			loading: 'ma-loading',	// applied to the field when theres an ajax call being made
			selected: 'ma-selected'	// applied to the field when theres a selected value
		}
	},
	listOptions: {
		width: 'field',	// you can pass any other value settable by set('width') to the list container
		classes: {
			container: 'ma-container',
			hover: 'ma-hover',		// applied to the focused options
			odd: 'ma-odd',			// applied to the odd li's
			even: 'ma-even'			// applied to the even li's
		}
	},
	requestOptions: {
		formatResponse: function(jsonResponse){ // this function should return the array of autocomplete data from your jsonResponse
			return jsonResponse;
		},
		noCache: true,	// nocache is setted by default to avoid cache problem on ie
		// you can pass any of the Request.JSON options here -> http://mootools.net/docs/core/Request/Request.JSON
	},
	urlOptions: {
		queryVarName: 'q',	// the name of the variable that's going to the server with the query value inputed by the user.
		extraParams: null,	// you can pass an array of elements or objects with 'value' and 'name' keys. the value key can 'value' can be a function.
							// ex: if you pass [{'name': 'x', 'value': function(){ return 2; }}] the url generated to get the list of options will have the 'x' parameter with value '2'.
		max: 20				// the max number of options that should be listed. This will be sent to the ajax request as the 'limit' parameter.
	}
},
	listInstance // The instance of the list. Passing a Meio.Autocomplete.List will allow you to have just one list DOM element, saving resources on a heavy page.
);

Events

The following events are fired by Meio.Autocomplete:

*noItemToList(elements) Fired by onkeypress when there are no options to list. 1. elements Hash A Hash containing the ‘field’ and ‘list’ instances. *select(elements, value) Fires when the user selects a suggestion. 1. elements Hash A Hash containing the ‘field’ and ‘list’ instances. 2. value mixed The value associated with the option that has been selected. *deselect Fired when the user deselects a suggestion. 1. elements Hash A Hash containing the ‘field’ and ‘list’ instances.

• highlight(elements, value) Fired when the user highlights a suggestion, either by hovering over it or by selecting it through keystrokes.
  1. elements – (object) An object with the ‘field’ and ‘list’ instances.
  2. value — (object or null) The currently highlighted value. Null if the event is actually a deselection (i.e. list gets hidden).

Demos

See the documentation page, it's full of demos.

Credits

Inspiration and some ideas came from:

• Digitarald's Autocompleter (http://digitarald.de/project/autocompleter/);
• jQuery's Autocomplete (http://docs.jquery.com/Plugins/Autocomplete).

License

The MIT License (http://www.opensource.org/licenses/mit-license.php)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.