Selectize needs your help. I'm looking for maintainers!

selectize.js

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 ~7kb (gzipped). The goal is to provide a solid & usable experience with a clean and powerful API.

Features

Smart Option Searching / Ranking
Options are efficiently scored and sorted on-the-fly (using sifter). Want to search an item's title and description? No problem.
Caret between items
Order matters sometimes. Use the ← and → 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!
Extensible
Plugin API for developing custom features (uses microplugin).
Touch Support
Plays nice with iOS 5+ devices.

Dependencies

jquery (1.7 and greater)
sifter (bundled in "standalone" build)
microplugin (bundled in "standalone" build)

Files

All pre-built files needed to use Selectize can be found in the "dist" folder.

js/
- standalone/
  - selectize.js — With dependencies, minus jquery
- selectize.js — Without dependencies
less/
- selectize.less — Core styles
- selectize.default.less — Default theme
- selectize.bootstrap2.less — Bootstrap 2 theme
- selectize.bootstrap3.less — Bootstrap 3 theme
- plugins/ — Individual plugin styles
css/
- selectize.css — Core styles
- selectize.default.css — Default theme (with core styles)
- selectize.bootstrap2.css - Bootstrap 2 theme
- selectize.bootstrap3.css - Bootstrap 3 theme

Usage

$('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 grunt with the "--plugins" flag. After this completes, grab the files you need from the "dist" folder.

# dependencies
npm install

# build selectize
grunt --plugins=
grunt --plugins=*
grunt --plugins=remove_button,restore_on_backspace

Contributing

When issuing a pull request, please exclude changes in the "dist" folder to avoid merge conflicts. Please include tests with your feature so that we're not tempted to break it in the future!

Add an entry to the top of the CHANGELOG, and update the documentation in docs/ as needed. (Refactors and documentation changes don't need a changelog entry.)

Squash your commits together in one or a few complete, logical commits, with a concise and descriptive message. One commit means one feature/bugfix/thing that has changed, or a diff bringing the code one step forward to a better, working state.

Also, please ensure all the tests pass:

$ npm test # phantomjs
$ BROWSERS=Firefox npm test
$ BROWSERS=Firefox,Chrome npm test
$ BROWSERS=Firefox,Chrome,Safari npm test

License

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.

tech-consortium/selectize.js