selectize.js README

The project's README from github.com/selectize/selectize.js. As one markdown file: README.md.

selectize.js

Selectize.js

→ Selectize is looking for new members on the maintenance team!

Selectize is an extensible jQuery-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.

Features

Smart Option Searching / Ranking Options are efficiently scored and sorted on-the-fly (using sifter). Want to search for 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 are always welcome!
Extensible Plugin API for developing custom features (uses microplugin).
Touch Support Plays nice with iOS 5+ devices.

Dependencies

jquery (1.7 and greater), as peer 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 [email protected]).

Optional:

jquery-ui (required by drag_drop plugin)

Installation

Selectize can be installed via NPM npm install @selectize/selectize

Installing Manually

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, include selectize.min.js (bundles Sifter and Microplugin dependencies – also available un-minified for debugging, just remove the .min part) and css/selectize.default.css.

Selectize is available at cdnjs.

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

Usage

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

The available options are documented here.

Contributing

When issuing a pull request:

please do not include/commit changes in the dist/ or lib/ folders to avoid merge conflicts. A good way to include the right files is to use git gui or git add when committing to select the files you want to add to your commit.
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.

Once your commit is nice and clean, and you want to discard the other changes, you can use git checkout . (that will erase changes to tracked files) and git clean [-i/--interactive] (to erase untracked files). However, be careful with those commands, as their function is to erase things/changes.

However, be careful not to add the dist/ files in your commit, as Grunt automatically regenerates the files in dist/ as the source is changed.

Tests

Please ensure all the tests pass:

npm test # defaults to ChromHeadless
BROWSERS=Firefox npm test
BROWSERS=Firefox,Chrome npm test
BROWSERS=Firefox,Chrome,Safari npm test

Local environment

To run Selectize locally:

npm start

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

License

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

Searching Database…

13K ·GitHub

archived

What is this?

Selectize is a jQuery-based UI control that turns a plain textbox or select box into a hybrid of both, with autocomplete and native-feeling keyboard navigation. Typical uses: tagging, contact lists, country selectors.

Is it a framework or just a jQuery plugin?

A jQuery plugin: you attach it to an input or select element to upgrade it. It ships as the npm package @selectize/selectize with prebuilt JS and CSS files, and extra features come through a plugin API built on microplugin.

How do I add it to my project?

Run npm install @selectize/selectize, or go manual: include selectize.min.js and css/selectize.default.css from the dist folder — the same prebuilt files are also on cdnjs.

Do I need jQuery, and which version?

Yes — jQuery 1.7 or greater as a peer dependency. On npm 3+ you install it yourself (e.g. npm install --save [email protected]); jquery-ui is optional and only needed by the drag-drop plugin.

Is the project still maintained?

Not actively: the GitHub repo is archived, and the README says Selectize is looking for new members on the maintenance team — treat it as stable but slowly-moving rather than in active development.

What can it do that a plain select box can't?

Options are searched and ranked on the fly via Sifter (titles and descriptions both), the caret moves between selected items with the arrow keys, you can select and delete several items at once with option/ctrl, diacritics are handled out of the box, and touch input works on iOS 5+.

Can options be loaded from the server as the user types?

Yes — remote data loading is made for exactly that case: when you have thousands of options, the server provides them as the user types.

Can users add their own items, like new tags?

Yes — item creation lets users add entries on the fly, with async saving supported: the control stays locked until your save callback fires.

Will it match the look of my Bootstrap site?

Yes — there are prebuilt themes for Bootstrap 2, 3, 4 and 5, plus SCSS and Less source files if you want to customize the styles yourself.

What are similar projects?

select2, jquery-ui, bootstrap-table, mdb-ui-kit, downshift, bootstrap-datepicker, Flat-UI, react-jsonschema-form

Which topics is it in?

dropdown, jquery-plugin, input, less, autocomplete, forms, bootstrap, scss, jquery, ui-components, css, hacktoberfest

Creator: selectize
Size: 27.3 MB
Stars: 13K
Updated: CommitMar 15 Releasev0.15.2Nov 18
Age: 14y
Commits · 90 Days