tom-select

Tom Select is a versatile and dynamic <select> UI control. Forked from Selectize.js to provide a framework agnostic autocomplete widget with native-feeling keyboard navigation, it's useful for tagging, contact lists, country selectors, etc.

Usage no npm install needed!

<script type="module">
  import tomSelect from 'https://cdn.skypack.dev/tom-select';
</script>

README

Tom Select

GitHub Repo stars jsDelivr hits (npm) npmjs.org travis-ci.com Coveralls Coverage GitHub Issues

Tom Select is an extensible and dynamic <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:

Source
jsDelivr The fastest way to add Tom Select into your project is to just include the js and css from jsDelivr.
<link href="https://cdn.jsdelivr.net/npm/tom-select/dist/css/tom-select.css" rel="stylesheet">
<script src="https://cdn.jsdelivr.net/npm/tom-select/dist/js/tom-select.complete.min.js"></script>
npm
npm i tom-select
GitHub Clone or download the full repo. Use npm run build and other commands to build from source, test and start the doc server.

Files

Platinum Sponsors

Many thanks to all our sponsors who help make development possible. Become a sponsor.



Sponsors


Trust My Paper Logo


License

Copyright © 2013–2021 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.