Generate docs, remove old one

Bttstrp · Feb 5, 2017 · 5dae7bc · 5dae7bc
1 parent e61e9b6
commit 5dae7bc
Show file tree

Hide file tree

Showing 22 changed files with 256 additions and 1,262 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## 3.3.3
+
+- Deprecate CoffeeScript in favour of ES6+ with Babel
+- Updated and restored documentation
+
 ## 3.3.2
 
 - Fix for Flicker on initialisation [#425](https://github.com/nostalgiaz/bootstrap-switch/issues/425), [#422](https://github.com/nostalgiaz/bootstrap-switch/issues/422)
@@ -9,7 +14,7 @@
 
 - Revert of switchChange event triggered only on falsy skip [#411](https://github.com/nostalgiaz/bootstrap-switch/issues/411)
 
-## 3.3.0 
+## 3.3.0
 
 - Fixed setting of correct state on drag from indeterminate state [#403](https://github.com/nostalgiaz/bootstrap-switch/issues/403)
 - Fixed broken state changing on hidden switch [#392, [#383](https://github.com/nostalgiaz/bootstrap-switch/issues/383)

diff --git a/bower.json b/bower.json
@@ -1,7 +1,7 @@
 {
   "name": "bootstrap-switch",
   "description": "Turn checkboxes and radio buttons into toggle switches.",
-  "version": "3.3.2",
+  "version": "3.3.3",
   "license": "Apache-2.0",
   "main": [
     "./dist/js/bootstrap-switch.js",

diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
   "name": "components/bootstrap-switch",
   "description": "Turn checkboxes and radio buttons into toggle switches.",
-  "version": "3.3.2",
+  "version": "3.3.3",
   "type": "component",
   "keywords": [
     "bootstrap",

diff --git a/docs/404.html b/docs/404.html
@@ -0,0 +1 @@
+<!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 into toggle switches."><meta name="author" content="Mattia Larentis, Emanuele Marchi and Peter Stein"><title>Bootstrap Switch · Turn checkboxes and radio buttons into toggle switches</title><link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet"><link href="css/highlight.css" rel="stylesheet"><link href="https://unpkg.com/bootstrap-switch/dist/css/bootstrap3/bootstrap-switch.css" rel="stylesheet"><link href="http://getbootstrap.com/assets/css/docs.min.css" rel="stylesheet"><link href="css/main.css" rel="stylesheet"></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"><h1>404</h1><h3>Whoops. Looks like what you're looking for can't be found.</h3></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="https://code.jquery.com/jquery-3.1.1.min.js"></script><script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script><script src="js/highlight.js"></script><script src="https://unpkg.com/bootstrap-switch"></script><script src="js/main.js"></script></body></html>
diff --git a/docs/css/highlight.css b/docs/css/highlight.css
@@ -0,0 +1,153 @@
+/*
+
+Original style from softwaremaniacs.org (c) Ivan Sagalaev <[email protected]>
+
+*/
+
+.hljs {
+  display: block; padding: 0.5em;
+  background: #F0F0F0;
+}
+
+.hljs,
+.hljs-subst,
+.hljs-tag .hljs-title,
+.lisp .hljs-title,
+.clojure .hljs-built_in,
+.nginx .hljs-title {
+  color: black;
+}
+
+.hljs-string,
+.hljs-title,
+.hljs-constant,
+.hljs-parent,
+.hljs-tag .hljs-value,
+.hljs-rules .hljs-value,
+.hljs-rules .hljs-value .hljs-number,
+.hljs-preprocessor,
+.hljs-pragma,
+.haml .hljs-symbol,
+.ruby .hljs-symbol,
+.ruby .hljs-symbol .hljs-string,
+.hljs-aggregate,
+.hljs-template_tag,
+.django .hljs-variable,
+.smalltalk .hljs-class,
+.hljs-addition,
+.hljs-flow,
+.hljs-stream,
+.bash .hljs-variable,
+.apache .hljs-tag,
+.apache .hljs-cbracket,
+.tex .hljs-command,
+.tex .hljs-special,
+.erlang_repl .hljs-function_or_atom,
+.asciidoc .hljs-header,
+.markdown .hljs-header,
+.coffeescript .hljs-attribute {
+  color: #800;
+}
+
+.smartquote,
+.hljs-comment,
+.hljs-annotation,
+.hljs-template_comment,
+.diff .hljs-header,
+.hljs-chunk,
+.asciidoc .hljs-blockquote,
+.markdown .hljs-blockquote {
+  color: #888;
+}
+
+.hljs-number,
+.hljs-date,
+.hljs-regexp,
+.hljs-literal,
+.hljs-hexcolor,
+.smalltalk .hljs-symbol,
+.smalltalk .hljs-char,
+.go .hljs-constant,
+.hljs-change,
+.lasso .hljs-variable,
+.makefile .hljs-variable,
+.asciidoc .hljs-bullet,
+.markdown .hljs-bullet,
+.asciidoc .hljs-link_url,
+.markdown .hljs-link_url {
+  color: #080;
+}
+
+.hljs-label,
+.hljs-javadoc,
+.ruby .hljs-string,
+.hljs-decorator,
+.hljs-filter .hljs-argument,
+.hljs-localvars,
+.hljs-array,
+.hljs-attr_selector,
+.hljs-important,
+.hljs-pseudo,
+.hljs-pi,
+.haml .hljs-bullet,
+.hljs-doctype,
+.hljs-deletion,
+.hljs-envvar,
+.hljs-shebang,
+.apache .hljs-sqbracket,
+.nginx .hljs-built_in,
+.tex .hljs-formula,
+.erlang_repl .hljs-reserved,
+.hljs-prompt,
+.asciidoc .hljs-link_label,
+.markdown .hljs-link_label,
+.vhdl .hljs-attribute,
+.clojure .hljs-attribute,
+.asciidoc .hljs-attribute,
+.lasso .hljs-attribute,
+.coffeescript .hljs-property,
+.hljs-phony {
+  color: #88F
+}
+
+.hljs-keyword,
+.hljs-id,
+.hljs-title,
+.hljs-built_in,
+.hljs-aggregate,
+.css .hljs-tag,
+.hljs-javadoctag,
+.hljs-phpdoc,
+.hljs-yardoctag,
+.smalltalk .hljs-class,
+.hljs-winutils,
+.bash .hljs-variable,
+.apache .hljs-tag,
+.go .hljs-typename,
+.tex .hljs-command,
+.asciidoc .hljs-strong,
+.markdown .hljs-strong,
+.hljs-request,
+.hljs-status {
+  font-weight: bold;
+}
+
+.asciidoc .hljs-emphasis,
+.markdown .hljs-emphasis {
+  font-style: italic;
+}
+
+.nginx .hljs-built_in {
+  font-weight: normal;
+}
+
+.coffeescript .javascript,
+.javascript .xml,
+.lasso .markup,
+.tex .hljs-formula,
+.xml .javascript,
+.xml .vbscript,
+.xml .css,
+.xml .hljs-cdata {
+  opacity: 0.5;
+}
diff --git a/docs/css/main.css b/docs/css/main.css
diff --git a/docs/documentation-2.html b/docs/documentation-2.html
@@ -0,0 +1,7 @@
+<!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 into toggle switches."><meta name="author" content="Mattia Larentis, Emanuele Marchi and Peter Stein"><title>Bootstrap Switch · Turn checkboxes and radio buttons into toggle switches</title><link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet"><link href="css/highlight.css" rel="stylesheet"><link href="https://unpkg.com/bootstrap-switch/dist/css/bootstrap3/bootstrap-switch.css" rel="stylesheet"><link href="http://getbootstrap.com/assets/css/docs.min.css" rel="stylesheet"><link href="css/main.css" rel="stylesheet"></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 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 exceptions 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 is <code>switch-change</code>. It returns two parameters: <code>event</code> and
+<code>data</code>.<br>
+The latter is an object that includes <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="https://code.jquery.com/jquery-3.1.1.min.js"></script><script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script><script src="js/highlight.js"></script><script src="https://unpkg.com/bootstrap-switch"></script><script src="js/main.js"></script></body></html>