Switchery is a simple component that helps you turn your default HTML checkbox inputs into beautiful iOS 7 style switches in just few simple steps. You can easily customize switches, so that they match your design perfectly.
Licensed under the MIT License.
Supported by all modern browsers: Chrome, Firefox, Opera, Safari, IE8+
If you like this module and you're a fan of iOS 7 style UI widgets, check out Powerange.
Fork the GitHub repo
<link rel="stylesheet" href="dist/switchery.css" />
<script src="dist/switchery.js"></script>
$ component install abpetkov/switchery
$ bower install switchery
To use Switchery in your rails app, add this to your Gemfile:
gem 'switchery-rails'
Or go to Switchery Rails gem page for more info, documentation and instructions.
For thorough installation and usage instructions on how to use Switchery with Angular JS, check out this repo: servergrove/NgSwitchery
You can install Switchery to your Meteor.js app via:
$ meteor add abpetkov:switchery
Switchery on Atmosphere
var elem = document.querySelector('.js-switch');
var init = new Switchery(elem);
Use the above for the standalone version.
defaults = {
color : '#64bd63'
, secondaryColor : '#dfdfdf'
, jackColor : '#fff'
, jackSecondaryColor: null
, className : 'switchery'
, disabled : false
, disabledOpacity : 0.5
, speed : '0.1s'
, size : 'default'
}
color of the switch element (HEX or RGB value)
secondary color for the background color and border, when the switch is off
default color of the jack/handle element
color of unchecked jack/handle element
class name for the switch element (by default styled in switchery.css)
enable or disable click events and changing the state of the switch (boolean value)
opacity of the switch when disabled is true (0 to 1)
length of time that the transition will take, ex. '0.4s', '1s', '2.2s' (Note: transition speed of the handle is twice shorter)
size of the switch element (small or large)
Only thing you need is to add a checked attribute to your checkbox input. Simple as that.
<input type="checkbox" class="js-switch" checked />
Result:
You can add as many switches as you like, as long as their corresponding checkboxes have the same class. Select them and make new instance of the Switchery class for every of them.
var elems = Array.prototype.slice.call(document.querySelectorAll('.js-switch'));
elems.forEach(function(html) {
var switchery = new Switchery(html);
});
Result:
You can filter out existing elements that have already been called by looking for data-switchery="true". The following code will return if there's an element with this data attribute already.
var init = new Switchery('.js-switch');
if (init.markedAsSwitched()) { ... }
Use the disabled option to make your switch active or inactive. Native approaches like adding a readonly or disabled attributes to the checkbox are respected and will end in having a disabled switch by default.
var switchery = new Switchery(elem, { disabled: true });
Result:
Customize the default opacity of the disabled switch like so:
var switchery = new Switchery(elem, { disabled: true, disabledOpacity: 0.75 });
Result:
You can also dynamically change the active/inactive state of your switches.
var elem = document.querySelector('.js-dynamic-state');
var switchery = new Switchery(elem);
document.querySelector('.js-dynamic-disable').addEventListener('click', function() {
switchery.disable();
});
document.querySelector('.js-dynamic-enable').addEventListener('click', function() {
switchery.enable();
});
Result:
You can change the primary(on) and secondary(off) color of the switch to fit your design perfectly. Accomplish this, changing the color and secondaryColor options. The jack colors are also customizable via the jackColor and the jackSecondaryColor options. Below is a good example of what you can accomplish using those.
var switchery = new Switchery(elem, { color: '#7c8bc7', jackColor: '#9decff' });
Result:
or:
var switchery = new Switchery(elem, { color: '#faab43', secondaryColor: '#fC73d0', jackColor: '#fcf45e', jackSecondaryColor: '#c8ff77' });
Result:
Since version 0.7.0 you can change the sizes of the switch element via size. Giving it a value of small or large will result in adding switchery-small or switchery-large classes respectively, which will change the switch size.
Not using this property will render the default sized switch element.
var switchery = new Switchery(elem, { size: 'small' });
Result:
var switchery = new Switchery(elem, { size: 'large' });
Result:
In many cases, you'll need to have the current state of the checkbox, checked or not. I'll demostrate how to do this in the two most common situations - getting the state on click and on change.
On click:
var clickCheckbox = document.querySelector('.js-check-click')
, clickButton = document.querySelector('.js-check-click-button');
clickButton.addEventListener('click', function() {
alert(clickCheckbox.checked);
});
Result:
On change:
var changeCheckbox = document.querySelector('.js-check-change')
, changeField = document.querySelector('.js-check-change-field');
changeCheckbox.onchange = function() {
changeField.innerHTML = changeCheckbox.checked;
};
Result:
If you are an adventurer and like to support legacy browsers, like IE8 and IE7, apply your favourite fix for rounded corners and box shadows and try a slightly different approach.
var elems = document.querySelectorAll('.js-switch');
for (var i = 0; i < elems.length; i++) {
var switchery = new Switchery(elems[i]);
}
Personally I recommend using CSS3 PIE. It's used on all switches on this demo page.
If you've decided to go in development mode and tweak all of this a bit, there are few things you should do.
After you clone the repository, do this in your terminal (NPM required):
$ npm install
Add the following code before the rest:
var Switchery = require('switchery');
Make sure you're using the build/build.js and build/build.css files and you're ready.
There are some useful commands you can use.
$ make install
Will install Node.js modules, components etc.
$ make build
Will create a build file.
$ make standalone
Will create a standalone and minified files.