Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/caseywebb/selectr
:white_check_mark: The coolest jQuery select plugin you've never seen
https://github.com/caseywebb/selectr
jquery jquery-plugin menu select select-box select-multiple
Last synced: 6 days ago
JSON representation
:white_check_mark: The coolest jQuery select plugin you've never seen
- Host: GitHub
- URL: https://github.com/caseywebb/selectr
- Owner: caseyWebb
- Created: 2014-03-26T19:29:45.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-11-30T16:37:26.000Z (almost 7 years ago)
- Last Synced: 2024-10-18T07:12:26.758Z (28 days ago)
- Topics: jquery, jquery-plugin, menu, select, select-box, select-multiple
- Language: CoffeeScript
- Homepage:
- Size: 2.11 MB
- Stars: 19
- Watchers: 5
- Forks: 11
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
__NOTE:__ This package is unmaintained, but I'll do my best to tend to any PRs that are submitted. Why? I've found it
much easier to implement the same thing natively with whichever framework/library I'm using (Knockout, Angular, etc.).
# Selectr
Selectr is a jQuery plugin that aims to accomplish a seemingly simple task: make a select box that doesn't suck.
It currently supports ctrl+click, search, color-coding, and selection limiting (multi-selects). In modern browsers (Chrome, Safari, FF, IE11), selectr ensures your source element's options and itself remain in sync. If you require this behavior (_e.g._ because you're using a data-binding framework of some sort) in legacy IE, see **Legacy Browser Caveats** below.
It is built using Bootstrap components, and is written in CoffeeScript and SCSS; if your project is not using Bootstrap, you should use selectrWithPolyfill.css -- which includes all of selectr's styles along with the relevant Bootstrap styles (scoped to avoid conflicting with existing styles, of course) -- or write your own styles.
Selectr was heavily inspired by [select2](https://github.com/ivaynberg/select2) and the label/assignee/milestone dropdowns in Github's issue tracker.
__[Click here to view demo](http://caseywebb.github.io/selectr/demo)__
## Installation
Selectr can be consumed as a CommonJS module, AMD module, or global var. It is built with webpack and uses the style loader, so you do not need to worry about including a stylesheet.
__NOTE:__ CommonJS and AMD modules still merely extend jQuery, so this __will not work__
```javascript
var selectr = require('selectr')
selectr('#my-selectr')
```
you must instead use the following
```javascript
require('selectr')
$ = require('jquery')
$.selectr('#my-selectr')
```
#### NPM / Bower
`npm install selectr`
`bower install selectr`
## Usage
To use selectr, simply fire it using jQuery
```javascript
$('select').selectr()
```
### Multi selects
To make selectr a multi select, simply use the `multiple` attribute on your select element as you would with regular HTML.
```html
```
### Color coding
Selectr supports color coding of options by setting the `data-selectr-color` attribute on the option. Any valid CSS color is supported, i.e. hex, rgba(a), hsl(a).
Ex.
```html
Foo
```
### Options and defaults
```coffeescript
title: 'Select Options'
noMatchingOptionsText: 'No options found'
placeholder: 'Search'
resetText: 'Clear All'
width: '300px'
maxListHeight: '250px'
tooltipBreakpoint: 25 # min length of option name to show tooltip on
maxSelection: Infinity
panelStyle: 'default'
alwaysShowFooter: false
```
To pass options to selectr, you may use an HTML5 data-* attribute, or an options object passed to the initialization function.
#### Using HTML5 data attributes
```html
```
__NOTE__: Attribute _must_ be valid JSON; that means quoted keys as well as values. This is to avoid using [eval()](http://stackoverflow.com/questions/86513/why-is-using-the-javascript-eval-function-a-bad-idea).
_But wait! I need quotes/apostrophes in my title!_
Easy fix. Use the ASCII code, i.e. instead of ' use `'` and instead of " use `"`.
#### Using an options object
```javascript
$('select').selectr({ title: 'Foo Bar', placeholder: 'Baz Qux', ... });
```
#### NOTE: Order of precedence
HTML5 data attributes take precedence over the options object. This allows you to pass certain parameters that should apply to most/all selectr instances, and "fill in the blanks" or override those options with the `data-selectr-opts` attribute. See demo file for an example.
### Compatiblity
Requires jQuery 1.8.3+
Tested in the following browsers:
- Chrome
- Firefox
- IE 8+*
### *Legacy Browser (IE8-10) caveats
selectr uses MutationObservers to update the list of options, which are unsupported by older browsers. Instead of hacking together a buggy solution,
I've opted to require that, in order to sync the options list in older browsers, a change event be manually fired on the source select element when the options change.