hugh
/
bootstrap-switch


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254
							<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="description" content="Turn checkboxes and radio buttons in toggle switches.">
    <meta name="author" content="Mattia Larentis, Emanuele Marchi and Peter Stein">
    <title>Bootstrap Switch · Turn checkboxes and radio buttons in toggle switches</title>
    <link href="http://fonts.googleapis.com/css?family=Roboto:400,700" rel="stylesheet">
    <link href="docs/css/bootstrap.min.css" rel="stylesheet">
    <link href="docs/css/highlight.css" rel="stylesheet">
    <link href="dist/css/bootstrap3/bootstrap-switch.css" rel="stylesheet">
    <link href="docs/css/main.css" rel="stylesheet">
    <script>
      var _gaq = _gaq || [];
      _gaq.push(['_setAccount', 'UA-43092768-1']);
      _gaq.push(['_trackPageview']);
      (function () {
        var ga = document.createElement('script');
        ga.type = 'text/javascript';
        ga.async = true;
        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
        var s = document.getElementsByTagName('script')[0];
        s.parentNode.insertBefore(ga, s);
      })();
    </script>
  </head>
  <body><a href="https://github.com/nostalgiaz/bootstrap-switch" id="github"><img src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png" alt="Fork me on GitHub"></a>
    <header role="banner" class="navbar navbar-default navbar-fixed-top top">
      <div class="container">
        <div class="navbar-header">
          <button type="button" data-toggle="collapse" data-target="#collapse" class="navbar-toggle"><span class="sr-only">Toggle navigation</span><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></button><a href="../" class="navbar-brand">Bootstrap Switch <strong>3</strong></a>
        </div>
        <nav id="collapse" role="navigation" class="collapse navbar-collapse">
          <ul class="nav navbar-nav">
            <li class="dropdown"><a href="#" data-toggle="dropdown">Download<span class="caret"></span></a>
              <ul class="dropdown-menu">
                <li><a href="https://github.com/nostalgiaz/bootstrap-switch/archive/master.zip">3 (Stable)</a></li>
                <li><a href="https://github.com/nostalgiaz/bootstrap-switch/archive/v2.0.1.zip">2.0.1 (Legacy)</a></li>
              </ul>
            </li>
            <li><a href="index.html">Start</a></li>
            <li><a href="examples.html">Examples</a></li>
            <li class="dropdown"><a href="#" data-toggle="dropdown">Documentation<span class="caret"></span></a>
              <ul class="dropdown-menu">
                <li class="dropdown-header">Version 3 (Stable)</li>
                <li><a href="/options-3.html">Options</a></li>
                <li><a href="/methods-3.html">Methods</a></li>
                <li><a href="/events-3.html">Events</a></li>
                <li class="divider"></li>
                <li class="dropdown-header">Version 2.0.1 (Legacy)</li>
                <li><a href="/documentation-2.html">Documentation</a></li>
              </ul>
            </li>
            <li><a href="https://github.com/nostalgiaz/bootstrap-switch/issues">Bug reports</a></li>
          </ul>
        </nav>
      </div>
    </header>
    <div class="container content">
      <h1 class="page-header">Options &nbsp;<small>Version 3 (Stable)</small></h1>
      <table class="table table-bordered table-striped table-responsive">
        <thead>
          <tr>
            <th>Name</th>
            <th>Attribute</th>
            <th>Type</th>
            <th>Description</th>
            <th>Values</th>
            <th>Default</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <td>state</td>
            <td>checked</td>
            <td>Boolean</td>
            <td>The checkbox state</td>
            <td>true, false</td>
            <td>true</td>
          </tr>
          <tr>
            <td>size</td>
            <td>data-size</td>
            <td>String</td>
            <td>The checkbox state</td>
            <td>null, 'mini', 'small', 'normal', 'large'</td>
            <td>null</td>
          </tr>
          <tr>
            <td>animate</td>
            <td>data-animate</td>
            <td>Boolean</td>
            <td>Animate the switch</td>
            <td>true, false</td>
            <td>true</td>
          </tr>
          <tr>
            <td>disabled</td>
            <td>disabled</td>
            <td>Boolean</td>
            <td>Disable state</td>
            <td>true, false</td>
            <td>false</td>
          </tr>
          <tr>
            <td>readonly</td>
            <td>readonly</td>
            <td>Boolean</td>
            <td>Readonly state</td>
            <td>true, false</td>
            <td>false</td>
          </tr>
          <tr>
            <td>indeterminate</td>
            <td>data-indeterminate</td>
            <td>Boolean</td>
            <td>Indeterminate state</td>
            <td>true, false</td>
            <td>false</td>
          </tr>
          <tr>
            <td>inverse</td>
            <td>data-inverse</td>
            <td>Boolean</td>
            <td>Inverse switch direction</td>
            <td>true, false</td>
            <td>false</td>
          </tr>
          <tr>
            <td>radioAllOff</td>
            <td>data-radio-all-off</td>
            <td>Boolean</td>
            <td>Allow this radio button to be unchecked by the user</td>
            <td>true, false</td>
            <td>false</td>
          </tr>
          <tr>
            <td>onColor</td>
            <td>data-on-color</td>
            <td>String</td>
            <td>Color of the left side of the switch</td>
            <td>'primary', 'info', 'success', 'warning', 'danger', 'default'</td>
            <td>'primary'</td>
          </tr>
          <tr>
            <td>offColor</td>
            <td>data-off-color</td>
            <td>String</td>
            <td>Color of the right side of the switch</td>
            <td>'primary', 'info', 'success', 'warning', 'danger', 'default'</td>
            <td>'default'</td>
          </tr>
          <tr>
            <td>onText</td>
            <td>data-on-text</td>
            <td>String</td>
            <td>Text of the left side of the switch</td>
            <td>String</td>
            <td>'ON'</td>
          </tr>
          <tr>
            <td>offText</td>
            <td>data-off-text</td>
            <td>String</td>
            <td>Text of the right side of the switch</td>
            <td>String</td>
            <td>'OFF'</td>
          </tr>
          <tr>
            <td>labelText</td>
            <td>data-label-text</td>
            <td>String</td>
            <td>Text of the center handle of the switch</td>
            <td>String</td>
            <td>'&amp;nbsp;'</td>
          </tr>
          <tr>
            <td>handleWidth</td>
            <td>data-handle-width</td>
            <td>String | Number</td>
            <td>Width of the left and right sides in pixels</td>
            <td>'auto' or Number</td>
            <td>'auto'</td>
          </tr>
          <tr>
            <td>labelWidth</td>
            <td>data-label-width</td>
            <td>String | Number</td>
            <td>Width of the center handle in pixels</td>
            <td>'auto' or Number</td>
            <td>'auto'</td>
          </tr>
          <tr>
            <td>baseClass</td>
            <td>data-base-class</td>
            <td>String</td>
            <td>Global class prefix</td>
            <td>String</td>
            <td>'bootstrap-switch'</td>
          </tr>
          <tr>
            <td>wrapperClass</td>
            <td>data-wrapper-class</td>
            <td>String | Array</td>
            <td>Container element class(es)</td>
            <td>String | Array</td>
            <td>'wrapper'</td>
          </tr>
          <tr>
            <td>onInit</td>
            <td></td>
            <td>Function</td>
            <td>Callback function to execute on initialization</td>
            <td>Function</td>
            <td>
              <pre><code class="javascript">function(event, state) {}</code></pre>
            </td>
          </tr>
          <tr>
            <td>onSwitchChange</td>
            <td></td>
            <td>Function</td>
            <td>Callback function to execute on switch state change</td>
            <td>Function</td>
            <td>
              <pre><code class="javascript">function(event, state) {}</code></pre>
            </td>
          </tr>
        </tbody>
      </table>
      <h2>Global Defaults Overriding</h2>
      <p>Follow the jQuery convention to override the default options of the library. For instance:</p>
      <pre><code>$.fn.bootstrapSwitch.defaults.size = 'large';
$.fn.bootstrapSwitch.defaults.onColor = 'success';</code></pre>
    </div>
    <div class="container bottom">
      <p>
        Licensed under the
        <a href="http://www.apache.org/licenses/LICENSE-2.0" target="_blank">Apache License, Version 2.0</a>
        · Created by
        <a href="https://github.com/nostalgiaz" target="_blank">Mattia Larentis</a>
        · Mantained by
        <a href="https://github.com/lostcrew" target="_blank">Emanuele Marchi</a>
      </p>
    </div>
    <script src="docs/js/jquery.min.js"></script>
    <script src="docs/js/bootstrap.min.js"></script>
    <script src="docs/js/highlight.js"></script>
    <script src="dist/js/bootstrap-switch.js"></script>
    <script src="docs/js/main.js"></script>
  </body>
</html>