iOS 7 style switches for your checkboxes

  • By Alexander Petkov
  • Last update: Sep 16, 2022
  • Comments: 15

Switchery

Description

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.

Supported by all modern browsers: Chrome, Firefox, Opera, Safari, IE8+

Preview

Live Preview

Installation

Standalone:
<link rel="stylesheet" href="dist/switchery.css" />
<script src="dist/switchery.js"></script>
Component:
$ component install abpetkov/switchery
Bower:
$ bower install switchery
Rails

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.

Angular JS

For thorough installation and usage instructions on how to use Switchery with Angular JS, check out this repo: servergrove/NgSwitchery

Meteor

You can install Switchery to your Meteor.js app via:

$ meteor add abpetkov:switchery

Switchery on Atmosphere

Usage

var elem = document.querySelector('.js-switch');
var init = new Switchery(elem);

Use the above for the standalone version.

Settings and Defaults

defaults = {
    color             : '#64bd63'
  , secondaryColor    : '#dfdfdf'
  , jackColor         : '#fff'
  , jackSecondaryColor: null
  , className         : 'switchery'
  , disabled          : false
  , disabledOpacity   : 0.5
  , speed             : '0.4s'
  , size              : 'default'
};
  • color : color of the switch element (HEX or RGB value)
  • secondaryColor : secondary color for background color and border, when the switch is off
  • jackColor : default color of the jack/handle element
  • jackSecondaryColor : color of unchecked jack/handle element
  • className : class name for the switch element (by default styled in switchery.css)
  • disabled : enable or disable click events and changing the state of the switch (boolean value)
  • disabledOpacity : opacity of the switch when it's disabled (0 to 1)
  • speed : length of time that the transition will take, ex. '0.4s', '1s', '2.2s' (Note: transition speed of the handle is twice shorter)
  • size : size of the switch element (small or large)

API

.destroy()

Unbinding all event handlers attached to the switch element to prepare the object for garbage collection.

.enable()

Enable disabled switch by re-adding event handlers and changing the opacity to 1.

.disable()

Disable switch by unbinding attached events and changing opacity to disabledOpacity value.

.isDisabled()

Check if switch is currently disabled by checking the readonly and disabled attributes on the checkbox and the disabled option set via JS. If any of those are present, the returned value is true.

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 />
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);
});

Multiple

Multiple calls

You can filter out existing elements that have already been called by looking for data-switchery="true".

Disabled

Use the disabled option to make your switch active or inactive.

var switchery = new Switchery(elem, { disabled: true });

Customize the default opacity of the disabled switch, using the disabledOpacity option.

var switchery = new Switchery(elem, { disabled: true, disabledOpacity: 0.75 });

Adding disabled or readonly attribute to the native input element will result in the switch being disabled as well.

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' });

JackColor

or

var switchery = new Switchery(elem, { color: '#faab43', secondaryColor: '#fC73d0', jackColor: '#fcf45e', jackSecondaryColor: '#c8ff77' });

JackSecondaryColor

Any other changes regarding colors you want to make, should take place in switchery.css.

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' });
// ... or
var switchery = new Switchery(elem, { size: 'large' });

SwitchSizes

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);
});

On change:

var changeCheckbox = document.querySelector('.js-check-change');

changeCheckbox.onchange = function() {
  alert(changeCheckbox.checked);
};
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. For working example you can check out the 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

Credits

Big thanks to:

Contact

If you like this component, share your appreciation by following me in Twitter, GitHub or Dribbble.

License

The MIT License (MIT)

Copyright (c) 2013-2015 Alexander Petkov

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Github

https://github.com/abpetkov/switchery

Comments(15)

  • 1

    Make a switchery enabled or disabled

    Hello, I am from Germany, so, sorry for my (possibly) bad english. I've got two switchery check-boxes and one iput-field: e-mail
    Use alternate e-mail

    At the End of the page, I've got the following JS:

    What I want is, that when "changeCheckbox4" is checked, then "changeCheckbox5" and the inputfield (#altmail) should be disabled and when "changeCheckbox4" is unchecked, "changeCheckbox5" and #altmail should be enabled. My code works for the input-field (#altmail), but not for the switchery checkbox "changeCheckbox5". BUT the state of changeCheckbox5 seems to change, because the console in Google Chrome shows me alternating "enable box" and "disable box". However, the changeCheckbox5 remains disabled...

    I don't know what to do, hope you can help me. iNetw0rker

    Edit: How to show you my code?

  • 2

    Problem with

    I tried to use switchery in a recent project and stumbled upon a problem when used with

    <li><label>
        <input type="checkbox" value="foo" class="js-switch" checked="checked" />
    labelname
    </label>
    </li>
    

    I can click the checkbox once, but not a second or third time. it seems to me that the label somehow interferes with the checkbox, if I remove the label everything works smoothly (but labels are there for a reason ;)

    Happens in Chrome and Firexox, same faulty behaviour.

    is switchery intended to work with labels? It would be cool if a click on the correspondig label would trigger a checkbox switch, too.

    Working example can be found here: http://dl.dropboxusercontent.com/u/81358/temp/switchery/index.html (first checkbox has a label, second has none).

  • 3

    Toggle a switch from active(clicked) to inactive (not clicked) with JavaScript

    Hey, can you provide an example on how to change the state from a switchery via javascript? I tried to achieve this now for the last 4 hours and i can't get it working. I tried to select the switchery, and add "checked" to it, nothing happens. Think i have to call a function, but which one exactly and how do i have to call it via jQuery?

  • 4

    Can be done with pure CSS and less code

    Here's a demo:

    http://jsfiddle.net/ProLoser/bM4C9/

    Doesn't require Javascript and should have excellent browser support. I tend to prefer declaring the colors in CSS instead of JS anyway.

  • 5

    Added missing tailing semi-colon

    Added missing tailing semi-colon - lack of which breaks JS concatenated environments (e.g. with Gulp). When Switchery is concat'ed with other JS libs like Gulp, resulting JS file is broken due to the lack of this trailing semicolon.

  • 6

    Bunched together

    Hi!

    See screen. 2014-02-10 3 43 41

    Fix in line 1215-1216: if (window.getComputedStyle) jack.style.left = parseInt(window.getComputedStyle(switcher).width) - (jack.offsetWidth?jack.offsetWidth:21) + 'px'; //ArtX modified else jack.style.left = parseInt(switcher.currentStyle['width']) - (jack.offsetWidth?jack.offsetWidth:21) + 'px';

  • 7

    Destroy Method

    Hi, great plugin :)

    What I'm missing right now is the functionality to destroy a switchery instance. Is it enough to just remove the DOM element, or does such a functionality already exists?

    Thank you!

  • 8

    Fixing issue found in IE9+ with change event dispatch

    In my app, I discovered that in IE9 the change event would not fire as expected. Basically, only a handler attached via onchange = function () { ... }; would work, all others such as those bound via addEventListener would not fire at all.

    After closer investigation, the condition used to test whether to use dispatchEvent or fireEvent was not catching IE9+ correctly. (ie: typeof Event === "object") so I've changed this conditional to hopefully be simpler and more accurate.

  • 9

    Feature request: would love to have different sized switches.

    These switches are great, but they'd be even better with a small version to fit into smaller UI areas. I will build this if I have some more time down the road, but logging for now in case anyone else wants to sooner.

  • 10

    When a checkbox is not displayed, switchery doesn't work well

    First of all, thank you for the plugin!

    I just deal with an issue which is more problem of html and js itself, when the checkbox is not displayed, switchery doesn't work well:

    record-2014-02-25--ia4v70

    The topic has been already discussed quite a lot: http://stackoverflow.com/questions/1841124/find-the-potential-width-of-a-hidden-element http://stackoverflow.com/questions/1472303/jquery-get-width-of-element-when-not-visible-display-none

    I would say to clone and show and hide element is not really an elegant solution, if there are a really lot of checkboxes on the page it might be even performance issue, etc... But what about to add a parameter in settings in js, which would be used if the real width or height cannot be read?

    I believe other users would appreciate this feature as well.

  • 11

    Change event is not fired

    When replacing a native checkbox with Switchery, the onchange event is not fired anymore (I think because the value of the hidden checkbox is changed programmatically). Just tried with Switchery 0.3.2

  • 12

    More understandable code for multiple switches in documentation page

    Hello. First of all, I owe my gratitude to this library. I'm a little confused in the Javascript side for multiple checkboxes when reading documents. I've written a more understandable code block instead. I hope it can help. ( I would also like to discuss how better the code can be.🙋‍♂️ )

    document.addEventListener("DOMContentLoaded", () => {
        startSwitcheryAtStart();
    });
    
    const startSwitcheryAtStart = () => {
        const checkboxElements = document.querySelectorAll(".js-switch");
        [...checkboxElements].map( el => {
            const switchery = new Switchery(el);
        });
    };
    
  • 13

    Switchery not rendered when loaded dinamically

    Hello,

    I'm loading different sets of switches using AJAX + PHP depending on user selection using a select field. The problem is that when first loaded, the switches are not rendered using SWITCHERY. They just stay as simple checkboxes.

    Sometimes the switches do get formatted with switchery but most of the time it doesn't.

    The switches reside inside a table body and it's passed from PHP as a single line (from to ) and each line appended to the TBODY using a for loop inside the success function of AJAX.

    Is there any way of re-dawing these switches after the loop?

    Any ideas? Thanks!

  • 14

    Please add a @NgModule annotation

    ERROR in : Unexpected value 'UiSwitchModule in /home/petnpals/public_html/admin/node_modules/angular2-ui-switch/dist/index.d.ts' imported by the module 'AppModule in /home/petnpals/public_html/admin/src/app/app.module.ts'. Please add a @NgModule annotation.

    import { UiSwitchModule } from 'angular2-ui-switch';
    
    @NgModule({
      imports: [
        BrowserModule,
        HttpModule,
        UiSwitchModule,
        ....
        AppRoutingModule,
      ],
      declarations: [
        AppComponent
      ],
      providers: [],
      bootstrap: [AppComponent]
    })
    

    In Local server work fine but in live server does not work and throws error at compile time

  • 15

    Doesn't instantiate checkboxes on datatable

    Hello,

    First of all, it is a great plugin to create switches easily.

    I am using it to convert my checkbox to switch. Problem I am facing here is, I have a list of items in the datatable all has a switch element with it to make an ajax call. length of datatable is 10.

    var switchElem = Array.prototype.slice.call(document.querySelectorAll('.toggle'));
            switchElem.forEach(function (html) {
                var switchery = new Switchery(html, { color: '#538bc0', secondaryColor: '#B2BABB' });
            });
    

    Using above code, It instantiates first 10 checkbox (first page of datatable) as a switch within datatable plus all other checkbox on the page that are visible on initial load. But it doesn't instantiate any checkbox that are not on first page of datatable. they remain as normal checkbox. So, if I navigate to second or any other page of datatable using datatable pagination, all checkbox are as default HTML checkbox.

    I tried instantiating switch on datatable pagination event, but it duplicates the existing switches as well, and it doesn't instantiate switch when I navigate to second page for the first time. I have to open second page, go back to first page and again go to second page to see them as switch. (this is potentially datatable related thing)

    Is there a way to instantiate the checkboxes that are not visible on page but are actually on the page?

    Due to business constraints, I cannot provide a code.