Switchery - iOS 7 style switches for your checkboxes

Examples

Checked

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:

Multiple switches

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:

Multiple calls

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()) { ... }

Disabled

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:

Colored

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:

Sizes

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:

Checking state

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:

« click

Legacy browsers

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.

Development

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.