Skip to content

Latest commit

 

History

History
146 lines (106 loc) · 6.57 KB

README.md

File metadata and controls

146 lines (106 loc) · 6.57 KB
Raw

selectize.js

Selectize.js

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

NPM version CDNJS version
Node.js CI
Discussion & Help

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 jquery@3.5.1).

Optional:

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.

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.