Repository files navigation

→ Selectize is looking fornew members on the maintenance team!

Selectize is an extensiblejQuery-based custom<select>; UI control. It's useful for tagging, contact lists, country selectors, and so on. The goal is to provide a solid & usable experience with a clean and powerful API.

• Demos
• Changelog
• Documentation

• Smart Option Searching / RankingOptions are efficiently scored and sorted on-the-fly (usingsifter). Want to search for an item's titleand description? No problem.
• Caret between itemsOrder matters sometimes. Use the← and→ arrow keys to move between selected items.
• Select & delete multiple items at onceHold downoption on Mac orctrl on Windows to select more than one item to delete.
• Díåcritîçs supportedGreat for international environments.
• Item creationAllow users to create items on the fly (async saving is supported; the control locks until the callback is fired).
• Remote data loadingFor when you have thousands of options and want them provided by the server as the user types.
• Clean API & codeInterface with it and make modifications easily. Pull requests are always welcome!
• ExtensiblePlugin API for developing custom features (usesmicroplugin).
• Touch SupportPlays nice with iOS 5+ devices.

• jquery (1.7 and greater), aspeer dependency
  • Note: it is installed automatically in development, or in projects using NPM 1 or 2. When using NPM from version 3 on, just a warning is thrown and the user needs to manually install an explicit version in their own project (e.g.npm install --save jquery@3.5.1).

Optional:

• jquery-ui (required bydrag_drop plugin)

Selectize can be installed via NPMnpm install @selectize/selectize

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

If you're looking to get started with minimal fuss, includeselectize.min.js (bundles Sifter and Microplugindependencies – also available un-minified for debugging, just remove the.min part) andcss/selectize.default.css.

Selectize is available atcdnjs.

• js/
  • selectize.js — With dependencies, minus jquery
  • selectize.min.js — With dependencies, minus jquery
• scss/ — Sass source files for customization (Bootstrap 3+ compatible)
• less/ — Less source files for customization (Bootstrap 2/3 compatible)
• 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
  • selectize.bootstrap4.css - Bootstrap 4 theme
  • selectize.bootstrap5.css - Bootstrap 5 theme

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

The available options aredocumented here.

When issuing a pull request:

• pleasedo not include/commit changes in thedist/ orlib/ folders to avoidmerge conflicts. A good way to include the right files is to usegit gui orgit add when committing to select the files you want toadd to your commit.

• pleaseinclude tests with your feature so that we're not tempted tobreak it in the future!

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

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

Once your commit is nice and clean, and you want todiscard the otherchanges, you can usegit checkout . (that will erase changes totracked files) andgit clean [-i/--interactive] (to erase untrackedfiles).However, be careful with those commands, as their functionis to erase things/changes.

However, be careful not to add thedist/ files in your commit, asGrunt automatically regenerates the files indist/ as the source ischanged.

Please ensure all the tests pass:

npmtest# defaults to ChromHeadlessBROWSERS=Firefox npmtestBROWSERS=Firefox,Chrome npmtestBROWSERS=Firefox,Chrome,Safari npmtest

To run Selectize locally:

npm start

You can then run the examples athttps://loopback.website:4000/.

Copyright © 2013–2016Brian Reavis &Contributors
Copyright © 2020-2022 Selectize Team &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.