diff options
Diffstat (limited to 'docs/javascript.html')
| -rw-r--r-- | docs/javascript.html | 2163 |
1 files changed, 1172 insertions, 991 deletions
diff --git a/docs/javascript.html b/docs/javascript.html index 6d06ff6d1..f6c8c428b 100644 --- a/docs/javascript.html +++ b/docs/javascript.html @@ -27,15 +27,14 @@ </head> - <body data-spy="scroll" data-target=".subnav" data-offset="50"> + <body data-spy="scroll" data-target=".bs-docs-sidebar"> - - <!-- Navbar + <!-- Navbar ================================================== --> - <div class="navbar navbar-fixed-top"> + <div class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> <div class="container"> - <button type="button"class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"> + <button type="button" class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> @@ -44,7 +43,10 @@ <div class="nav-collapse collapse"> <ul class="nav"> <li class=""> - <a href="./index.html">Overview</a> + <a href="./index.html">Home</a> + </li> + <li class=""> + <a href="./getting-started.html">Get started</a> </li> <li class=""> <a href="./scaffolding.html">Scaffolding</a> @@ -56,17 +58,10 @@ <a href="./components.html">Components</a> </li> <li class="active"> - <a href="./javascript.html">Javascript plugins</a> - </li> - <li class=""> - <a href="./less.html">Using LESS</a> + <a href="./javascript.html">Javascript</a> </li> - <li class="divider-vertical"></li> <li class=""> - <a href="./download.html">Customize</a> - </li> - <li class=""> - <a href="./examples.html">Examples</a> + <a href="./customize.html">Customize</a> </li> </ul> </div> @@ -74,118 +69,121 @@ </div> </div> - <div class="container"> +<!-- Subhead +================================================== --> +<header class="jumbotron subhead"> + <div class="container"> + <h1>JavaScript for Bootstrap</h1> + <p class="lead">Bring Bootstrap's components to life—now with 13 custom jQuery plugins. + </div> +</header> - <!-- Masthead - ================================================== --> - <header class="jumbotron subhead" id="overview"> - <h1>Javascript for Bootstrap</h1> - <p class="lead">Bring Bootstrap's components to life—now with 12 custom <a href="http://jquery.com/" target="_blank">jQuery</a> plugins. - <div class="subnav"> - <ul class="nav nav-pills"> - <li><a href="#javascript">All plugins</a></li> - <li><a href="#modals">Modal</a></li> - <li><a href="#dropdowns">Dropdown</a></li> - <li><a href="#scrollspy">Scrollspy</a></li> - <li><a href="#tabs">Tab</a></li> - <li><a href="#tooltips">Tooltip</a></li> - <li><a href="#popovers">Popover</a></li> - <li><a href="#alerts">Alert</a></li> - <li><a href="#buttons">Button</a></li> - <li><a href="#collapse">Collapse</a></li> - <li><a href="#carousel">Carousel</a></li> - <li><a href="#typeahead">Typeahead</a></li> + <div class="container"> + + <!-- Docs nav + ================================================== --> + <div class="row"> + <div class="span3 bs-docs-sidebar"> + <ul class="nav nav-list bs-docs-sidenav"> + <li><a href="#overview"><i class="icon-chevron-right"></i> Overview</a></li> + <li><a href="#transitions"><i class="icon-chevron-right"></i> Transitions</a></li> + <li><a href="#modals"><i class="icon-chevron-right"></i> Modal</a></li> + <li><a href="#dropdowns"><i class="icon-chevron-right"></i> Dropdown</a></li> + <li><a href="#scrollspy"><i class="icon-chevron-right"></i> Scrollspy</a></li> + <li><a href="#tabs"><i class="icon-chevron-right"></i> Tab</a></li> + <li><a href="#tooltips"><i class="icon-chevron-right"></i> Tooltip</a></li> + <li><a href="#popovers"><i class="icon-chevron-right"></i> Popover</a></li> + <li><a href="#alerts"><i class="icon-chevron-right"></i> Alert</a></li> + <li><a href="#buttons"><i class="icon-chevron-right"></i> Button</a></li> + <li><a href="#collapse"><i class="icon-chevron-right"></i> Collapse</a></li> + <li><a href="#carousel"><i class="icon-chevron-right"></i> Carousel</a></li> + <li><a href="#typeahead"><i class="icon-chevron-right"></i> Typeahead</a></li> + <li><a href="#affix"><i class="icon-chevron-right"></i> Affix</a></li> + </ul> + </div> + <div class="span9"> + + + <!-- Overview + ================================================== --> + <section id="overview"> + <div class="page-header"> + <h1>JavaScript in Bootstrap</h1> + </div> + + <h3>Individual or compiled</h3> + <p>If you have downloaded the latest version of Bootstrap, both <strong>bootstrap.js</strong> and <strong>bootstrap.min.js</strong> contain all of the plugins listed on this page.</p> + + <h3>Data attributes</h3> + <p>You can use all Bootstrap plugins purely through the markup API without writing a single line of JavaScript. This is Bootstrap's first class API and should be your first consideration when using a plugin.</p> + + <p>That said, in some situations it may be desirable to turn this functionality off. Therefore, we also provide the ability to disable the data attribute API by unbinding all events on the body namespaced with `'data-api'`. This looks like this: + <pre class="prettyprint linenums">$('body').off('.data-api')</pre> + + <p>Alternatively, to target a specific plugin, just include the plugins name as a namespace along with the data-api namespace like this:</p> + <pre class="prettyprint linenums">$('body').off('.alert.data-api')</pre> + + <h3>Programmatic API</h3> + <p>We also believe you should be able to use all Bootstrap plugins purely through the JavaScript API. All public APIs are single, chainable methods, and return the collection acted upon.</p> + <pre class="prettyprint linenums">$(".btn.danger").button("toggle").addClass("fat")</pre> + <p>All methods should accept an optional options object, a string which targets a particular method, or nothing (which initiates a plugin with default behavior):</p> +<pre class="prettyprint linenums"> +$("#myModal").modal() // initialized with defaults +$("#myModal").modal({ keyboard: false }) // initialized with no keyboard +$("#myModal").modal('show') // initializes and invokes show immediately</p> +</pre> + <p>Each plugin also exposes it's raw constructor on a `Constructor` property: <code>$.fn.popover.Constructor</code>. If you'd like to get a particular plugin instance, retrieve it directly from an element: <code>$('[rel=popover]').data('popover')</code>.</p> + + <h3>Events</h3> + <p>Bootstrap provides custom events for most plugin's unique actions. Generally, these come in an infinitive and past participle form - where the infinitive (ex. <code>show</code>) is triggered at the start of an event, and it's past participle form (ex. <code>shown</code>) is trigger on the completion of an action.</p> + <p>All infinitive events provide preventDefault functionality. This provides the abililty to stop the execution of an action before it starts.</p> +<pre class="prettyprint linenums"> +$('#myModal').on('show', function (e) { + if (!data) return e.preventDefault() // stops modal from being shown +}) +</pre> + </section> + + + + <!-- Transitions + ================================================== --> + <section id="transitions"> + <div class="page-header"> + <h1>Transitions <small>bootstrap-transition.js</small></h1> + </div> + <h3>About transitions</h3> + <p>For simple transition effects, include bootstrap-transition.js once alongside the other JS files. If you're using the compiled (or minified) bootstrap.js, there is no need to include this—it's already there.</p> + <h3>Use cases</h3> + <p>A few examples of the transition plugin:</p> + <ul> + <li>Sliding or fading in modals</li> + <li>Fading out tabs</li> + <li>Fading out alerts</li> + <li>Sliding carousel panes</li> </ul> - </div> - </header> + </section> - <!-- Using Javascript w/ Bootstrap - ================================================== --> - <section id="javascript"> - <div class="page-header"> - <h1>jQuery plugins <small>A dozen Bootstrap plugins to get you started</small></h1> - </div> - <div class="row"> - <div class="span3"> - <h3><a href="./javascript.html#modals">Modals</a></h3> - <p>A streamlined, but flexible, take on the traditional javascript modal plugin with only the minimum required functionality and smart defaults.</p> - </div> - <div class="span3"> - <h3><a href="./javascript.html#dropdowns">Dropdowns</a></h3> - <p>Add dropdown menus to nearly anything in Bootstrap with this simple plugin. Bootstrap features full dropdown menu support on in the navbar, tabs, and pills.</p> - </div> - <div class="span3"> - <h3><a href="./javascript.html#scrollspy">Scrollspy</a></h3> - <p>Use scrollspy to automatically update the links in your navbar to show the current active link based on scroll position.</p> - </div> - <div class="span3"> - <h3><a href="./javascript.html#tabs">Togglable tabs</a></h3> - <p>Use this plugin to make tabs and pills more useful by allowing them to toggle through tabbable panes of local content.</p> - </div> - </div> <!-- /row --> - <div class="row"> - <div class="span3"> - <h3><a href="./javascript.html#tooltips">Tooltips</a></h3> - <p>A new take on the jQuery Tipsy plugin, Tooltips don't rely on images—they use CSS3 for animations and data-attributes for local title storage.</p> - </div> - <div class="span3"> - <h3><a href="./javascript.html#popovers">Popovers</a> <small class="muted">*</small></h3> - <p>Add small overlays of content, like those on the iPad, to any element for housing secondary information.</p> - <p class="muted"><strong>*</strong> Requires <a href="#tooltips">Tooltips</a> to be included</p> - </div> - <div class="span3"> - <h3><a href="./javascript.html#alerts">Alert messages</a></h3> - <p>The alert plugin is a tiny class for adding close functionality to alerts.</p> - </div> - <div class="span3"> - <h3><a href="./javascript.html#buttons">Buttons</a></h3> - <p>Do more with buttons. Control button states or create groups of buttons for more components like toolbars.</p> - </div> - </div> <!-- /row --> - <div class="row" style="margin-bottom: 9px;"> - <div class="span3"> - <h3><a href="./javascript.html#collapse">Collapse</a></h3> - <p>Get base styles and flexible support for collapsible components like accordions and navigation.</p> - </div> - <div class="span3"> - <h3><a href="./javascript.html#carousel">Carousel</a></h3> - <p>Create a merry-go-round of any content you wish to provide an interactive slideshow of content.</p> - </div> - <div class="span3"> - <h3><a href="./javascript.html#typeahead">Typeahead</a></h3> - <p>A basic, easily extended plugin for quickly creating elegant typeaheads with any form text input.</p> - </div> - <div class="span3"> - <h3>Transitions <small class="muted">*</small></h3> - <p>For simple transition effects, include bootstrap-transition.js once to slide in modals or fade out alerts.</p> - <p class="muted"><strong>*</strong> Required for animation in plugins</p> - </div> - </div> <!-- /row --> - <div class="alert alert-info"><strong>Heads up!</strong> All javascript plugins require the latest version of jQuery.</div> - </section> + <!-- Modal + ================================================== --> + <section id="modals"> + <div class="page-header"> + <h1>Modals <small>bootstrap-modal.js</small></h1> + </div> - <!-- Modal - ================================================== --> - <section id="modals"> - <div class="page-header"> - <h1>Modals <small>bootstrap-modal.js</small></h1> - </div> - <div class="row"> - <div class="span3 columns"> - <h3>About modals</h3> - <p>A streamlined, but flexible, take on the traditional javascript modal plugin with only the minimum required functionality and smart defaults.</p> - <a href="assets/js/bootstrap-modal.js" target="_blank" class="btn">Download file</a> - </div> - <div class="span9 columns"> - <h2>Static example</h2> - <p>Below is a statically rendered modal.</p> - <div class="well modal-example" style="background-color: #888; border: none;"> - <div class="modal" style="position: relative; top: auto; left: auto; margin: 0 auto; z-index: 1; max-width: 100%;"> + + <h2>Examples</h2> + <p>Modals are streamlined, but flexible, dialog prompts with the minimum required functionality and smart defaults.</p> + + <h3>Static example</h3> + <p>A rendered modal with header, body, and set of actions in the footer.</p> + <div class="bs-docs-example" style="background-color: #f5f5f5;"> + <div class="modal" style="position: relative; top: auto; left: auto; margin: 0 auto 20px; z-index: 1; max-width: 100%;"> <div class="modal-header"> - <button type="button" class="close" data-dismiss="modal">×</button> + <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> <h3>Modal header</h3> </div> <div class="modal-body"> @@ -196,22 +194,37 @@ <a href="#" class="btn btn-primary">Save changes</a> </div> </div> - </div> <!-- /well --> + </div> +<pre class="prettyprint linenums"> +<div class="modal hide fade"> + <div class="modal-header"> + <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button> + <h3>Modal header</h3> + </div> + <div class="modal-body"> + <p>One fine body…</p> + </div> + <div class="modal-footer"> + <a href="#" class="btn">Close</a> + <a href="#" class="btn btn-primary">Save changes</a> + </div> +</div> +</pre> - <h2>Live demo</h2> - <p>Toggle a modal via javascript by clicking the button below. It will slide down and fade in from the top of the page.</p> + <h3>Live demo</h3> + <p>Toggle a modal via JavaScript by clicking the button below. It will slide down and fade in from the top of the page.</p> <!-- sample modal content --> - <div id="myModal" class="modal hide fade"> + <div id="myModal" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true"> <div class="modal-header"> - <button type="button" class="close" data-dismiss="modal">×</button> - <h3>Modal Heading</h3> + <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> + <h3 id="myModalLabel">Modal Heading</h3> </div> <div class="modal-body"> <h4>Text in a modal</h4> <p>Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem.</p> <h4>Popover in a modal</h4> - <p>This <a href="#" class="btn popover-test" title="A Title" data-content="And here's some amazing content. It's very engaging. right?">button</a> should trigger a popover on hover.</p> + <p>This <a href="#" role="button" class="btn popover-test" title="A Title" data-content="And here's some amazing content. It's very engaging. right?">button</a> should trigger a popover on hover.</p> <h4>Tooltips in a modal</h4> <p><a href="#" class="tooltip-test" title="Tooltip">This link</a> and <a href="#" class="tooltip-test" title="Tooltip">that link</a> should have tooltips on hover.</p> @@ -228,18 +241,49 @@ <p>Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.</p> </div> <div class="modal-footer"> - <a href="#" class="btn" data-dismiss="modal" >Close</a> - <a href="#" class="btn btn-primary">Save changes</a> + <button class="btn" data-dismiss="modal">Close</button> + <button class="btn btn-primary">Save changes</button> </div> </div> - <a data-toggle="modal" href="#myModal" class="btn btn-primary btn-large">Launch demo modal</a> + <div class="bs-docs-example" style="padding-bottom: 24px;"> + <a data-toggle="modal" href="#myModal" class="btn btn-primary btn-large">Launch demo modal</a> + </div> +<pre class="prettyprint linenums"> +<-- Button to trigger modal --> +<a href="#myModal" role="button" class="btn" data-toggle="modal">Launch demo modal</a> + +<-- Modal --> +<div class="modal" id="myModal" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true"> + <div class="modal-header"> + <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> + <h3 id="myModalLabel">Modal header</h3> + </div> + <div class="modal-body"> + <p>One fine body…</p> + </div> + <div class="modal-footer"> + <button class="btn" data-dismiss="modal" aria-hidden="true">Close</button> + <button class="btn btn-primary">Save changes</button> + </div> +</div> +</pre> + + + <hr class="bs-docs-separator"> - <hr> - <h2>Using bootstrap-modal</h2> - <p>Call the modal via javascript:</p> + <h2>Usage</h2> + + <h3>Via data attributes</h3> + <p>Activate a modal without writing JavaScript. Set <code>data-toggle="modal"</code> on a controller element, like a button, along with a <code>data-target="#foo"</code> or <code>href="#foo"</code> to target a specific modal to toggle.</p> + <pre class="prettyprint linenums"><button type="button" data-toggle="modal" data-target="#myModal">Launch modal</button></pre> + + <h3>Via JavaScript</h3> + <p>Call a modal with id <code>myModal</code> with a single line of JavaScript:</p> <pre class="prettyprint linenums">$('#myModal').modal(options)</pre> + <h3>Options</h3> + <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-backdrop=""</code>.</p> <table class="table table-bordered table-striped"> <thead> <tr> @@ -268,40 +312,24 @@ <td>true</td> <td>Shows the modal when initialized.</td> </tr> + <tr> + <td>remote</td> + <td>path</td> + <td>false</td> + <td><p>If a remote url is provided, content will be loaded via jQuery's <code>load</code> method and injected into the <code>.modal-body</code>. If you're using the data api, you may alternatively use the <code>href</code> tag to specify the remote source. An example of this is shown below:</p> + <pre class="prettyprint linenums"><code><a data-toggle="modal" href="remote.html" data-target="#modal">click me</a></code></pre></td> + </tr> </tbody> </table> - <h3>Markup</h3> - <p>You can activate modals on your page easily without having to write a single line of javascript. Just set <code>data-toggle="modal"</code> on a controller element with a <code>data-target="#foo"</code> or <code>href="#foo"</code> which corresponds to a modal element id, and when clicked, it will launch your modal.</p> - <p>Also, to add options to your modal instance, just include them as additional data attributes on either the control element or the modal markup itself.</p> -<pre class="prettyprint linenums"> -<a class="btn" data-toggle="modal" href="#myModal" >Launch Modal</a> -</pre> -<pre class="prettyprint linenums"> -<div class="modal hide" id="myModal"> - <div class="modal-header"> - <button type="button" class="close" data-dismiss="modal">×</button> - <h3>Modal header</h3> - </div> - <div class="modal-body"> - <p>One fine body…</p> - </div> - <div class="modal-footer"> - <a href="#" class="btn" data-dismiss="modal">Close</a> - <a href="#" class="btn btn-primary">Save changes</a> - </div> -</div> -</pre> - <div class="alert alert-info"> - <strong>Heads up!</strong> If you want your modal to animate in and out, just add a <code>.fade</code> class to the <code>.modal</code> element (refer to the demo to see this in action) and include bootstrap-transition.js. - </div> <h3>Methods</h3> <h4>.modal(options)</h4> <p>Activates your content as a modal. Accepts an optional options <code>object</code>.</p> <pre class="prettyprint linenums"> $('#myModal').modal({ keyboard: false -})</pre> +}) +</pre> <h4>.modal('toggle')</h4> <p>Manually toggles a modal.</p> <pre class="prettyprint linenums">$('#myModal').modal('toggle')</pre> @@ -339,229 +367,217 @@ $('#myModal').modal({ </tr> </tbody> </table> - <pre class="prettyprint linenums"> $('#myModal').on('hidden', function () { // do something… -})</pre> - </div> - </div> - </section> +}) +</pre> + </section> - <!-- Dropdown - ================================================== --> - <section id="dropdowns"> - <div class="page-header"> - <h1>Dropdowns <small>bootstrap-dropdown.js</small></h1> - </div> - <div class="row"> - <div class="span3 columns"> - <h3>About dropdowns</h3> - <p>Add dropdown menus to nearly anything in Bootstrap with this simple plugin. Bootstrap features full dropdown menu support on in the navbar, tabs, and pills.</p> - <a href="assets/js/bootstrap-dropdown.js" target="_blank" class="btn">Download file</a> - </div> - <div class="span9 columns"> + <!-- Dropdown + ================================================== --> + <section id="dropdowns"> + <div class="page-header"> + <h1>Dropdowns <small>bootstrap-dropdown.js</small></h1> + </div> + + <h2>Examples</h2> - <p>Click on the dropdown nav links in the navbar and pills below to test dropdowns.</p> - <div id="navbar-example" class="navbar navbar-static"> - <div class="navbar-inner"> - <div class="container" style="width: auto;"> - <a class="brand" href="#">Project Name</a> - <ul class="nav"> - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li><a href="#">Action</a></li> - <li><a href="#">Another action</a></li> - <li><a href="#">Something else here</a></li> - <li class="divider"></li> - <li><a href="#">Separated link</a></li> - </ul> - </li> - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown 2 <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li><a href="#">Action</a></li> - <li><a href="#">Another action</a></li> - <li><a href="#">Something else here</a></li> - <li class="divider"></li> - <li><a href="#">Separated link</a></li> - </ul> - </li> + <p>Add dropdown menus to nearly anything with this simple plugin, including the navbar, tabs, and pills.</p> + + <h3>Within a navbar</h3> + <div class="bs-docs-example"> + <div id="navbar-example" class="navbar navbar-static"> + <div class="navbar-inner"> + <div class="container" style="width: auto;"> + <a class="brand" href="#">Project Name</a> + <ul class="nav" role="navigation"> + <li class="dropdown"> + <a id="drop1" href="#" role="button" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a> + <ul class="dropdown-menu" role="menu" aria-labelledby="drop1"> + <li><a tabindex="-1" href="http://google.com">Action</a></li> + <li><a tabindex="-1" href="#anotherAction">Another action</a></li> + <li><a tabindex="-1" href="#">Something else here</a></li> + <li class="divider"></li> + <li><a tabindex="-1" href="#">Separated link</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" id="drop2" role="button" class="dropdown-toggle" data-toggle="dropdown">Dropdown 2 <b class="caret"></b></a> + <ul class="dropdown-menu" role="menu" aria-labelledby="drop2"> + <li><a tabindex="-1" href="#">Action</a></li> + <li><a tabindex="-1" href="#">Another action</a></li> + <li><a tabindex="-1" href="#">Something else here</a></li> + <li class="divider"></li> + <li><a tabindex="-1" href="#">Separated link</a></li> + </ul> + </li> + </ul> + <ul class="nav pull-right"> + <li id="fat-menu" class="dropdown"> + <a href="#" id="drop3" role="button" class="dropdown-toggle" data-toggle="dropdown">Dropdown 3 <b class="caret"></b></a> + <ul class="dropdown-menu" role="menu" aria-labelledby="drop3"> + <li><a tabindex="-1" href="#">Action</a></li> + <li><a tabindex="-1" href="#">Another action</a></li> + <li><a tabindex="-1" href="#">Something else here</a></li> + <li class="divider"></li> + <li><a tabindex="-1" href="#">Separated link</a></li> + </ul> + </li> + </ul> + </div> + </div> + </div> <!-- /navbar-example --> + </div> + + <h3>Within tabs</h3> + <div class="bs-docs-example"> + <ul class="nav nav-pills"> + <li class="active"><a href="#">Regular link</a></li> + <li class="dropdown"> + <a class="dropdown-toggle" id="drop4" role="button" data-toggle="dropdown" href="#">Dropdown <b class="caret"></b></a> + <ul id="menu1" class="dropdown-menu" role="menu" aria-labelledby="drop4"> + <li><a tabindex="-1" href="#">Action</a></li> + <li><a tabindex="-1" href="#">Another action</a></li> + <li><a tabindex="-1" href="#">Something else here</a></li> + <li class="divider"></li> + <li><a tabindex="-1" href="#">Separated link</a></li> </ul> - <ul class="nav pull-right"> - <li id="fat-menu" class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown 3 <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li><a href="#">Action</a></li> - <li><a href="#">Another action</a></li> - <li><a href="#">Something else here</a></li> - <li class="divider"></li> - <li><a href="#">Separated link</a></li> - </ul> - </li> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" id="drop5" role="button" data-toggle="dropdown" href="#">Dropdown 2 <b class="caret"></b></a> + <ul id="menu2" class="dropdown-menu" role="menu" aria-labelledby="drop5"> + <li><a tabindex="-1" href="#">Action</a></li> + <li><a tabindex="-1" href="#">Another action</a></li> + <li><a tabindex="-1" href="#">Something else here</a></li> + <li class="divider"></li> + <li><a tabindex="-1" href="#">Separated link</a></li> </ul> - </div> - </div> - </div> <!-- /navbar-example --> - - <ul class="nav nav-pills"> - <li class="active"><a href="#">Regular link</a></li> - <li class="dropdown"> - <a class="dropdown-toggle" data-toggle="dropdown" href="#">Dropdown <b class="caret"></b></a> - <ul id="menu1" class="dropdown-menu"> - <li><a href="#">Action</a></li> - <li><a href="#">Another action</a></li> - <li><a href="#">Something else here</a></li> - <li class="divider"></li> - <li><a href="#">Separated link</a></li> - </ul> - </li> - <li class="dropdown"> - <a class="dropdown-toggle" data-toggle="dropdown" href="#">Dropdown 2 <b class="caret"></b></a> - <ul id="menu2" class="dropdown-menu"> - <li><a href="#">Action</a></li> - <li><a href="#">Another action</a></li> - <li><a href="#">Something else here</a></li> - <li class="divider"></li> - <li><a href="#">Separated link</a></li> - </ul> - </li> - <li class="dropdown"> - <a class="dropdown-toggle" data-toggle="dropdown" href="#">Dropdown 3 <b class="caret"></b></a> - <ul id="menu3" class="dropdown-menu"> - <li><a href="#">Action</a></li> - <li><a href="#">Another action</a></li> - <li><a href="#">Something else here</a></li> - <li class="divider"></li> - <li><a href="#">Separated link</a></li> - </ul> - </li> - </ul> <!-- /tabs --> - - <hr> - - <h2>Using bootstrap-dropdown.js</h2> - <p>Call the dropdowns via javascript:</p> - <pre class="prettyprint linenums">$('.dropdown-toggle').dropdown()</pre> - <h3>Markup</h3> - <p>To quickly add dropdown functionality to any element just add <code>data-toggle="dropdown"</code> and any valid bootstrap dropdown will automatically be activated.</p> - <div class="alert alert-info"> - <strong>Heads up!</strong> You may optionally target a specific dropdown by using <code>data-target="#fat"</code> or <code>href="#fat"</code>. - </div> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" id="drop5" role="button" data-toggle="dropdown" href="#">Dropdown 3 <b class="caret"></b></a> + <ul id="menu3" class="dropdown-menu" role="menu" aria-labelledby="drop5"> + <li><a tabindex="-1" href="#">Action</a></li> + <li><a tabindex="-1" href="#">Another action</a></li> + <li><a tabindex="-1" href="#">Something else here</a></li> + <li class="divider"></li> + <li><a tabindex="-1" href="#">Separated link</a></li> + </ul> + </li> + </ul> <!-- /tabs --> + </div> + + + <hr class="bs-docs-separator"> + + <h2>Usage</h2> + + <h3>Via data attributes</h3> + <p>Add <code>data-toggle="dropdown"</code> to a link or button to toggle a dropdown.</p> <pre class="prettyprint linenums"> -<ul class="nav nav-pills"> - <li class="active"><a href="#">Regular link</a></li> - <li class="dropdown" id="menu1"> - <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> - Dropdown - <b class="caret"></b> - </a> - <ul class="dropdown-menu"> - <li><a href="#">Action</a></li> - <li><a href="#">Another action</a></li> - <li><a href="#">Something else here</a></li> - <li class="divider"></li> - <li><a href="#">Separated link</a></li> - </ul> - </li> - ... -</ul></pre> +<div class="dropdown"> + <a class="dropdown-toggle" href="#">Dropdown trigger</a> + <ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"> + ... + </ul> +</div> +</pre> <p>To keep URLs intact, use the <code>data-target</code> attribute instead of <code>href="#"</code>.</p> <pre class="prettyprint linenums"> -<ul class="nav nav-pills"> - <li class="dropdown"> - <a class="dropdown-toggle" data-toggle="dropdown" data-target="#" href="path/to/page.html"> - Dropdown - <b class="caret"></b> - </a> - <ul class="dropdown-menu"> - ... - </ul> - </li> -</ul> +<div class="dropdown"> + <a class="dropdown-toggle" id="dLabel" role="button" data-toggle="dropdown" data-target="#" href="/page.html"> + Dropdown + <b class="caret"></b> + </a> + <ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"> + ... + </ul> +</div> </pre> + + <h3>Via JavaScript</h3> + <p>Call the dropdowns via JavaScript:</p> + <pre class="prettyprint linenums">$('.dropdown-toggle').dropdown()</pre> + + <h3>Options</h3> + <p><em>None</em></p> + <h3>Methods</h3> <h4>$().dropdown()</h4> <p>A programatic api for activating menus for a given navbar or tabbed navigation.</p> - </div> - </div> - </section> + </section> - <!-- ScrollSpy - ================================================== --> - <section id="scrollspy"> - <div class="page-header"> - <h1>ScrollSpy <small>bootstrap-scrollspy.js</small></h1> - </div> - <div class="row"> - <div class="span3 columns"> - <p>The ScrollSpy plugin is for automatically updating nav targets based on scroll position.</p> - <a href="assets/js/bootstrap-scrollspy.js" target="_blank" class="btn">Download file</a> - </div> - <div class="span9 columns"> - <h2>Example navbar with scrollspy</h2> - <p>Scroll the area below and watch the navigation update. The dropdown sub items will be highlighted as well. Try it!</p> - <div id="navbarExample" class="navbar navbar-static"> - <div class="navbar-inner"> - <div class="container" style="width: auto;"> - <a class="brand" href="#">Project Name</a> - <ul class="nav"> - <li><a href="#fat">@fat</a></li> - <li><a href="#mdo">@mdo</a></li> - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li><a href="#one">one</a></li> - <li><a href="#two">two</a></li> - <li class="divider"></li> - <li><a href="#three">three</a></li> - </ul> - </li> - </ul> + <!-- ScrollSpy + ================================================== --> + <section id="scrollspy"> + <div class="page-header"> + <h1>ScrollSpy <small>bootstrap-scrollspy.js</small></h1> + </div> + + + <h2>Example in navbar</h2> + <p>The ScrollSpy plugin is for automatically updating nav targets based on scroll position. Scroll the area below the navbar and watch the active class change. The dropdown sub items will be highlighted as well.</p> + <div class="bs-docs-example"> + <div id="navbarExample" class="navbar navbar-static"> + <div class="navbar-inner"> + <div class="container" style="width: auto;"> + <a class="brand" href="#">Project Name</a> + <ul class="nav"> + <li><a href="#fat">@fat</a></li> + <li><a href="#mdo">@mdo</a></li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="#one">one</a></li> + <li><a href="#two">two</a></li> + <li class="divider"></li> + <li><a href="#three">three</a></li> + </ul> + </li> + </ul> + </div> </div> </div> + <div data-spy="scroll" data-target="#navbarExample" data-offset="0" class="scrollspy-example"> + <h4 id="fat">@fat</h4> + <p>Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.</p> + <h4 id="mdo">@mdo</h4> + <p>Veniam marfa mustache skateboard, adipisicing fugiat velit pitchfork beard. Freegan beard aliqua cupidatat mcsweeney's vero. Cupidatat four loko nisi, ea helvetica nulla carles. Tattooed cosby sweater food truck, mcsweeney's quis non freegan vinyl. Lo-fi wes anderson +1 sartorial. Carles non aesthetic exercitation quis gentrify. Brooklyn adipisicing craft beer vice keytar deserunt.</p> + <h4 id="one">one</h4> + <p>Occaecat commodo aliqua delectus. Fap craft beer deserunt skateboard ea. Lomo bicycle rights adipisicing banh mi, velit ea sunt next level locavore single-origin coffee in magna veniam. High life id vinyl, echo park consequat quis aliquip banh mi pitchfork. Vero VHS est adipisicing. Consectetur nisi DIY minim messenger bag. Cred ex in, sustainable delectus consectetur fanny pack iphone.</p> + <h4 id="two">two</h4> + <p>In incididunt echo park, officia deserunt mcsweeney's proident master cleanse thundercats sapiente veniam. Excepteur VHS elit, proident shoreditch +1 biodiesel laborum craft beer. Single-origin coffee wayfarers irure four loko, cupidatat terry richardson master cleanse. Assumenda you probably haven't heard of them art party fanny pack, tattooed nulla cardigan tempor ad. Proident wolf nesciunt sartorial keffiyeh eu banh mi sustainable. Elit wolf voluptate, lo-fi ea portland before they sold out four loko. Locavore enim nostrud mlkshk brooklyn nesciunt.</p> + <h4 id="three">three</h4> + <p>Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.</p> + <p>Keytar twee blog, culpa messenger bag marfa whatever delectus food truck. Sapiente synth id assumenda. Locavore sed helvetica cliche irony, thundercats you probably haven't heard of them consequat hoodie gluten-free lo-fi fap aliquip. Labore elit placeat before they sold out, terry richardson proident brunch nesciunt quis cosby sweater pariatur keffiyeh ut helvetica artisan. Cardigan craft beer seitan readymade velit. VHS chambray laboris tempor veniam. Anim mollit minim commodo ullamco thundercats. + </p> + </div> </div> - <div data-spy="scroll" data-target="#navbarExample" data-offset="0" class="scrollspy-example"> - <h4 id="fat">@fat</h4> - <p> - Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat. - </p> - <h4 id="mdo">@mdo</h4> - <p> - Veniam marfa mustache skateboard, adipisicing fugiat velit pitchfork beard. Freegan beard aliqua cupidatat mcsweeney's vero. Cupidatat four loko nisi, ea helvetica nulla carles. Tattooed cosby sweater food truck, mcsweeney's quis non freegan vinyl. Lo-fi wes anderson +1 sartorial. Carles non aesthetic exercitation quis gentrify. Brooklyn adipisicing craft beer vice keytar deserunt. - </p> - <h4 id="one">one</h4> - <p> - Occaecat commodo aliqua delectus. Fap craft beer deserunt skateboard ea. Lomo bicycle rights adipisicing banh mi, velit ea sunt next level locavore single-origin coffee in magna veniam. High life id vinyl, echo park consequat quis aliquip banh mi pitchfork. Vero VHS est adipisicing. Consectetur nisi DIY minim messenger bag. Cred ex in, sustainable delectus consectetur fanny pack iphone. - </p> - <h4 id="two">two</h4> - <p> - In incididunt echo park, officia deserunt mcsweeney's proident master cleanse thundercats sapiente veniam. Excepteur VHS elit, proident shoreditch +1 biodiesel laborum craft beer. Single-origin coffee wayfarers irure four loko, cupidatat terry richardson master cleanse. Assumenda you probably haven't heard of them art party fanny pack, tattooed nulla cardigan tempor ad. Proident wolf nesciunt sartorial keffiyeh eu banh mi sustainable. Elit wolf voluptate, lo-fi ea portland before they sold out four loko. Locavore enim nostrud mlkshk brooklyn nesciunt. - </p> - <h4 id="three">three</h4> - <p> - Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat. - </p> - <p>Keytar twee blog, culpa messenger bag marfa whatever delectus food truck. Sapiente synth id assumenda. Locavore sed helvetica cliche irony, thundercats you probably haven't heard of them consequat hoodie gluten-free lo-fi fap aliquip. Labore elit placeat before they sold out, terry richardson proident brunch nesciunt quis cosby sweater pariatur keffiyeh ut helvetica artisan. Cardigan craft beer seitan readymade velit. VHS chambray laboris tempor veniam. Anim mollit minim commodo ullamco thundercats. - </p> - </div> - <hr> - <h2>Using bootstrap-scrollspy.js</h2> - <p>Call the scrollspy via javascript:</p> + + + <hr class="bs-docs-separator"> + + + <h2>Usage</h2> + + <h3>Via data attributes</h3> + <p>To easily add scrollspy behavior to your topbar navigation, just add <code>data-spy="scroll"</code> to the element you want to spy on (most typically this would be the body) and <code>data-target=".navbar"</code> to select which nav to use. You'll want to use scrollspy with a <code>.nav</code> component.</p> + <pre class="prettyprint linenums"><body data-spy="scroll" data-target=".navbar">...</body></pre> + + <h3>Via JavaScript</h3> + <p>Call the scrollspy via JavaScript:</p> <pre class="prettyprint linenums">$('#navbar').scrollspy()</pre> - <h3>Markup</h3> - <p>To easily add scrollspy behavior to your topbar navigation, just add <code>data-spy="scroll"</code> to the element you want to spy on (most typically this would be the body).</p> - <pre class="prettyprint linenums"><body data-spy="scroll" >...</body></pre> + <div class="alert alert-info"> <strong>Heads up!</strong> Navbar links must have resolvable id targets. For example, a <code><a href="#home">home</a></code> must correspond to something in the dom like <code><div id="home"></div></code>. </div> + <h3>Methods</h3> <h4>.scrollspy('refresh')</h4> <p>When using scrollspy in conjunction with adding or removing of elements from the DOM, you'll need to call the refresh method like so:</p> @@ -570,7 +586,9 @@ $('[data-spy="scroll"]').each(function () { var $spy = $(this).scrollspy('refresh') }); </pre> + <h3>Options</h3> + <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-offset=""</code>.</p> <table class="table table-bordered table-striped"> <thead> <tr> @@ -589,7 +607,8 @@ $('[data-spy="scroll"]').each(function () { </tr> </tbody> </table> - <h3>Events</h3> + + <h3>Events</h3> <table class="table table-bordered table-striped"> <thead> <tr> @@ -604,55 +623,55 @@ $('[data-spy="scroll"]').each(function () { </tr> </tbody> </table> - </div> - </div> - </section> + </section> - <!-- Tabs - ================================================== --> - <section id="tabs"> - <div class="page-header"> - <h1>Togglable tabs <small>bootstrap-tab.js</small></h1> - </div> - <div class="row"> - <div class="span3 columns"> - <p>This plugin adds quick, dynamic tab and pill functionality for transitioning through local content.</p> - <a href="assets/js/bootstrap-tab.js" target="_blank" class="btn">Download file</a> - </div> - <div class="span9 columns"> + <!-- Tabs + ================================================== --> + <section id="tabs"> + <div class="page-header"> + <h1>Togglable tabs <small>bootstrap-tab.js</small></h1> + </div> + + <h2>Example tabs</h2> - <p>Click the tabs below to toggle between hidden panes, even via dropdown menus.</p> - <ul id="myTab" class="nav nav-tabs"> - <li class="active"><a href="#home" data-toggle="tab">Home</a></li> - <li><a href="#profile" data-toggle="tab">Profile</a></li> - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li><a href="#dropdown1" data-toggle="tab">@fat</a></li> - <li><a href="#dropdown2" data-toggle="tab">@mdo</a></li> - </ul> - </li> - </ul> - <div id="myTabContent" class="tab-content"> - <div class="tab-pane fade in active" id="home"> - <p>Raw denim you probably haven't heard of them jean shorts Austin. Nesciunt tofu stumptown aliqua, retro synth master cleanse. Mustache cliche tempor, williamsburg carles vegan helvetica. Reprehenderit butcher retro keffiyeh dreamcatcher synth. Cosby sweater eu banh mi, qui irure terry richardson ex squid. Aliquip placeat salvia cillum iphone. Seitan aliquip quis cardigan american apparel, butcher voluptate nisi qui.</p> - </div> - <div class="tab-pane fade" id="profile"> - <p>Food truck fixie locavore, accusamus mcsweeney's marfa nulla single-origin coffee squid. Exercitation +1 labore velit, blog sartorial PBR leggings next level wes anderson artisan four loko farm-to-table craft beer twee. Qui photo booth letterpress, commodo enim craft beer mlkshk aliquip jean shorts ullamco ad vinyl cillum PBR. Homo nostrud organic, assumenda labore aesthetic magna delectus mollit. Keytar helvetica VHS salvia yr, vero magna velit sapiente labore stumptown. Vegan fanny pack odio cillum wes anderson 8-bit, sustainable jean shorts beard ut DIY ethical culpa terry richardson biodiesel. Art party scenester stumptown, tumblr butcher vero sint qui sapiente accusamus tattooed echo park.</p> - </div> - <div class="tab-pane fade" id="dropdown1"> - <p>Etsy mixtape wayfarers, ethical wes anderson tofu before they sold out mcsweeney's organic lomo retro fanny pack lo-fi farm-to-table readymade. Messenger bag gentrify pitchfork tattooed craft beer, iphone skateboard locavore carles etsy salvia banksy hoodie helvetica. DIY synth PBR banksy irony. Leggings gentrify squid 8-bit cred pitchfork. Williamsburg banh mi whatever gluten-free, carles pitchfork biodiesel fixie etsy retro mlkshk vice blog. Scenester cred you probably haven't heard of them, vinyl craft beer blog stumptown. Pitchfork sustainable tofu synth chambray yr.</p> - </div> - <div class="tab-pane fade" id="dropdown2"> - <p>Trust fund seitan letterpress, keytar raw denim keffiyeh etsy art party before they sold out master cleanse gluten-free squid scenester freegan cosby sweater. Fanny pack portland seitan DIY, art party locavore wolf cliche high life echo park Austin. Cred vinyl keffiyeh DIY salvia PBR, banh mi before they sold out farm-to-table VHS viral locavore cosby sweater. Lomo wolf viral, mustache readymade thundercats keffiyeh craft beer marfa ethical. Wolf salvia freegan, sartorial keffiyeh echo park vegan.</p> + <p>Add quick, dynamic tab functionality to transiton through panes of local content, even via dropdown menus.</p> + <div class="bs-docs-example"> + <ul id="myTab" class="nav nav-tabs"> + <li class="active"><a href="#home" data-toggle="tab">Home</a></li> + <li><a href="#profile" data-toggle="tab">Profile</a></li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="#dropdown1" data-toggle="tab">@fat</a></li> + <li><a href="#dropdown2" data-toggle="tab">@mdo</a></li> + </ul> + </li> + </ul> + <div id="myTabContent" class="tab-content"> + <div class="tab-pane fade in active" id="home"> + <p>Raw denim you probably haven't heard of them jean shorts Austin. Nesciunt tofu stumptown aliqua, retro synth master cleanse. Mustache cliche tempor, williamsburg carles vegan helvetica. Reprehenderit butcher retro keffiyeh dreamcatcher synth. Cosby sweater eu banh mi, qui irure terry richardson ex squid. Aliquip placeat salvia cillum iphone. Seitan aliquip quis cardigan american apparel, butcher voluptate nisi qui.</p> + </div> + <div class="tab-pane fade" id="profile"> + <p>Food truck fixie locavore, accusamus mcsweeney's marfa nulla single-origin coffee squid. Exercitation +1 labore velit, blog sartorial PBR leggings next level wes anderson artisan four loko farm-to-table craft beer twee. Qui photo booth letterpress, commodo enim craft beer mlkshk aliquip jean shorts ullamco ad vinyl cillum PBR. Homo nostrud organic, assumenda labore aesthetic magna delectus mollit. Keytar helvetica VHS salvia yr, vero magna velit sapiente labore stumptown. Vegan fanny pack odio cillum wes anderson 8-bit, sustainable jean shorts beard ut DIY ethical culpa terry richardson biodiesel. Art party scenester stumptown, tumblr butcher vero sint qui sapiente accusamus tattooed echo park.</p> + </div> + <div class="tab-pane fade" id="dropdown1"> + <p>Etsy mixtape wayfarers, ethical wes anderson tofu before they sold out mcsweeney's organic lomo retro fanny pack lo-fi farm-to-table readymade. Messenger bag gentrify pitchfork tattooed craft beer, iphone skateboard locavore carles etsy salvia banksy hoodie helvetica. DIY synth PBR banksy irony. Leggings gentrify squid 8-bit cred pitchfork. Williamsburg banh mi whatever gluten-free, carles pitchfork biodiesel fixie etsy retro mlkshk vice blog. Scenester cred you probably haven't heard of them, vinyl craft beer blog stumptown. Pitchfork sustainable tofu synth chambray yr.</p> + </div> + <div class="tab-pane fade" id="dropdown2"> + <p>Trust fund seitan letterpress, keytar raw denim keffiyeh etsy art party before they sold out master cleanse gluten-free squid scenester freegan cosby sweater. Fanny pack portland seitan DIY, art party locavore wolf cliche high life echo park Austin. Cred vinyl keffiyeh DIY salvia PBR, banh mi before they sold out farm-to-table VHS viral locavore cosby sweater. Lomo wolf viral, mustache readymade thundercats keffiyeh craft beer marfa ethical. Wolf salvia freegan, sartorial keffiyeh echo park vegan.</p> + </div> </div> </div> - <hr> - <h2>Using bootstrap-tab.js</h2> - <p>Enable tabbable tabs via javascript (each tab needs to be activated individually):</p> - <pre class="prettyprint linenums"> + + + <hr class="bs-docs-separator"> + + + <h2>Usage</h2> + <p>Enable tabbable tabs via JavaScript (each tab needs to be activated individually):</p> +<pre class="prettyprint linenums"> $('#myTab a').click(function (e) { e.preventDefault(); $(this).tab('show'); @@ -664,8 +683,9 @@ $('#myTab a:first').tab('show'); // Select first tab $('#myTab a:last').tab('show'); // Select last tab $('#myTab li:eq(2) a').tab('show'); // Select third tab (0-indexed) </pre> + <h3>Markup</h3> - <p>You can activate a tab or pill navigation without writing any javascript by simply specifying <code>data-toggle="tab"</code> or <code>data-toggle="pill"</code> on an element. Adding the <code>nav</code> and <code>nav-tabs</code> classes to the tab <code>ul</code> will apply the bootstrap tab styling.</p> + <p>You can activate a tab or pill navigation without writing any JavaScript by simply specifying <code>data-toggle="tab"</code> or <code>data-toggle="pill"</code> on an element. Adding the <code>nav</code> and <code>nav-tabs</code> classes to the tab <code>ul</code> will apply the Bootstrap tab styling.</p> <pre class="prettyprint linenums"> <ul class="nav nav-tabs"> <li><a href="#home" data-toggle="tab">Home</a></li> @@ -673,6 +693,7 @@ $('#myTab li:eq(2) a').tab('show'); // Select third tab (0-indexed) <li><a href="#messages" data-toggle="tab">Messages</a></li> <li><a href="#settings" data-toggle="tab">Settings</a></li> </ul></pre> + <h3>Methods</h3> <h4>$().tab</h4> <p> @@ -697,7 +718,9 @@ $('#myTab li:eq(2) a').tab('show'); // Select third tab (0-indexed) $(function () { $('#myTab a:last').tab('show'); }) -</script></pre> +</script> +</pre> + <h3>Events</h3> <table class="table table-bordered table-striped"> <thead> @@ -717,41 +740,51 @@ $('#myTab li:eq(2) a').tab('show'); // Select third tab (0-indexed) </tr> </tbody> </table> - - <pre class="prettyprint linenums"> +<pre class="prettyprint linenums"> $('a[data-toggle="tab"]').on('shown', function (e) { e.target // activated tab e.relatedTarget // previous tab -})</pre> - </div> - </div> - </section> +}) +</pre> + </section> - <!-- Tooltips - ================================================== --> - <section id="tooltips"> - <div class="page-header"> - <h1>Tooltips <small>bootstrap-tooltip.js</small></h1> - </div> - <div class="row"> - <div class="span3 columns"> - <h3>About Tooltips</h3> - <p>Inspired by the excellent jQuery.tipsy plugin written by Jason Frame; Tooltips are an updated version, which don't rely on images, use css3 for animations, and data-attributes for local title storage.</p> - <a href="assets/js/bootstrap-tooltip.js" target="_blank" class="btn">Download file</a> - </div> - <div class="span9 columns"> - <h2>Example use of Tooltips</h2> + <!-- Tooltips + ================================================== --> + <section id="tooltips"> + <div class="page-header"> + <h1>Tooltips <small>bootstrap-tooltip.js</small></h1> + </div> + + + <h2>Examples</h2> + <p>Inspired by the excellent jQuery.tipsy plugin written by Jason Frame; Tooltips are an updated version, which don't rely on images, use CSS3 for animations, and data-attributes for local title storage.</p> <p>Hover over the links below to see tooltips:</p> - <div class="tooltip-demo well"> - <p class="muted" style="margin-bottom: 0;">Tight pants next level keffiyeh <a href="#" rel="tooltip" title="first tooltip">you probably</a> haven't heard of them. Photo booth beard raw denim letterpress vegan messenger bag stumptown. Farm-to-table seitan, mcsweeney's fixie sustainable quinoa 8-bit american apparel <a href="#" rel="tooltip" title="Another tooltip">have a</a> terry richardson vinyl chambray. Beard stumptown, cardigans banh mi lomo thundercats. Tofu biodiesel williamsburg marfa, four loko mcsweeney's cleanse vegan chambray. A really ironic artisan <a href="#" rel="tooltip" title="Another one here too">whatever keytar</a>, scenester farm-to-table banksy Austin <a href="#" rel="tooltip" title="The last tip!">twitter handle</a> freegan cred raw denim single-origin coffee viral. + <div class="bs-docs-example tooltip-demo"> + <p class="muted" style="margin-bottom: 0;">Tight pants next level keffiyeh <a href="#" rel="tooltip" title="Default tooltip">you probably</a> haven't heard of them. Photo booth beard raw denim letterpress vegan messenger bag stumptown. Farm-to-table seitan, mcsweeney's fixie sustainable quinoa 8-bit american apparel <a href="#" rel="tooltip" title="Another tooltip">have a</a> terry richardson vinyl chambray. Beard stumptown, cardigans banh mi lomo thundercats. Tofu biodiesel williamsburg marfa, four loko mcsweeney's cleanse vegan chambray. A really ironic artisan <a href="#" rel="tooltip" title="Another one here too">whatever keytar</a>, scenester farm-to-table banksy Austin <a href="#" rel="tooltip" title="The last tip!">twitter handle</a> freegan cred raw denim single-origin coffee viral. </p> </div> - <hr> - <h2>Using bootstrap-tooltip.js</h2> - <p>Trigger the tooltip via javascript:</p> + + <h3>Four directions</h3> + <div class="bs-docs-example tooltip-demo"> + <ul class="bs-docs-tooltip-examples"> + <li><a href="#" rel="tooltip" data-placement="top" title="Tooltip on top">Tooltip on top</a></li> + <li><a href="#" rel="tooltip" data-placement="right" title="Tooltip on right">Tooltip on right</a></li> + <li><a href="#" rel="tooltip" data-placement="bottom" title="Tooltip on bottom">Tooltip on bottom</a></li> + <li><a href="#" rel="tooltip" data-placement="left" title="Tooltip on left">Tooltip on left</a></li> + </ul> + </div> + + + <hr class="bs-docs-separator"> + + + <h2>Usage</h2> + <p>Trigger the tooltip via JavaScript:</p> <pre class="prettyprint linenums">$('#example').tooltip(options)</pre> + <h3>Options</h3> + <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-animation=""</code>.</p> <table class="table table-bordered table-striped"> <thead> <tr> @@ -769,6 +802,12 @@ $('a[data-toggle="tab"]').on('shown', function (e) { <td>apply a css fade transition to the tooltip</td> </tr> <tr> + <td>html</td> + <td>boolean</td> + <td>true</td> + <td>Insert html into the tooltip. If false, jquery's <code>text</code> method will be used to insert content into the dom. Use text if you're worried about XSS attacks.</td> + </tr> + <tr> <td>placement</td> <td>string|function</td> <td>'top'</td> @@ -790,7 +829,7 @@ $('a[data-toggle="tab"]').on('shown', function (e) { <td>trigger</td> <td>string</td> <td>'hover'</td> - <td>how tooltip is triggered - hover | focus | manual</td> + <td>how tooltip is triggered - click | hover | focus | manual</td> </tr> <tr> <td>delay</td> @@ -808,11 +847,11 @@ $('a[data-toggle="tab"]').on('shown', function (e) { <strong>Heads up!</strong> Options for individual tooltips can alternatively be specified through the use of data attributes. </div> + <h3>Markup</h3> <p>For performance reasons, the Tooltip and Popover data-apis are opt in. If you would like to use them just specify a selector option.</p> -<pre class="prettyprint linenums"> -<a href="#" rel="tooltip" title="first tooltip">hover over me</a> -</pre> + <pre class="prettyprint linenums"><a href="#" rel="tooltip" title="first tooltip">hover over me</a></pre> + <h3>Methods</h3> <h4>$().tooltip(options)</h4> <p>Attaches a tooltip handler to an element collection.</p> @@ -825,139 +864,186 @@ $('a[data-toggle="tab"]').on('shown', function (e) { <h4>.tooltip('toggle')</h4> <p>Toggles an element's tooltip.</p> <pre class="prettyprint linenums">$('#element').tooltip('toggle')</pre> - </div> - </div> - </section> + <h4>.tooltip('destroy')</h4> + <p>Hides and destroys an element's tooltip.</p> + <pre class="prettyprint linenums">$('#element').tooltip('destroy')</pre> + </section> - <!-- Popovers - ================================================== --> - <section id="popovers"> - <div class="page-header"> - <h1>Popovers <small>bootstrap-popover.js</small></h1> - </div> - <div class="row"> - <div class="span3 columns"> - <h3>About popovers</h3> - <p>Add small overlays of content, like those on the iPad, to any element for housing secondary information.</p> - <p class="muted"><strong>*</strong> Requires <a href="#tooltips">Tooltip</a> to be included</p> - <a href="assets/js/bootstrap-popover.js" target="_blank" class="btn">Download file</a> + <!-- Popovers + ================================================== --> + <section id="popovers"> + <div class="page-header"> + <h1>Popovers <small>bootstrap-popover.js</small></h1> </div> - <div class="span9 columns"> - <h2>Example hover popover</h2> - <p>Hover over the button to trigger the popover.</p> - <div class="well"> - <a href="#" class="btn btn-danger" rel="popover" title="A Title" data-content="And here's some amazing content. It's very engaging. right?">hover for popover</a> + + <h2>Examples</h2> + <p>Add small overlays of content, like those on the iPad, to any element for housing secondary information. Hover over the button to trigger the popover. <strong>Requires <a href="#tooltips">Tooltip</a> to be included.</strong></p> + + <h3>Static popover</h3> + <p>Four options are available: top, right, bottom, and left aligned.</p> + <div class="bs-docs-example bs-docs-example-popover"> + <div class="popover top"> + <div class="arrow"></div> + <h3 class="popover-title">Popover top</h3> + <div class="popover-content"> + <p>Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.</p> + </div> </div> - <hr> - <h2>Using bootstrap-popover.js</h2> - <p>Enable popovers via javascript:</p> - <pre class="prettyprint linenums">$('#example').popover(options)</pre> - <h3>Options</h3> - <table class="table table-bordered table-striped"> - <thead> - <tr> - <th style="width: 100px;">Name</th> - <th style="width: 100px;">type</th> - <th style="width: 50px;">default</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td>animation</td> - <td>boolean</td> - <td>true</td> - <td>apply a css fade transition to the tooltip</td> - </tr> - <tr> - <td>placement</td> - <td>string|function</td> - <td>'right'</td> - <td>how to position the popover - top | bottom | left | right</td> - </tr> - <tr> - <td>selector</td> - <td>string</td> - <td>false</td> - <td>if a selector is provided, tooltip objects will be delegated to the specified targets</td> - </tr> - <tr> - <td>trigger</td> - <td>string</td> - <td>'hover'</td> - <td>how tooltip is triggered - hover | focus | manual</td> - </tr> - <tr> - <td>title</td> - <td>string | function</td> - <td>''</td> - <td>default title value if `title` attribute isn't present</td> - </tr> - <tr> - <td>content</td> - <td>string | function</td> - <td>''</td> - <td>default content value if `data-content` attribute isn't present</td> - </tr> - <tr> - <td>delay</td> - <td>number | object</td> - <td>0</td> - <td> - <p>delay showing and hiding the popover (ms) - does not apply to manual trigger type</p> - <p>If a number is supplied, delay is applied to both hide/show</p> - <p>Object structure is: <code>delay: { show: 500, hide: 100 }</code></p> - </td> - </tr> - </tbody> - </table> - <div class="alert alert-info"> - <strong>Heads up!</strong> - Options for individual popovers can alternatively be specified through the use of data attributes. + + <div class="popover right"> + <div class="arrow"></div> + <h3 class="popover-title">Popover right</h3> + <div class="popover-content"> + <p>Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.</p> + </div> </div> - <h3>Markup</h3> - <p> - For performance reasons, the Tooltip and Popover data-apis are opt in. If you would like to use them just specify a selector option. - </p> - <h3>Methods</h3> - <h4>$().popover(options)</h4> - <p>Initializes popovers for an element collection.</p> - <h4>.popover('show')</h4> - <p>Reveals an elements popover.</p> - <pre class="prettyprint linenums">$('#element').popover('show')</pre> - <h4>.popover('hide')</h4> - <p>Hides an elements popover.</p> - <pre class="prettyprint linenums">$('#element').popover('hide')</pre> - <h4>.popover('toggle')</h4> - <p>Toggles an elements popover.</p> - <pre class="prettyprint linenums">$('#element').popover('toggle')</pre> + + <div class="popover bottom"> + <div class="arrow"></div> + <h3 class="popover-title">Popover bottom</h3> + <div class="popover-content"> + <p>Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.</p> + </div> + </div> + + <div class="popover left"> + <div class="arrow"></div> + <h3 class="popover-title">Popover left</h3> + <div class="popover-content"> + <p>Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.</p> + </div> + </div> + + <div class="clearfix"></div> </div> - </div> - </section> + <p>No markup shown as popovers are generated from JavaScript and content within a <code>data</code> attribute.</p> + <h3>Live demo</h3> + <div class="bs-docs-example" style="padding-bottom: 24px;"> + <a href="#" class="btn btn-large btn-danger" rel="popover" title="A Title" data-content="And here's some amazing content. It's very engaging. right?">Click to toggle popover</a> + </div> - <!-- Alert - ================================================== --> - <section id="alerts"> - <div class="page-header"> - <h1>Alert messages <small>bootstrap-alert.js</small></h1> - </div> - <div class="row"> - <div class="span3 columns"> - <h3>About alerts</h3> - <p>The alert plugin is a tiny class for adding close functionality to alerts.</p> - <a href="assets/js/bootstrap-alert.js" target="_blank" class="btn">Download</a> + <hr class="bs-docs-separator"> + + + <h2>Usage</h2> + <p>Enable popovers via JavaScript:</p> + <pre class="prettyprint linenums">$('#example').popover(options)</pre> + + <h3>Options</h3> + <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-animation=""</code>.</p> + <table class="table table-bordered table-striped"> + <thead> + <tr> + <th style="width: 100px;">Name</th> + <th style="width: 100px;">type</th> + <th style="width: 50px;">default</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td>animation</td> + <td>boolean</td> + <td>true</td> + <td>apply a css fade transition to the tooltip</td> + </tr> + <tr> + <td>html</td> + <td>boolean</td> + <td>true</td> + <td>Insert html into the popover. If false, jquery's <code>text</code> method will be used to insert content into the dom. Use text if you're worried about XSS attacks.</td> + </tr> + <tr> + <td>placement</td> + <td>string|function</td> + <td>'right'</td> + <td>how to position the popover - top | bottom | left | right</td> + </tr> + <tr> + <td>selector</td> + <td>string</td> + <td>false</td> + <td>if a selector is provided, tooltip objects will be delegated to the specified targets</td> + </tr> + <tr> + <td>trigger</td> + <td>string</td> + <td>'click'</td> + <td>how popover is triggered - click | hover | focus | manual</td> + </tr> + <tr> + <td>title</td> + <td>string | function</td> + <td>''</td> + <td>default title value if `title` attribute isn't present</td> + </tr> + <tr> + <td>content</td> + <td>string | function</td> + <td>''</td> + <td>default content value if `data-content` attribute isn't present</td> + </tr> + <tr> + <td>delay</td> + <td>number | object</td> + <td>0</td> + <td> + <p>delay showing and hiding the popover (ms) - does not apply to manual trigger type</p> + <p>If a number is supplied, delay is applied to both hide/show</p> + <p>Object structure is: <code>delay: { show: 500, hide: 100 }</code></p> + </td> + </tr> + </tbody> + </table> + <div class="alert alert-info"> + <strong>Heads up!</strong> + Options for individual popovers can alternatively be specified through the use of data attributes. + </div> + + <h3>Markup</h3> + <p>For performance reasons, the Tooltip and Popover data-apis are opt in. If you would like to use them just specify a selector option.</p> + + <h3>Methods</h3> + <h4>$().popover(options)</h4> + <p>Initializes popovers for an element collection.</p> + <h4>.popover('show')</h4> + <p>Reveals an elements popover.</p> + <pre class="prettyprint linenums">$('#element').popover('show')</pre> + <h4>.popover('hide')</h4> + <p>Hides an elements popover.</p> + <pre class="prettyprint linenums">$('#element').popover('hide')</pre> + <h4>.popover('toggle')</h4> + <p>Toggles an elements popover.</p> + <pre class="prettyprint linenums">$('#element').popover('toggle')</pre> + <h4>.popover('destroy')</h4> + <p>Hides and destroys an element's popover.</p> + <pre class="prettyprint linenums">$('#element').popover('destroy')</pre> + </section> + + + + <!-- Alert + ================================================== --> + <section id="alerts"> + <div class="page-header"> + <h1>Alert messages <small>bootstrap-alert.js</small></h1> </div> - <div class="span9 columns"> - <h2>Example alerts</h2> - <p>The alerts plugin works on regular alert messages, and block messages.</p> + + + <h2>Example alerts</h2> + <p>Add dismiss functionality to all alerge messages with this plugin.</p> + <div class="bs-docs-example"> <div class="alert fade in"> <button type="button" class="close" data-dismiss="alert">×</button> <strong>Holy guacamole!</strong> Best check yo self, you're not looking too good. </div> + </div> + + <div class="bs-docs-example"> <div class="alert alert-block alert-error fade in"> <button type="button" class="close" data-dismiss="alert">×</button> <h4 class="alert-heading">Oh snap! You got an error!</h4> @@ -966,387 +1052,355 @@ $('a[data-toggle="tab"]').on('shown', function (e) { <a class="btn btn-danger" href="#">Take this action</a> <a class="btn" href="#">Or do this</a> </p> </div> - <hr> - <h2>Using bootstrap-alert.js</h2> - <p>Enable dismissal of an alert via javascript:</p> - <pre class="prettyprint linenums">$(".alert").alert()</pre> - <h3>Markup</h3> - <p>Just add <code>data-dismiss="alert"</code> to your close button to automatically give an alert close functionality.</p> - <pre class="prettyprint linenums"><a class="close" data-dismiss="alert" href="#">&times;</a></pre> - <h3>Methods</h3> - <h4>$().alert()</h4> - <p>Wraps all alerts with close functionality. To have your alerts animate out when closed, make sure they have the <code>.fade</code> and <code>.in</code> class already applied to them.</p> - <h4>.alert('close')</h4> - <p>Closes an alert.</p> - <pre class="prettyprint linenums">$(".alert").alert('close')</pre> - <h3>Events</h3> - <p>Bootstrap's alert class exposes a few events for hooking into alert functionality.</p> - <table class="table table-bordered table-striped"> - <thead> - <tr> - <th style="width: 150px;">Event</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>close</td> - <td>This event fires immediately when the <code>close</code> instance method is called.</td> - </tr> - <tr> - <td>closed</td> - <td>This event is fired when the alert has been closed (will wait for css transitions to complete).</td> - </tr> - </tbody> - </table> + </div> + + + <hr class="bs-docs-separator"> + + + <h2>Usage</h2> + <p>Enable dismissal of an alert via JavaScript:</p> + <pre class="prettyprint linenums">$(".alert").alert()</pre> + + <h3>Markup</h3> + <p>Just add <code>data-dismiss="alert"</code> to your close button to automatically give an alert close functionality.</p> + <pre class="prettyprint linenums"><a class="close" data-dismiss="alert" href="#">&times;</a></pre> + + <h3>Methods</h3> + <h4>$().alert()</h4> + <p>Wraps all alerts with close functionality. To have your alerts animate out when closed, make sure they have the <code>.fade</code> and <code>.in</code> class already applied to them.</p> + <h4>.alert('close')</h4> + <p>Closes an alert.</p> + <pre class="prettyprint linenums">$(".alert").alert('close')</pre> + + + <h3>Events</h3> + <p>Bootstrap's alert class exposes a few events for hooking into alert functionality.</p> + <table class="table table-bordered table-striped"> + <thead> + <tr> + <th style="width: 150px;">Event</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>close</td> + <td>This event fires immediately when the <code>close</code> instance method is called.</td> + </tr> + <tr> + <td>closed</td> + <td>This event is fired when the alert has been closed (will wait for css transitions to complete).</td> + </tr> + </tbody> + </table> <pre class="prettyprint linenums"> $('#my-alert').bind('closed', function () { // do something… -})</pre> - </div> - </div> - </section> +}) +</pre> + </section> - <!-- Buttons - ================================================== --> - <section id="buttons"> - <div class="page-header"> - <h1>Buttons <small>bootstrap-button.js</small></h1> - </div> - <div class="row"> - <div class="span3 columns"> - <h3>About</h3> - <p>Do more with buttons. Control button states or create groups of buttons for more components like toolbars.</p> - <a href="assets/js/bootstrap-button.js" target="_blank" class="btn">Download file</a> - </div> - <div class="span9 columns"> - <h2>Example uses</h2> - <p>Use the buttons plugin for states and toggles.</p> - <table class="table table-bordered table-striped"> - <tbody> - <tr> - <td>Stateful</td> - <td> - <button id="fat-btn" data-loading-text="loading..." class="btn btn-primary"> - Loading State - </button> - </td> - </tr> - <tr> - <td>Single toggle</td> - <td> - <button class="btn btn-primary" data-toggle="button">Single Toggle</button> - </td> - </tr> - <tr> - <td>Checkbox</td> - <td> - <div class="btn-group" data-toggle="buttons-checkbox"> - <button class="btn btn-primary">Left</button> - <button class="btn btn-primary">Middle</button> - <button class="btn btn-primary">Right</button> - </div> - </td> - </tr> - <tr> - <td>Radio</td> - <td> - <div class="btn-group" data-toggle="buttons-radio"> - <button class="btn btn-primary">Left</button> - <button class="btn btn-primary">Middle</button> - <button class="btn btn-primary">Right</button> - </div> - </td> - </tr> - </tbody> - </table> - <hr> - <h2>Using bootstrap-button.js</h2> - <p>Enable buttons via javascript:</p> - <pre class="prettyprint linenums">$('.nav-tabs').button()</pre> - <h3>Markup</h3> - <p>Data attributes are integral to the button plugin. Check out the example code below for the various markup types.</p> -<pre class="prettyprint linenums"> -<!-- Add data-toggle="button" to activate toggling on a single button --> -<button class="btn" data-toggle="button">Single Toggle</button> + <!-- Buttons + ================================================== --> + <section id="buttons"> + <div class="page-header"> + <h1>Buttons <small>bootstrap-button.js</small></h1> + </div> + + <h2>Example uses</h2> + <p>Do more with buttons. Control button states or create groups of buttons for more components like toolbars.</p> -<!-- Add data-toggle="buttons-checkbox" for checkbox style toggling on btn-group --> + <h4>Stateful</h4> + <p>Add data-loading-text="Loading..." to use a loading state on a button.</p> + <div class="bs-docs-example" style="padding-bottom: 24px;"> + <button type="button" id="fat-btn" data-loading-text="loading..." class="btn btn-primary"> + Loading state + </button> + </div> + <pre class="prettyprint linenums"><button type="button" class="btn btn-primary" data-loading-text="Loading...">Loading state</button></pre> + + <h4>Single toggle</h4> + <p>Add data-toggle="button" to activate toggling on a single button.</p> + <div class="bs-docs-example" style="padding-bottom: 24px;"> + <button type="button" class="btn btn-primary" data-toggle="button">Single Toggle</button> + </div> + <pre class="prettyprint linenums"><button type="button" class="btn" data-toggle="button">Single Toggle</button></pre> + + <h4>Checkbox</h4> + <p>Add data-toggle="buttons-checkbox" for checkbox style toggling on btn-group.</p> + <div class="bs-docs-example" style="padding-bottom: 24px;"> + <div class="btn-group" data-toggle="buttons-checkbox"> + <button type="button" class="btn btn-primary">Left</button> + <button type="button" class="btn btn-primary">Middle</button> + <button type="button" class="btn btn-primary">Right</button> + </div> + </div> +<pre class="prettyprint linenums"> <div class="btn-group" data-toggle="buttons-checkbox"> - <button class="btn">Left</button> - <button class="btn">Middle</button> - <button class="btn">Right</button> + <button type="button" class="btn">Left</button> + <button type="button" class="btn">Middle</button> + <button type="button" class="btn">Right</button> </div> +</pre> -<!-- Add data-toggle="buttons-radio" for radio style toggling on btn-group --> + <h4>Radio</h4> + <p>Add data-toggle="buttons-radio" for radio style toggling on btn-group.</p> + <div class="bs-docs-example" style="padding-bottom: 24px;"> + <div class="btn-group" data-toggle="buttons-radio"> + <button type="button" class="btn btn-primary">Left</button> + <button type="button" class="btn btn-primary">Middle</button> + <button type="button" class="btn btn-primary">Right</button> + </div> + </div> +<pre class="prettyprint linenums"> <div class="btn-group" data-toggle="buttons-radio"> - <button class="btn">Left</button> - <button class="btn">Middle</button> - <button class="btn">Right</button> + <button type="button" class="btn">Left</button> + <button type="button" class="btn">Middle</button> + <button type="button" class="btn">Right</button> </div> </pre> - <h3>Methods</h3> - <h4>$().button('toggle')</h4> - <p>Toggles push state. Gives the button the appearance that it has been activated.</p> - <div class="alert alert-info"> - <strong>Heads up!</strong> - You can enable auto toggling of a button by using the <code>data-toggle</code> attribute. - </div> - <pre class="prettyprint linenums"><button class="btn" data-toggle="button" >…</button></pre> - <h4>$().button('loading')</h4> - <p>Sets button state to loading - disables button and swaps text to loading text. Loading text should be defined on the button element using the data attribute <code>data-loading-text</code>. - </p> - <pre class="prettyprint linenums"><button class="btn" data-loading-text="loading stuff..." >...</button></pre> - <div class="alert alert-info"> - <strong>Heads up!</strong> - <a href="https://github.com/twitter/bootstrap/issues/793">Firefox persists the disabled state across page loads</a>. A workaround for this is to use <code>autocomplete="off"</code>. - </div> - <h4>$().button('reset')</h4> - <p>Resets button state - swaps text to original text.</p> - <h4>$().button(string)</h4> - <p>Resets button state - swaps text to any data defined text state.</p> -<pre class="prettyprint linenums"><button class="btn" data-complete-text="finished!" >...</button> + + + <hr class="bs-docs-separator"> + + + <h2>Usage</h2> + <p>Enable buttons via JavaScript:</p> + <pre class="prettyprint linenums">$('.nav-tabs').button()</pre> + + <h3>Markup</h3> + <p>Data attributes are integral to the button plugin. Check out the example code below for the various markup types.</p> + + <h3>Options</h3> + <p><em>None</em></p> + + <h3>Methods</h3> + <h4>$().button('toggle')</h4> + <p>Toggles push state. Gives the button the appearance that it has been activated.</p> + <div class="alert alert-info"> + <strong>Heads up!</strong> + You can enable auto toggling of a button by using the <code>data-toggle</code> attribute. + </div> + <pre class="prettyprint linenums"><button type="button" class="btn" data-toggle="button" >…</button></pre> + <h4>$().button('loading')</h4> + <p>Sets button state to loading - disables button and swaps text to loading text. Loading text should be defined on the button element using the data attribute <code>data-loading-text</code>. + </p> + <pre class="prettyprint linenums"><button type="button" class="btn" data-loading-text="loading stuff..." >...</button></pre> + <div class="alert alert-info"> + <strong>Heads up!</strong> + <a href="https://github.com/twitter/bootstrap/issues/793">Firefox persists the disabled state across page loads</a>. A workaround for this is to use <code>autocomplete="off"</code>. + </div> + <h4>$().button('reset')</h4> + <p>Resets button state - swaps text to original text.</p> + <h4>$().button(string)</h4> + <p>Resets button state - swaps text to any data defined text state.</p> +<pre class="prettyprint linenums"><button type="button" class="btn" data-complete-text="finished!" >...</button> <script> $('.btn').button('complete') -</script></pre> - </div> - </div> - </section> +</script> +</pre> + </section> - <!-- Collapse - ================================================== --> - <section id="collapse"> - <div class="page-header"> - <h1>Collapse <small>bootstrap-collapse.js</small></h1> - </div> - <div class="row"> - <div class="span3 columns"> - <h3>About</h3> - <p>Get base styles and flexible support for collapsible components like accordions and navigation.</p> - <a href="assets/js/bootstrap-collapse.js" target="_blank" class="btn">Download file</a> - <p class="muted"><strong>*</strong> Requires the Transitions plugin to be included.</p> - </div> - <div class="span9 columns"> - <h2>Example accordion</h2> - <p>Using the collapse plugin, we built a simple accordion style widget:</p> - - <div class="accordion" id="accordion2"> - <div class="accordion-group"> - <div class="accordion-heading"> - <a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#collapseOne"> - Collapsible Group Item #1 - </a> - </div> - <div id="collapseOne" class="accordion-body collapse in"> - <div class="accordion-inner"> - Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS. - </div> - </div> + <!-- Collapse + ================================================== --> + <section id="collapse"> + <div class="page-header"> + <h1>Collapse <small>bootstrap-collapse.js</small></h1> </div> - <div class="accordion-group"> - <div class="accordion-heading"> - <a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#collapseTwo"> - Collapsible Group Item #2 - </a> - </div> - <div id="collapseTwo" class="accordion-body collapse"> - <div class="accordion-inner"> - Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS. + + <h3>About</h3> + <p>Get base styles and flexible support for collapsible components like accordions and navigation.</p> + <p class="muted"><strong>*</strong> Requires the Transitions plugin to be included.</p> + + <h2>Example accordion</h2> + <p>Using the collapse plugin, we built a simple accordion style widget:</p> + + <div class="bs-docs-example"> + <div class="accordion" id="accordion2"> + <div class="accordion-group"> + <div class="accordion-heading"> + <a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#collapseOne"> + Collapsible Group Item #1 + </a> + </div> + <div id="collapseOne" class="accordion-body collapse in"> + <div class="accordion-inner"> + Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS. + </div> + </div> </div> - </div> - </div> - <div class="accordion-group"> - <div class="accordion-heading"> - <a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#collapseThree"> - Collapsible Group Item #3 - </a> - </div> - <div id="collapseThree" class="accordion-body collapse"> - <div class="accordion-inner"> - Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS. + <div class="accordion-group"> + <div class="accordion-heading"> + <a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#collapseTwo"> + Collapsible Group Item #2 + </a> + </div> + <div id="collapseTwo" class="accordion-body collapse"> + <div class="accordion-inner"> + Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS. + </div> + </div> + </div> + <div class="accordion-group"> + <div class="accordion-heading"> + <a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#collapseThree"> + Collapsible Group Item #3 + </a> + </div> + <div id="collapseThree" class="accordion-body collapse"> + <div class="accordion-inner"> + Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS. + </div> + </div> </div> </div> </div> - </div> - - - <hr> - <h2>Using bootstrap-collapse.js</h2> - <p>Enable via javascript:</p> - <pre class="prettyprint linenums">$(".collapse").collapse()</pre> - <h3>Options</h3> - <table class="table table-bordered table-striped"> - <thead> - <tr> - <th style="width: 100px;">Name</th> - <th style="width: 50px;">type</th> - <th style="width: 50px;">default</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td>parent</td> - <td>selector</td> - <td>false</td> - <td>If selector then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior)</td> - </tr> - <tr> - <td>toggle</td> - <td>boolean</td> - <td>true</td> - <td>Toggles the collapsible element on invocation</td> - </tr> - </tbody> - </table> - <h3>Markup</h3> - <p>Just add <code>data-toggle="collapse"</code> and a <code>data-target</code> to element to automatically assign control of a collapsible element. The <code>data-target</code> attribute accepts a css selector to apply the collapse to. Be sure to add the class <code>collapse</code> to the collapsible element. If you'd like it to default open, add the additional class <code>in</code>.</p> - <pre class="prettyprint linenums"> -<button class="btn btn-danger" data-toggle="collapse" data-target="#demo"> +<pre class="prettyprint linenums"> +<button type="button" class="btn btn-danger" data-toggle="collapse" data-target="#demo"> simple collapsible </button> -<div id="demo" class="collapse in"> … </div></pre> - <div class="alert alert-info"> - <strong>Heads up!</strong> - To add accordion-like group management to a collapsible control, add the data attribute <code>data-parent="#selector"</code>. Refer to the demo to see this in action. - </div> - <h3>Methods</h3> - <h4>.collapse(options)</h4> - <p>Activates your content as a collapsible element. Accepts an optional options <code>object</code>. +<div id="demo" class="collapse in"> … </div> +</pre> + + + <hr class="bs-docs-separator"> + + + <h2>Usage</h2> + + <h3>Via data attributes</h3> + <p>Just add <code>data-toggle="collapse"</code> and a <code>data-target</code> to element to automatically assign control of a collapsible element. The <code>data-target</code> attribute accepts a css selector to apply the collapse to. Be sure to add the class <code>collapse</code> to the collapsible element. If you'd like it to default open, add the additional class <code>in</code>.</p> + <p>To add accordion-like group management to a collapsible control, add the data attribute <code>data-parent="#selector"</code>. Refer to the demo to see this in action.</p> + + <h3>Via JavaScript</h3> + <p>Enable manually with:</p> + <pre class="prettyprint linenums">$(".collapse").collapse()</pre> + + <h3>Options</h3> + <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-parent=""</code>.</p> + <table class="table table-bordered table-striped"> + <thead> + <tr> + <th style="width: 100px;">Name</th> + <th style="width: 50px;">type</th> + <th style="width: 50px;">default</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td>parent</td> + <td>selector</td> + <td>false</td> + <td>If selector then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior)</td> + </tr> + <tr> + <td>toggle</td> + <td>boolean</td> + <td>true</td> + <td>Toggles the collapsible element on invocation</td> + </tr> + </tbody> + </table> + + + <h3>Methods</h3> + <h4>.collapse(options)</h4> + <p>Activates your content as a collapsible element. Accepts an optional options <code>object</code>. <pre class="prettyprint linenums"> $('#myCollapsible').collapse({ toggle: false -})</pre> - <h4>.collapse('toggle')</h4> - <p>Toggles a collapsible element to shown or hidden.</p> - <h4>.collapse('show')</h4> - <p>Shows a collapsible element.</p> - <h4>.collapse('hide')</h4> - <p>Hides a collapsible element.</p> - <h3>Events</h3> - <p> - Bootstrap's collapse class exposes a few events for hooking into collapse functionality. - </p> - <table class="table table-bordered table-striped"> - <thead> - <tr> - <th style="width: 150px;">Event</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>show</td> - <td>This event fires immediately when the <code>show</code> instance method is called.</td> - </tr> - <tr> - <td>shown</td> - <td>This event is fired when a collapse element has been made visible to the user (will wait for css transitions to complete).</td> - </tr> - <tr> - <td>hide</td> - <td> - This event is fired immediately when the <code>hide</code> method has been called. - </td> - </tr> - <tr> - <td>hidden</td> - <td>This event is fired when a collapse element has been hidden from the user (will wait for css transitions to complete).</td> - </tr> - </tbody> - </table> - +}) +</pre> + <h4>.collapse('toggle')</h4> + <p>Toggles a collapsible element to shown or hidden.</p> + <h4>.collapse('show')</h4> + <p>Shows a collapsible element.</p> + <h4>.collapse('hide')</h4> + <p>Hides a collapsible element.</p> + + <h3>Events</h3> + <p>Bootstrap's collapse class exposes a few events for hooking into collapse functionality.</p> + <table class="table table-bordered table-striped"> + <thead> + <tr> + <th style="width: 150px;">Event</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>show</td> + <td>This event fires immediately when the <code>show</code> instance method is called.</td> + </tr> + <tr> + <td>shown</td> + <td>This event is fired when a collapse element has been made visible to the user (will wait for css transitions to complete).</td> + </tr> + <tr> + <td>hide</td> + <td> + This event is fired immediately when the <code>hide</code> method has been called. + </td> + </tr> + <tr> + <td>hidden</td> + <td>This event is fired when a collapse element has been hidden from the user (will wait for css transitions to complete).</td> + </tr> + </tbody> + </table> <pre class="prettyprint linenums"> $('#myCollapsible').on('hidden', function () { // do something… })</pre> - </div> - </div> - </section> + </section> - <!-- Carousel - ================================================== --> - <section id="carousel"> - <div class="page-header"> - <h1>Carousel <small>bootstrap-carousel.js</small></h1> - </div> - <div class="row"> - <div class="span3 columns"> - <h3>About</h3> - <p>A generic plugin for cycling through elements. A merry-go-round.</p> - <a href="assets/js/bootstrap-carousel.js" target="_blank" class="btn">Download file</a> - </div> - <div class="span9 columns"> - <h2>Example carousel</h2> - <p>Watch the slideshow below.</p> - <div id="myCarousel" class="carousel slide"> - <div class="carousel-inner"> - <div class="item active"> - <img src="assets/img/bootstrap-mdo-sfmoma-01.jpg" alt=""> - <div class="carousel-caption"> - <h4>First Thumbnail label</h4> - <p>Cras justo odio, dapibus ac facilisis in, egestas eget quam. Donec id elit non mi porta gravida at eget metus. Nullam id dolor id nibh ultricies vehicula ut id elit.</p> - </div> - </div> - <div class="item"> - <img src="assets/img/bootstrap-mdo-sfmoma-02.jpg" alt=""> - <div class="carousel-caption"> - <h4>Second Thumbnail label</h4> - <p>Cras justo odio, dapibus ac facilisis in, egestas eget quam. Donec id elit non mi porta gravida at eget metus. Nullam id dolor id nibh ultricies vehicula ut id elit.</p> - </div> - </div> - <div class="item"> - <img src="assets/img/bootstrap-mdo-sfmoma-03.jpg" alt=""> - <div class="carousel-caption"> - <h4>Third Thumbnail label</h4> - <p>Cras justo odio, dapibus ac facilisis in, egestas eget quam. Donec id elit non mi porta gravida at eget metus. Nullam id dolor id nibh ultricies vehicula ut id elit.</p> + <!-- Carousel + ================================================== --> + <section id="carousel"> + <div class="page-header"> + <h1>Carousel <small>bootstrap-carousel.js</small></h1> + </div> + + <h2>Example carousel</h2> + <p>The slideshow below shows a generic plugin and component for cycling through elements like a carousel.</p> + <div class="bs-docs-example"> + <div id="myCarousel" class="carousel slide"> + <div class="carousel-inner"> + <div class="item active"> + <img src="assets/img/bootstrap-mdo-sfmoma-01.jpg" alt=""> + <div class="carousel-caption"> + <h4>First Thumbnail label</h4> + <p>Cras justo odio, dapibus ac facilisis in, egestas eget quam. Donec id elit non mi porta gravida at eget metus. Nullam id dolor id nibh ultricies vehicula ut id elit.</p> + </div> + </div> + <div class="item"> + <img src="assets/img/bootstrap-mdo-sfmoma-02.jpg" alt=""> + <div class="carousel-caption"> + <h4>Second Thumbnail label</h4> + <p>Cras justo odio, dapibus ac facilisis in, egestas eget quam. Donec id elit non mi porta gravida at eget metus. Nullam id dolor id nibh ultricies vehicula ut id elit.</p> + </div> + </div> + <div class="item"> + <img src="assets/img/bootstrap-mdo-sfmoma-03.jpg" alt=""> + <div class="carousel-caption"> + <h4>Third Thumbnail label</h4> + <p>Cras justo odio, dapibus ac facilisis in, egestas eget quam. Donec id elit non mi porta gravida at eget metus. Nullam id dolor id nibh ultricies vehicula ut id elit.</p> + </div> + </div> </div> + <a class="left carousel-control" href="#myCarousel" data-slide="prev">‹</a> + <a class="right carousel-control" href="#myCarousel" data-slide="next">›</a> </div> </div> - <a class="left carousel-control" href="#myCarousel" data-slide="prev">‹</a> - <a class="right carousel-control" href="#myCarousel" data-slide="next">›</a> - </div> - <div class="alert alert-info"> - <strong>Heads up!</strong> - When implementing this carousel, remove the images we have provided and replace them with your own. - </div> - <hr> - <h2>Using bootstrap-carousel.js</h2> - <p>Call via javascript:</p> - <pre class="prettyprint linenums">$('.carousel').carousel()</pre> - <h3>Options</h3> - <table class="table table-bordered table-striped"> - <thead> - <tr> - <th style="width: 100px;">Name</th> - <th style="width: 50px;">type</th> - <th style="width: 50px;">default</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td>interval</td> - <td>number</td> - <td>5000</td> - <td>The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.</td> - </tr> - <tr> - <td>pause</td> - <td>string</td> - <td>"hover"</td> - <td>Pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave.</td> - </tr> - </tbody> - </table> - <h3>Markup</h3> - <p>Data attributes are used for the previous and next conrols. Check out the example markup below.</p> <pre class="prettyprint linenums"> <div id="myCarousel" class="carousel slide"> <!-- Carousel items --> @@ -1360,138 +1414,263 @@ $('#myCollapsible').on('hidden', function () { <a class="carousel-control right" href="#myCarousel" data-slide="next">&rsaquo;</a> </div> </pre> - <h3>Methods</h3> - <h4>.carousel(options)</h4> - <p>Initializes the carousel with an optional options <code>object</code> and starts cycling through items.</p> + + <div class="alert alert-warning"> + <strong>Heads up!</strong> + When implementing this carousel, remove the images we have provided and replace them with your own. + </div> + + + <hr class="bs-docs-separator"> + + + <h2>Usage</h2> + + <h3>Via data attributes</h3> + <p>...</p> + + <h3>Via JavaScript</h3> + <p>Call carousel manually with:</p> + <pre class="prettyprint linenums">$('.carousel').carousel()</pre> + + <h3>Options</h3> + <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-interval=""</code>.</p> + <table class="table table-bordered table-striped"> + <thead> + <tr> + <th style="width: 100px;">Name</th> + <th style="width: 50px;">type</th> + <th style="width: 50px;">default</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td>interval</td> + <td>number</td> + <td>5000</td> + <td>The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.</td> + </tr> + <tr> + <td>pause</td> + <td>string</td> + <td>"hover"</td> + <td>Pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave.</td> + </tr> + </tbody> + </table> + + <h3>Methods</h3> + <h4>.carousel(options)</h4> + <p>Initializes the carousel with an optional options <code>object</code> and starts cycling through items.</p> <pre class="prettyprint linenums"> $('.carousel').carousel({ interval: 2000 }) </pre> - <h4>.carousel('cycle')</h4> - <p>Cycles through the carousel items from left to right.</p> - <h4>.carousel('pause')</h4> - <p>Stops the carousel from cycling through items.</p> - <h4>.carousel(number)</h4> - <p>Cycles the carousel to a particular frame (0 based, similar to an array).</p> - <h4>.carousel('prev')</h4> - <p>Cycles to the previous item.</p> - <h4>.carousel('next')</h4> - <p>Cycles to the next item.</p> - <h3>Events</h3> - <p>Bootstrap's carousel class exposes two events for hooking into carousel functionality.</p> - <table class="table table-bordered table-striped"> - <thead> - <tr> - <th style="width: 150px;">Event</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>slide</td> - <td>This event fires immediately when the <code>slide</code> instance method is invoked.</td> - </tr> - <tr> - <td>slid</td> - <td>This event is fired when the carousel has completed its slide transition.</td> - </tr> - </tbody> - </table> - </div> - </div> - </section> + <h4>.carousel('cycle')</h4> + <p>Cycles through the carousel items from left to right.</p> + <h4>.carousel('pause')</h4> + <p>Stops the carousel from cycling through items.</p> + <h4>.carousel(number)</h4> + <p>Cycles the carousel to a particular frame (0 based, similar to an array).</p> + <h4>.carousel('prev')</h4> + <p>Cycles to the previous item.</p> + <h4>.carousel('next')</h4> + <p>Cycles to the next item.</p> + + <h3>Events</h3> + <p>Bootstrap's carousel class exposes two events for hooking into carousel functionality.</p> + <table class="table table-bordered table-striped"> + <thead> + <tr> + <th style="width: 150px;">Event</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>slide</td> + <td>This event fires immediately when the <code>slide</code> instance method is invoked.</td> + </tr> + <tr> + <td>slid</td> + <td>This event is fired when the carousel has completed its slide transition.</td> + </tr> + </tbody> + </table> + </section> + + + + <!-- Typeahead + ================================================== --> + <section id="typeahead"> + <div class="page-header"> + <h1>Typeahead <small>bootstrap-typeahead.js</small></h1> + </div> + <h2>Example</h2> + <p>A basic, easily extended plugin for quickly creating elegant typeaheads with any form text input.</p> + <div class="bs-docs-example" style="background-color: #f5f5f5;"> + <input type="text" class="span3" style="margin: 0 auto;" data-provide="typeahead" data-items="4" data-source='["Alabama","Alaska","Arizona","Arkansas","California","Colorado","Connecticut","Delaware","Florida","Georgia","Hawaii","Idaho","Illinois","Indiana","Iowa","Kansas","Kentucky","Louisiana","Maine","Maryland","Massachusetts","Michigan","Minnesota","Mississippi","Missouri","Montana","Nebraska","Nevada","New Hampshire","New Jersey","New Mexico","New York","North Dakota","North Carolina","Ohio","Oklahoma","Oregon","Pennsylvania","Rhode Island","South Carolina","South Dakota","Tennessee","Texas","Utah","Vermont","Virginia","Washington","West Virginia","Wisconsin","Wyoming"]'> + </div> + <pre class="prettyprint linenums"><input type="text" data-provide="typeahead"></pre> + + + <hr class="bs-docs-separator"> + + + <h2>Usage</h2> + + <h3>Via data attributes</h3> + <p>Add data attributes to register an element with typeahead functionality as shown in the example above.</p> + + <h3>Via JavaScript</h3> + <p>Call the typeahead manually with:</p> + <pre class="prettyprint linenums">$('.typeahead').typeahead()</pre> + + <h3>Options</h3> + <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-source=""</code>.</p> + <table class="table table-bordered table-striped"> + <thead> + <tr> + <th style="width: 100px;">Name</th> + <th style="width: 50px;">type</th> + <th style="width: 100px;">default</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td>source</td> + <td>array, function</td> + <td>[ ]</td> + <td>The data source to query against. May be an array of strings or a function. The function is passed two arguments, the <code>query</code> value in the input field and the <code>process</code> callback. The function may be used synchronously by returning the data source directly or asynchronously via the <code>process</code> callback's single argument.</td> + </tr> + <tr> + <td>items</td> + <td>number</td> + <td>8</td> + <td>The max number of items to display in the dropdown.</td> + </tr> + <tr> + <td>minLength</td> + <td>number</td> + <td>1</td> + <td>The minimum character length needed before triggering autocomplete suggestions</td> + </tr> + <tr> + <td>matcher</td> + <td>function</td> + <td>case insensitive</td> + <td>The method used to determine if a query matches an item. Accepts a single argument, the <code>item</code> against which to test the query. Access the current query with <code>this.query</code>. Return a boolean <code>true</code> if query is a match.</td> + </tr> + <tr> + <td>sorter</td> + <td>function</td> + <td>exact match,<br> case sensitive,<br> case insensitive</td> + <td>Method used to sort autocomplete results. Accepts a single argument <code>items</code> and has the scope of the typeahead instance. Reference the current query with <code>this.query</code>.</td> + </tr> + <tr> + <td>highlighter</td> + <td>function</td> + <td>highlights all default matches</td> + <td>Method used to highlight autocomplete results. Accepts a single argument <code>item</code> and has the scope of the typeahead instance. Should return html.</td> + </tr> + </tbody> + </table> + + <h3>Methods</h3> + <h4>.typeahead(options)</h4> + <p>Initializes an input with a typeahead.</p> + </section> + + + + <!-- Affix + ================================================== --> + <section id="affix"> + <div class="page-header"> + <h1>Affix <small>bootstrap-affix.js</small></h1> + </div> - <!-- Typeahead - ================================================== --> - <section id="typeahead"> - <div class="page-header"> - <h1>Typeahead <small>bootstrap-typeahead.js</small></h1> - </div> - <div class="row"> - <div class="span3 columns"> - <h3>About</h3> - <p>A basic, easily extended plugin for quickly creating elegant typeaheads with any form text input.</p> - <a href="assets/js/bootstrap-typeahead.js" target="_blank" class="btn">Download file</a> - </div> - <div class="span9 columns"> - <h2>Example</h2> - <p>Start typing in the field below to show the typeahead results.</p> - <div class="well"> - <input type="text" class="span3" style="margin: 0 auto;" data-provide="typeahead" data-items="4" data-source='["Alabama","Alaska","Arizona","Arkansas","California","Colorado","Connecticut","Delaware","Florida","Georgia","Hawaii","Idaho","Illinois","Indiana","Iowa","Kansas","Kentucky","Louisiana","Maine","Maryland","Massachusetts","Michigan","Minnesota","Mississippi","Missouri","Montana","Nebraska","Nevada","New Hampshire","New Jersey","New Mexico","New York","North Dakota","North Carolina","Ohio","Oklahoma","Oregon","Pennsylvania","Rhode Island","South Carolina","South Dakota","Tennessee","Texas","Utah","Vermont","Virginia","Washington","West Virginia","Wisconsin","Wyoming"]'> - </div> - <hr> - <h2>Using bootstrap-typeahead.js</h2> - <p>Call the typeahead via javascript:</p> - <pre class="prettyprint linenums">$('.typeahead').typeahead()</pre> + <h2>Example</h2> + <p>The subnavigation on the left is a live demo of the affix plugin.</p> + + <hr class="bs-docs-separator"> + + <h2>Usage</h2> + + <h3>Via data attributes</h3> + <p>To easily add affix behavior to any element, just add <code>data-spy="affix"</code> to the element you want to spy on. Then use offsets to define when to toggle the pinning of an element on and off.</p> + + <pre class="prettyprint linenums"><div data-spy="affix" data-offset-top="200">...</body></pre> + + <div class="alert alert-info"> + <strong>Heads up!</strong> + It's up to you to manage the position of a pinned element. This is done by styling <code>affix</code>, <code>affix-top</code>, and <code>affix-bottom</code>. + </div> + + <h3>Via JavaScript</h3> + <p>Call the affix plugin via JavaScript:</p> + <pre class="prettyprint linenums">$('#navbar').affix()</pre> + + <h3>Methods</h3> + <h4>.affix('refresh')</h4> + <p>When using affix in conjunction with adding or removing of elements from the DOM, you'll want to call the refresh method:</p> +<pre class="prettyprint linenums"> +$('[data-spy="affix"]').each(function () { + $(this).affix('refresh') +}); +</pre> <h3>Options</h3> + <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-offset-top="200"</code>.</p> <table class="table table-bordered table-striped"> <thead> <tr> <th style="width: 100px;">Name</th> - <th style="width: 50px;">type</th> - <th style="width: 100px;">default</th> + <th style="width: 100px;">type</th> + <th style="width: 50px;">default</th> <th>description</th> </tr> </thead> <tbody> - <tr> - <td>source</td> - <td>array</td> - <td>[ ]</td> - <td>The data source to query against.</td> - </tr> - <tr> - <td>items</td> - <td>number</td> - <td>8</td> - <td>The max number of items to display in the dropdown.</td> - </tr> - <tr> - <td>matcher</td> - <td>function</td> - <td>case insensitive</td> - <td>The method used to determine if a query matches an item. Accepts a single argument, the <code>item</code> against which to test the query. Access the current query with <code>this.query</code>. Return a boolean <code>true</code> if query is a match.</td> - </tr> - <tr> - <td>sorter</td> - <td>function</td> - <td>exact match,<br> case sensitive,<br> case insensitive</td> - <td>Method used to sort autocomplete results. Accepts a single argument <code>items</code> and has the scope of the typeahead instance. Reference the current query with <code>this.query</code>.</td> - </tr> <tr> - <td>highlighter</td> - <td>function</td> - <td>highlights all default matches</td> - <td>Method used to highlight autocomplete results. Accepts a single argument <code>item</code> and has the scope of the typeahead instance. Should return html.</td> + <td>offset</td> + <td>number | function | object</td> + <td>10</td> + <td>Pixels to offset from screen when calculating position of scroll. If a single number is provide, the offset will be applied in both top and left directions. To listen for a single direction, or multiple unique offsets, just provided an object <code>offset: { x: 10 }</code>. Use a function when you need to dynamically provide an offset (useful for some responsive designs).</td> </tr> </tbody> </table> + </section> + + - <h3>Markup</h3> - <p>Add data attributes to register an element with typeahead functionality.</p> -<pre class="prettyprint linenums"> -<input type="text" data-provide="typeahead"> -</pre> - <h3>Methods</h3> - <h4>.typeahead(options)</h4> - <p>Initializes an input with a typeahead.</p> - </div> </div> - </section> + </div> - <!-- Footer - ================================================== --> - <footer class="footer"> + </div> + + + + <!-- Footer + ================================================== --> + <footer class="footer"> + <div class="container"> <p class="pull-right"><a href="#">Back to top</a></p> <p>Designed and built with all the love in the world <a href="http://twitter.com/twitter" target="_blank">@twitter</a> by <a href="http://twitter.com/mdo" target="_blank">@mdo</a> and <a href="http://twitter.com/fat" target="_blank">@fat</a>.</p> <p>Code licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0" target="_blank">Apache License v2.0</a>. Documentation licensed under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</p> <p>Icons from <a href="http://glyphicons.com">Glyphicons Free</a>, licensed under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</p> - </footer> - - </div><!-- /container --> + <ul class="footer-links"> + <li><a href="http://blog.getbootstrap.com">Read the blog</a></li> + <li><a href="https://github.com/twitter/bootstrap/issues?state=open">Submit issues</a></li> + <li><a href="https://github.com/twitter/bootstrap/wiki">Roadmap and changelog</a></li> + </ul> + </div> + </footer> @@ -1513,8 +1692,10 @@ $('.carousel').carousel({ <script src="assets/js/bootstrap-collapse.js"></script> <script src="assets/js/bootstrap-carousel.js"></script> <script src="assets/js/bootstrap-typeahead.js"></script> + <script src="assets/js/bootstrap-affix.js"></script> <script src="assets/js/application.js"></script> + </body> </html> |