A simple jQuery Plugin that converts a select into an text field with suggestions.
Clone or download
Latest commit 78b22fe May 7, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist Bump up to v2.2.5 May 7, 2017
src Removed jQuery<3 dependency (only JQ>1.1.1) May 7, 2017
.gitignore Release v1.0.0 Jun 22, 2016
Gruntfile.js Removed jQuery<3 dependency (only JQ>1.1.1) May 7, 2017
LICENSE Release v1.0.0 Jun 22, 2016
README.md Add Clear option - Clears all options in the dropdown list. May 1, 2017
bower.json Bump up to v2.2.5 May 7, 2017
package.json Bump up to v2.2.5 May 7, 2017

README.md

jQuery Editable Select

NPM version NPM downloads MIT License

jQuery Editable Select is a jQuery plugin that transforms a select into an input field where single elements are shown in real-time according to the entered characters. It scales down to a real select list when javascript is not available.

jQuery Editable Select demo

Demo

See demos here: http://indrimuska.github.io/jquery-editable-select/

Installation

Get jQuery Editable Select from npm, bower or git:

  npm install jquery-editable-select
bower install jquery-editable-select
  git clone   https://github.com/indrimuska/jquery-editable-select.git

Include style and script in your page:

<script src="//code.jquery.com/jquery-1.12.4.min.js"></script>
<script src="//rawgithub.com/indrimuska/jquery-editable-select/master/dist/jquery-editable-select.min.js"></script>
<link href="//rawgithub.com/indrimuska/jquery-editable-select/master/dist/jquery-editable-select.min.css" rel="stylesheet">

Markup

Basic usage

<select id="editable-select">
	<option>Alfa Romeo</option>
	<option>Audi</option>
	<option>BMW</option>
	<option>Citroen</option>
</select>
$('#editable-select').editableSelect();

Default text

The default text showed right after the initialization.

<select id="editable-select">
	<option>Alfa Romeo</option>
	<option selected>Audi</option>
	<option>BMW</option>
	<option>Citroen</option>
</select>

HTML support

All HTML tags in each <option> element will be rendered after initialization.

<select id="editable-select">
	<option>Alfa Romeo - &lt;small&gt;&lt;a href="http://www.alfaromeo.com/"&gt;www.alfaromeo.com&lt;/a&gt;&lt;/small&gt;</option>
	<option>Audi - &lt;small&gt;&lt;a href="http://www.audi.com/"&gt;www.audi.com&lt;/a&gt;&lt;/small&gt;</option>
	<option>BMW - &lt;small&gt;&lt;a href="http://www.bmw.com/"&gt;www.bmw.com&lt;/a&gt;&lt;/small&gt;</option>
	<option>Citroen - &lt;small&gt;&lt;a href="http://www.citroen.com/"&gt;www.citroen.com&lt;/a&gt;&lt;/small&gt;</option>
</select>

Scroll support

If the height of the list rises above 160px, a scrollbar is displayed.

You can change the max-height of the list box by overriding this css rule:

.es-list { max-height: 160px !important; }

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-filter="true".

Property Type Default Description
filter Boolean true Filter (or not) items in list while typing.
effects Enum: "default", "slide", "fade" "default" Easing used for showing and hiding the dropdown list.
duration Integer or Enum: "fast", "slow" "fast" Duration of the easings (in milliseconds).
appendTo String or jQuery element select.parent() Where to append the dropdown list in the DOM.
trigger Enum: "focus", "manual" "focus" How dropdown list is triggered.
$('#editable-select').editableSelect({
	effects: 'slide',
	duration: 200,
	appendTo: 'body'
});

Default settings

You can change the default settings for a plugin by modifying the plugin's Constructor.DEFAULTS object:

$.fn.editableSelect.Constructor.DEFAULTS.effects = 'slide';
// changes default for the plugin's `effects` option to `slide`

Methods

.editableSelect(options);

Transforms the <select> into a typeahead field. Accepts an optional options object.

.editableSelect('show');

Manually shows the dropdown list.

.editableSelect('hide');

Manually hides the dropdown list.

.editableSelect('filter');

Manually filters the dropdown list according to the value of the text field.

.editableSelect('select', $element);

Manually sets the value of the text field to the value of the $element passed as parameter (it must be one of the elements in the dropdown list).

.editableSelect('add', text [, index [, attrs [, data ]]] );

Adds a new option in the dropdown list. You can choose the position where to insert the element (starting from 0) and any attributes (or data-attributes) to be assigned.

.editableSelect('remove', index);

Removes an option in the dropdown list at the given index.

.editableSelect('clear');

Clears all options in the dropdown list.

.editableSelect('destroy');

Destroys the typeahead field and restores the <select> input.

Events

Event Description
created.editable-select Fired after initialization.
show.editable-select Fired immediately when the show instance method has been called.
shown.editable-select Fired when the dropdown has been made visible (will wait for CSS transitions to complete).
hide.editable-select Fired immediately when the hide instance method has been called.
hidden.editable-select Fired when the dropdown has finished being hidden (will wait for CSS transitions to complete).
select.editable-select Fired when an option of the list has been selected. The selected $element is available as property of the event.
$('#editable-select').on('shown.editable-select', function (e) {
	// do something...
});

Keyboard support

jQuery Editable Select includes support for keyboard navigation:

  • up, down arrow keys
    You can navigate through list with keyboard arrows.

  • Enter
    When the list is visible, by pressing Enter button you'll select the highlighted option and replace the input field value with the option label.
    When the list is not visible, Enter will have a normal behavior (submitting the form, etc...)

  • Tab
    If the dropdown list is visible, it closes the dropdown, otherwise it will be opened.

  • Escape
    Hides the list.

License

Copyright (c) 2016 Indri Muska. Licensed under the MIT license.