README

Tom Select

Tom Select is a dynamic, framework agnostic, and lightweight (~16kb gzipped) <select> UI control. With autocomplete and native-feeling keyboard navigation, it's useful for tagging, contact lists, country selectors, and so on. Tom Select was forked from selectize.js with the goal of modernizing the code base, decoupling from jQuery, and expanding functionality.

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. With the Caret Position Plugin, you can use the ← and → arrow keys to move between selected items
Select & delete multiple items at once
Hold down command 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.
Extensible
Plugin API for developing custom features (uses microplugin).
Accessible, Touch Support, Clean API, ...

Usage

<input id="tom-select-it" />
<link rel="stylesheet" href="/css/tom-select.default.css">
<script src="/js/tom-select.complete.js"></script>
<script>
var config = {};
new TomSelect('#tom-select-it',config);
</script>

Available configuration settings are documented here

Installation

All pre-built files needed to use Tom Select can be found in the "dist" folder via any of these sources:

Files

tom-select.complete.js — Includes dependencies and plugins
tom-select.base.js — Does not include any plugins
CSS — Compiled themes
SCSS — Uncompiled theme sources

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.

orchidjs / tom-select

Maintainers

Details