hugh
/
bootstrap-switch


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320
							<!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="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="http://getbootstrap.com/assets/css/docs.min.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-static-top bs-docs-nav">
      <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</a>
        </div>
        <nav id="collapse" role="navigation" class="collapse navbar-collapse bs-navbar-collapse">
          <ul class="nav navbar-nav">
            <li><a href="https://github.com/nostalgiaz/bootstrap-switch/archive/master.zip" data-toggle="dropdown">Download</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><a href="/options.html">Options</a></li>
                <li><a href="/methods.html">Methods</a></li>
                <li><a href="/events.html">Events</a></li>
                <li role="presentation" class="divider"></li>
                <li><a href="/documentation-2.html">Documentation (v2.0.1)</a></li>
              </ul>
            </li>
            <li><a href="https://github.com/nostalgiaz/bootstrap-switch/issues">Bug reports</a></li>
          </ul>
        </nav>
      </div>
    </header>
    <main id="content" role="main">
      <div id="content" class="bs-docs-header">
        <div class="container">
          <h1>Documentation</h1>
          <p>v2.0.1</p>
        </div>
      </div>
      <div class="container">
        <div id="options">
          <h2 class="page-header">Options</h2>
          <div class="alert alert-warning">
            <p>
              All the options are accepted only using <code>data-*</code> attributes on the element.<br>
              <code>checked</code>, <code>disabled</code> and <code>readonly</code> are exception to the rule, being
              default HTML input attributes.<br>
              Therefore, there is not any way to specify the options in JavaScript during initialization.
            </p>
          </div>
          <table class="table table-bordered table-striped table-responsive">
            <thead>
              <tr>
                <th>Name</th>
                <th>Type</th>
                <th>Description</th>
                <th>Values</th>
                <th>Default</th>
              </tr>
            </thead>
            <tbody>
              <tr>
                <td>state</td>
                <td>Boolean</td>
                <td>The checkbox state</td>
                <td>true, false</td>
                <td>'checked' attribute or true</td>
              </tr>
              <tr>
                <td>size</td>
                <td>String</td>
                <td>The checkbox state</td>
                <td>'', 'mini', 'small', 'normal', 'large'</td>
                <td>''</td>
              </tr>
              <tr>
                <td>animate</td>
                <td>Boolean</td>
                <td>Animate the switch</td>
                <td>true, false</td>
                <td>true</td>
              </tr>
              <tr>
                <td>disabled</td>
                <td>Boolean</td>
                <td>Disable state</td>
                <td>true, false</td>
                <td>'disabled' attribute or false</td>
              </tr>
              <tr>
                <td>readonly</td>
                <td>Boolean</td>
                <td>Readonly state</td>
                <td>true, false</td>
                <td>'readonly' attribute or false</td>
              </tr>
              <tr>
                <td>on</td>
                <td>String</td>
                <td>Color of the left side of the switch</td>
                <td>'primary', 'info', 'success', 'warning', 'danger', 'default'</td>
                <td>null</td>
              </tr>
              <tr>
                <td>off</td>
                <td>String</td>
                <td>Color of the right side of the switch</td>
                <td>'primary', 'info', 'success', 'warning', 'danger', 'default'</td>
                <td>null</td>
              </tr>
              <tr>
                <td>on-label</td>
                <td>String</td>
                <td>Text of the left side of the switch</td>
                <td>String</td>
                <td>'ON'</td>
              </tr>
              <tr>
                <td>off-label</td>
                <td>String</td>
                <td>Text of the right side of the switch</td>
                <td>String</td>
                <td>'OFF'</td>
              </tr>
              <tr>
                <td>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>label-icon</td>
                <td>String</td>
                <td>Text of the center handle of the switch. Use to include external services icons</td>
                <td>String</td>
                <td>null</td>
              </tr>
            </tbody>
          </table>
        </div>
        <div id="methods">
          <h2 class="page-header">Methods</h2>
          <table class="table table-bordered table-striped table-responsive">
            <thead>
              <tr>
                <th>Name</th>
                <th>Description</th>
                <th>Accepted Values</th>
                <th>Returned Values</th>
              </tr>
            </thead>
            <tbody>
              <tr>
                <td>state</td>
                <td>Get checkbox state</td>
                <td></td>
                <td>true, false</td>
              </tr>
              <tr>
                <td>setState</td>
                <td>Set checkbox state</td>
                <td>(value: true, false)[, skip: true, <strong>false</strong>]</td>
                <td>jQuery Object (input element)</td>
              </tr>
              <tr>
                <td>toggleState</td>
                <td>Toggle checkbox state</td>
                <td>[skip: true, <strong>false</strong>]</td>
                <td>jQuery Object (input element)</td>
              </tr>
              <tr>
                <td>toggleRadioState</td>
                <td>Toggle radio state</td>
                <td>[skip: true, <strong>false</strong>]</td>
                <td>jQuery Object (input element)</td>
              </tr>
              <tr>
                <td>toggleRadioStateAllowUncheck</td>
                <td>Toggle radio state allowing uncheck of the radio input</td>
                <td>[uncheck: true, <strong>false</strong> | skip: true, <strong>false</strong>]</td>
                <td>jQuery Object (input element)</td>
              </tr>
              <tr>
                <td>setSizeClass</td>
                <td>Set the size of the switch</td>
                <td>'', 'mini', 'small', 'normal', 'large'</td>
                <td>jQuery Object (input element)</td>
              </tr>
              <tr>
                <td>setAnimated</td>
                <td>Animate the switch</td>
                <td>true, false</td>
                <td>jQuery Object (input element)</td>
              </tr>
              <tr>
                <td>isDisabled</td>
                <td>Get disabled state</td>
                <td></td>
                <td>true, false</td>
              </tr>
              <tr>
                <td>setDisabled</td>
                <td>Set disable state</td>
                <td>true, false</td>
                <td>jQuery Object (input element)</td>
              </tr>
              <tr>
                <td>toggleDisabled</td>
                <td>Toggle disabled state</td>
                <td></td>
                <td>jQuery Object (input element)</td>
              </tr>
              <tr>
                <td>isReadOnly</td>
                <td>Get Readonly state</td>
                <td></td>
                <td>true, false</td>
              </tr>
              <tr>
                <td>setReadOnly</td>
                <td>Set Readonly state</td>
                <td>true, false</td>
                <td>jQuery Object (input element)</td>
              </tr>
              <tr>
                <td>toggleReadOnly</td>
                <td>Toggle readonly state</td>
                <td></td>
                <td>jQuery Object (input element)</td>
              </tr>
              <tr>
                <td>setOnClass</td>
                <td>Color of the left side of the switch</td>
                <td>'primary', 'info', 'success', 'warning', 'danger', 'default'</td>
                <td>jQuery Object (input element)</td>
              </tr>
              <tr>
                <td>setOffClass</td>
                <td>Color of the right side of the switch</td>
                <td>'primary', 'info', 'success', 'warning', 'danger', 'default'</td>
                <td>jQuery Object (input element)</td>
              </tr>
              <tr>
                <td>setOnLabel</td>
                <td>Text of the left side of the switch</td>
                <td>String</td>
                <td>jQuery Object (input element)</td>
              </tr>
              <tr>
                <td>setOffLabel</td>
                <td>Text of the right side of the switch</td>
                <td>String</td>
                <td>jQuery Object (input element)</td>
              </tr>
              <tr>
                <td>setTextLabel</td>
                <td>Text of the center handle of the switch</td>
                <td>String</td>
                <td>null</td>
              </tr>
              <tr>
                <td>setTextIcon</td>
                <td>Text of the center handle of the switch. Use to include external services icons</td>
                <td>String</td>
                <td>null</td>
              </tr>
              <tr>
                <td>destroy</td>
                <td>Destroy the instance of Bootstrap Switch</td>
                <td></td>
                <td>jQuery Object (input element)</td>
              </tr>
            </tbody>
          </table>
        </div>
        <div id="events">
          <h2 class="page-header">Events</h2>
          <p>
            The only event triggered it <code>switch-change</code>. It returns two parameters: <code>event</code> and
            <code>data</code>.<br>
            The latter is an object that include <code>el</code> (the input DOM element) and <code>value</code> (the
            new input state)
          </p>
        </div>
      </div>
    </main>
    <footer class="bs-docs-footer">
      <div class="container">
        <p>Code licensed under <a href="http://www.apache.org/licenses/LICENSE-2.0" target="_blank">Apache License, Version 2.0</a><br>Created by <a href="https://github.com/nostalgiaz" target="_blank">Mattia Larentis</a><br>Mantained by <a href="https://github.com/lostcrew" target="_blank">Emanuele Marchi</a>
        </p>
      </div>
    </footer>
    <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>