selectize.js
A maintained fork of Selectize from CodeReviveHQ.
## Maintained by CodeReviveHQ
This fork keeps Selectize available as `@coderevivehq/selectize`.
Security patches are our highest priority. We also review bug reports, feature requests, and suggestions from the community.
Selectize is an extensible [jQuery](https://jquery.com/) custom select control. It supports tagging, autocomplete, contact lists, country selectors, and other rich input experiences.
The project is based on the original [Selectize](https://github.com/selectize/selectize.js) repository. We are grateful to its authors and contributors.
## Quick links
- [Install from npm](https://www.npmjs.com/package/@coderevivehq/selectize)
- [Browse files on jsDelivr](https://cdn.jsdelivr.net/npm/@coderevivehq/selectize@latest/)
- [Releases and changelog](https://github.com/coderevivehq/selectize.js/releases)
- [Report a bug or request a feature](https://github.com/coderevivehq/selectize.js/issues)
- [Documentation](https://selectize.dev/docs/api)
- [Demos](https://selectize.dev/docs/demos)
## Installation
```sh
npm install @coderevivehq/selectize
```
## CDN
jsDelivr serves the latest files published in the CodeReviveHQ npm package. These links update automatically when a new version is published.
```html
```
For reproducible production builds, replace `latest` with a specific release number.
## Features
- **Smart Option Searching / Ranking**
Options are efficiently scored and sorted on-the-fly (using [sifter](https://github.com/brianreavis/sifter.js)). 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](docs/plugins.md) for developing custom features (uses [microplugin](https://github.com/brianreavis/microplugin.js)).
- **Touch Support**
Plays nice with iOS 5+ devices.
## Dependencies
- [jquery](https://github.com/jquery/jquery) (1.7 and greater), as [peer dependency](https://nodejs.org/en/blog/npm/peer-dependencies/)
- **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](https://github.com/jquery/jquery-ui) (required by `drag_drop` plugin)
## Manual installation
All pre-built files needed to use Selectize can be found in the
["dist"](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`.
- [**js/**](dist/js)
- [selectize.js](dist/js/selectize.js): With dependencies, except jQuery
- [selectize.min.js](dist/js/selectize.min.js): With dependencies, except jQuery
- [**scss/**](dist/scss): Sass source files for customization
- [**less/**](dist/less): Less source files for customization
- [**css/**](dist/css)
- [selectize.css](dist/css/selectize.css): Core styles
- [selectize.default.css](dist/css/selectize.default.css): Default theme with core styles
- [selectize.bootstrap2.css](dist/css/selectize.bootstrap2.css) - Bootstrap 2 theme
- [selectize.bootstrap3.css](dist/css/selectize.bootstrap3.css) - Bootstrap 3 theme
- [selectize.bootstrap4.css](dist/css/selectize.bootstrap4.css) - Bootstrap 4 theme
- [selectize.bootstrap5.css](dist/css/selectize.bootstrap5.css) - Bootstrap 5 theme
## Usage
```js
$("select").selectize(options);
```
The available options are [documented here](https://selectize.dev/docs/api).
## Contributing
Contributions are welcome. Every change is reviewed through a pull request.
1. Open an issue before starting a large change.
2. Keep each pull request focused on one fix or feature.
3. Add tests for behavior changes.
4. Update the documentation when behavior changes.
5. Add a changelog entry for user-facing changes.
### Tests
Please ensure all the tests pass:
```sh
npm test # defaults to ChromeHeadless
BROWSERS=Firefox npm test
BROWSERS=Firefox,Chrome npm test
BROWSERS=Firefox,Chrome,Safari npm test
```
### Local development
To run Selectize locally:
```sh
npm start
```
You can then run the examples at `https://loopback.website:4000/`.
## License
Copyright © 2013–2016 [Brian Reavis](http://twitter.com/brianreavis) & [Contributors](https://github.com/selectize/selectize.js/graphs/contributors)\
Copyright © 2020-2022 Selectize Team & [Contributors](https://github.com/selectize/selectize.js/graphs/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:
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.