dahliacreative / selectron

An accessible jQuery custom select, styled with sass for easy customization

!!! NOT ACTIVELY MAINTAINED !!!

I am no longer maintaining this proejct, if you want to take over, feel free to drop me a msg.

Selectron

An accessible jQuery custom select, styled with sass for easy customization
http://dahliacreative.github.io/selectron/

Installation

Bower

bower install --save jquery-selectron

Usage

HTML

<select class="selectron">
  <option value="">Please select something</option>
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
</select>

JS

$('.selectron').selectron();

Search

You can enable search by passing the option when you initialize the plugin.

$('.selectron').selectron({
  search: true
});

Alternativley you can enable/disable search on inidividual instances using a data attribute:

<select class="selectron" data-selectron-search="true">
  <option value="">Please select something</option>
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
</select>

Themes

There are three default themes, light, dark and block. The light theme is applied by default, to apply the dark theme simply add the selectron--dark class to your select, and to apply the block theme simply add selectron--block.

<select class="selectron selectron--dark">
  <option value="">Please select something</option>
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
</select>

<select class="selectron selectron--block">
  <option value="">Please select something</option>
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
</select>

Icons

You can add an icon to your options by simply adding a data-icon attribute to the option.

<select class="selectron selectron--dark">
  <option value="">Please select something</option>
  <option value="1" data-icon="http://placehold.it/30x20">Option 1</option>
  <option value="2" data-icon="http://placehold.it/30x20">Option 2</option>
</select>

Classes

Any classes you add to your select or option will get copied across to selectron, this is useful for custom themes or for adding icons to options.

<select class="selectron my-class">
  <option value="">Please select something</option>
  <option value="1" class="my-class">Option 1</option>
  <option value="2" class="my-class">Option 2</option>
</select>

Customization

Selectron has been written to be easily customized using Sass variables. To overwrite the defaults simply define your variables before the inclusion of selectron.sass.

Available variables

$selectron-border-radius:           4px !default
$selectron-border-width:            1px !default
$selectron-color-background-dark:   #363636 !default
$selectron-color-background-light:  #ffffff !default
$selectron-color-brand:             #f70c36 !default

$selectron-color-font-dark:         #666666 !default
$selectron-color-font-light:        #999999 !default
$selectron-font-family:             sans-serif !default
$selectron-font-size:               13px !default
$selectron-line-height:             1.2 !default
$selectron-text-align:              left !default

$selectron-max-width:               400px !default
$selectron-min-width:               200px !default
$selectron-height:                  50px !default
$selectron-options-max-height:      200px !default

$selectron-padding:                 17px 50px 18px 18px !default
$selectron-option-padding:          13px 18px 14px !default
$selectron-optgroup-padding:        13px 18px 14px 28px !default

$selectron-arrow-border-width:      2px !default
$selectron-arrow-border-radius:     0px !default
$selectron-arrow-size:              10px !default
$selectron-block-width:             50px !default

$selectron-max-icon-size:           50px !default
$selectron-icon-margin:             0 10px 0px 0 !default

Events

Selectron triggers a change event on the select;

Methods

Selectron provides an selectron.update method which when triggered on the select will re-populate the options. It also provides a selectron.change method which when triggered on the select will update the sellectron trigger to match the value of the select

License

Copyright (c) 2016 Simon Sturgess

Licensed under the MIT license.

selectron's Issues

Accessiblity

I'm not sure you can say "An accessible jQuery custom select, styled with sass for easy customization" without the plugin including the appropriate aria attributes.

Descenders get cut off iOS safari 9

Really minor, and partially down to browser quirk, but the combination of height, padding, and line-height on the selectron trigger means that the descenders are slightly cut off on mobile Safari.
https://embed.gyazo.com/852c61f4174b0e6da20296ec506c049d.png
Maybe make the line-height a sass variable to make it easier to override?

Selectron element becomes a tab trap

When using the tab key to navigate the page, once you have tabbed to a selectron element you can't tab away.

drop down overflowing issue

when one inspect on browser & inspector boundry come near to it then when we click on it its dropdown is invisible.

Arrow key down event

Should be able to hold key down to navigate around options.

Exclude "placeholder" option when typing

If you attempt to type an option, and the placeholder option (eg. Please select...) contains what you are typing, it jumps to that. It'd be good to exclude that option so that it doesn't get in the way.

Border-width

Ability to remove borders.

StopTheLag

kthnxbye xx

Search bar no longer appears.

Great little plugin you have created.
The main reason I started using it was the ability to search from long lists. Now this functionality seems broken. I thought this was my own issue until I saw the same thing on your demo site. I tried versions 2.0.0, 2.0.5 and 2.0.6 I was not able to figure out the issue on my own at this time.

Hover state persists even when cursor leave select area

https://gyazo.com/a6e348e95ab98284615d72701c736c5f

Hover state on the dropdown options persists even when cursor leaves the dropdown element.

Prototype structure

Should use a prototype code base with public functions for each select. Allowing the ability for other functions to interact with selects, such as when another select is chosen and it changes the results in a different select.

Hidden on load

Display: none until select is initialised

Trigger button won't close options unless search box is present

Thanks for selectron, well thought out.

I noticed unless you set search: true in selectron's options, the trigger button won't close an open options list. Possibly a DOM traversal issue?

Arrow :after

Could use a single pseudo element for the arrow. Make it square, then apply border bottom & right. Then rotate -45deg. ez

Firefox Multiple Selects

Firefox allows you to have multiple selects open at once

UI Issues

Not sure what's the use of this codes:
if (this.opts.search) {
firstOption.addClass('selectron__option--is-hovered');
}
Because of this, the first option "Please select category" gets selected every time. hence I had removed these lines and now I am not getting the issue.

Keyboard up/down arrows to trigger open dropdown

Suggested enhancement: On native select it is possible to move between options using up/down arrows, currently on selectron you have to press space first to open.