/selectize.js

A jQuery-based <select> UI control with autocomplete and native-feeling keyboard navigation; useful for tagging, contact lists, etc.

Primary LanguageJavaScript

selectize.js

Build Status

Selectize is an extensible jQuery-based custom <select> UI control. It's useful for tagging, contact lists, country selectors, and so on. It clocks in at around ~9kb (gzipped). The goal is to provide a solid & usable experience with a clean and powerful API.

Features

  • Smart Option Ranking
    As the user types, options are efficiently scored and sorted on-the-fly.
  • Multi-property searching
    Want to search an item's title and description? No problem.
  • Caret between items
    Order matters sometimes. Use the [left] and [right] arrow keys to move between selected items.
  • Select & delete multiple items at once
    Hold down [option] on Mac or [ctrl] on Windows to select more than one item to delete.
  • Díåcritîçs supported
    Great for international environments.
  • Item creation
    Allow users to create items on the fly (async saving is supported; the control locks until the callback is fired).
  • Remote data loading
    For when you have thousands of options and want them provided by the server as the user types.
  • Clean API & code
    Interface with it and make modifications easily. Pull requests welcome!
  • Touch Support
    Plays nice with iOS 5+ devices.
  • Extensible
    Plugin API for developing custom features.

Usage

If using Bower, run bower install selectize. Otherwise, grab "selectize.min.js" (or "selectize.js" if in a development environment) and "selectize.css" and include them in your project.

$('select').selectize(options);

The available options are documented here.

IE8 Support

To support Internet Explorer 8, es5-shim must be added your page.

<!--[if lt IE 9]><script src="http://cdnjs.cloudflare.com/ajax/libs/es5-shim/2.0.8/es5-shim.min.js"></script><![endif]-->

Custom Builds

By default, all plugins are included. To hand-pick what plugins (if any) to include, run make with the "plugins" setting. After this completes, grab the js and css from the project root as described above.

make plugins=
make plugins=*
make plugins=remove_button,restore_on_backspace

Contributing

First build your copy with make then try out the bundled examples.

To use the automated test runner, either open "tests/index.html" in a browser, or run make test. The latter requires node.js and testem to be installed (npm install -g testem).

When issuing a pull request, please exclude "selectize.js" and "selectize.min.js" in the project root.

License

Copyright © 2013 Brian Reavis, & Contributors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.