diff options
| author | Jacob Thornton <[email protected]> | 2012-01-31 13:18:34 -0800 |
|---|---|---|
| committer | Jacob Thornton <[email protected]> | 2012-01-31 13:18:34 -0800 |
| commit | 0bfbe5058d61ae93d82b09f1dff7eb30dc22426e (patch) | |
| tree | 6ccf3dd9c36ff4b1f6cde5edbce21cdf0de78497 /docs/javascript.html | |
| parent | 43cbc9440425b7c97c943690eefd14520de708e1 (diff) | |
| parent | 4bd1ba4e0dc44d1d16161306576548f378ab1f8a (diff) | |
| download | bootstrap-0bfbe5058d61ae93d82b09f1dff7eb30dc22426e.tar.xz bootstrap-0bfbe5058d61ae93d82b09f1dff7eb30dc22426e.zip | |
Merge branch '2.0-wip'
Conflicts:
.gitignore
LICENSE
Makefile
bootstrap.css
bootstrap.min.css
docs/assets/js/application.js
docs/assets/js/google-code-prettify/prettify.css
docs/index.html
docs/javascript.html
examples/container-app.html
examples/fluid.html
examples/hero.html
js/bootstrap-alerts.js
js/bootstrap-dropdown.js
js/bootstrap-modal.js
js/bootstrap-popover.js
js/bootstrap-scrollspy.js
js/bootstrap-tabs.js
js/bootstrap-twipsy.js
js/tests/index.html
js/tests/unit/bootstrap-modal.js
js/tests/unit/bootstrap-popover.js
js/tests/unit/bootstrap-tabs.js
lib/forms.less
lib/mixins.less
lib/patterns.less
lib/scaffolding.less
lib/tables.less
Diffstat (limited to 'docs/javascript.html')
| -rw-r--r-- | docs/javascript.html | 1653 |
1 files changed, 1159 insertions, 494 deletions
diff --git a/docs/javascript.html b/docs/javascript.html index 10d81a0c3..188d26e34 100644 --- a/docs/javascript.html +++ b/docs/javascript.html @@ -3,6 +3,7 @@ <head> <meta charset="utf-8"> <title>Bootstrap, from Twitter</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="description" content=""> <meta name="author" content=""> @@ -11,87 +12,246 @@ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> - <!-- Le javascript --> - <script src="http://code.jquery.com/jquery-1.7.min.js"></script> - <script src="assets/js/google-code-prettify/prettify.js"></script> - <script>$(function () { prettyPrint() })</script> - <script src="../js/bootstrap-modal.js"></script> - <script src="../js/bootstrap-alerts.js"></script> - <script src="../js/bootstrap-twipsy.js"></script> - <script src="../js/bootstrap-popover.js"></script> - <script src="../js/bootstrap-dropdown.js"></script> - <script src="../js/bootstrap-scrollspy.js"></script> - <script src="../js/bootstrap-tabs.js"></script> - <script src="../js/bootstrap-buttons.js"></script> - <!-- Le styles --> - <link href="../bootstrap.css" rel="stylesheet"> + <link href="assets/css/bootstrap.css" rel="stylesheet"> + <link href="assets/css/bootstrap-responsive.css" rel="stylesheet"> <link href="assets/css/docs.css" rel="stylesheet"> <link href="assets/js/google-code-prettify/prettify.css" rel="stylesheet"> <!-- Le fav and touch icons --> - <link rel="shortcut icon" type="image/x-icon" href="assets/ico/favicon.ico"> - <link rel="apple-touch-icon" href="assets/ico/bootstrap-apple-57x57.png"> - <link rel="apple-touch-icon" sizes="72x72" href="assets/ico/bootstrap-apple-72x72.png"> - <link rel="apple-touch-icon" sizes="114x114" href="assets/ico/bootstrap-apple-114x114.png"> + <link rel="shortcut icon" href="assets/ico/favicon.ico"> + <link rel="apple-touch-icon" href="assets/ico/apple-touch-icon.png"> + <link rel="apple-touch-icon" sizes="72x72" href="assets/ico/apple-touch-icon-72x72.png"> + <link rel="apple-touch-icon" sizes="114x114" href="assets/ico/apple-touch-icon-114x114.png"> </head> - <body id="bootstrap-js"> + <body data-spy="scroll" data-target=".subnav" data-offset="50"> + - <!-- Topbar + <!-- Navbar ================================================== --> - <div class="topbar" data-scrollspy="scrollspy" > - <div class="fill"> + <div class="navbar navbar-fixed-top"> + <div class="navbar-inner"> <div class="container"> - <h3><a href="#">Bootstrap JS</a></h3> - <ul> - <li><a href="#overview">Overview</a></li> - <li><a href="#modal">Modals</a></li> - <li><a href="#dropdown">Dropdown</a></li> - <li><a href="#scrollspy">ScrollSpy</a></li> - <li><a href="#buttons">Buttons</a></li> - <li><a href="#tabs">Tabs</a></li> - <li><a href="#twipsy">Twipsy</a></li> - <li><a href="#popover">Popover</a></li> - <li><a href="#alerts">Alerts</a></li> - </ul> + <a 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> + </a> + <a class="brand" href="./index.html">Bootstrap</a> + <div class="nav-collapse"> + <ul class="nav"> + <li class=""> + <a href="./index.html">Overview</a> + </li> + <li class=""> + <a href="./scaffolding.html">Scaffolding</a> + </li> + <li class=""> + <a href="./base-css.html">Base CSS</a> + </li> + <li class=""> + <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> + </li> + <li class="divider-vertical"></li> + <li class=""> + <a href="./download.html">Customize</a> + </li> + <li class=""> + <a href="./examples.html">Examples</a> + </li> + </ul> + </div> </div> </div> </div> - <!-- Masthead (blueprinty thing) - ================================================== --> - <header class="jumbotron subhead" id="overview"> - <div class="inner"> - <div class="container"> - <h1>Javascript for Bootstrap</h1> - <p class="lead"> - Bring Bootstrap's components to life with new, custom plugins that work with <a href="http://jquery.com/" target="_blank">jQuery</a> and <a href="http://ender.no.de" target="_blank">Ender</a>. - </p> - <p><a href="./index.html">← Back to Bootstrap home</a></p> - </div><!-- /container --> - </div> - </header> - <div class="container"> + <!-- 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> + </ul> + </div> + </header> + + + <!-- 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"> + <label> + <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> + </label> + </div> + <div class="span3"> + <label> + <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> + </label> + </div> + <div class="span3"> + <label> + <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> + </label> + </div> + <div class="span3"> + <label> + <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> + </label> + </div> + </div> <!-- /row --> + <div class="row"> + <div class="span3"> + <label> + <h3><a href="./javascript.html#tooltips">Tooltips</a></h3> + <p>A new take on the jQuery Tipsy plugin, Tooltips don't rely on images, uss CSS3 for animations, and data-attributes for local title storage.</p> + </label> + </div> + <div class="span3"> + <label> + <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> + </label> + </div> + <div class="span3"> + <label> + <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> + </label> + </div> + <div class="span3"> + <label> + <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> + </label> + </div> + </div> <!-- /row --> + <div class="row" style="margin-bottom: 9px;"> + <div class="span3"> + <label> + <h3><a href="./javascript.html#collapse">Collapse</a></h3> + <p>Get base styles and flexible support for collapsible components like accordions and navigation.</p> + </label> + </div> + <div class="span3"> + <label> + <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> + </label> + </div> + <div class="span3"> + <label> + <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> + </label> + </div> + <div class="span3"> + <label> + <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> + </label> + </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="modal"> + <section id="modals"> <div class="page-header"> <h1>Modals <small>bootstrap-modal.js</small></h1> </div> <div class="row"> - <div class="span4 columns"> - <p>Our Modal plugin is a super slim take on the traditional modal js plugin, taking special care to include only the bare functionality that we require here at twitter.</p> - <a href="../js/bootstrap-modal.js" target="_blank" class="btn primary">Download</a> + <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="../js/bootstrap-modal.js" target="_blank" class="btn">Download file</a> </div> - <div class="span12 columns"> - <h3>Using bootstrap-modal</h3> - <pre class="prettyprint linenums">$('#my-modal').modal(options)</pre> + <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"> + <div class="modal-header"> + <a href="#" class="close" data-dismiss="modal">×</a> + <h3>Modal header</h3> + </div> + <div class="modal-body"> + <p>One fine body…</p> + </div> + <div class="modal-footer"> + <a href="#" class="btn btn-primary">Save changes</a> + <a href="#" class="btn">Close</a> + </div> + </div> + </div> <!-- /well --> + + <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> + <!-- sample modal content --> + <div id="myModal" class="modal hide fade"> + <div class="modal-header"> + <a class="close" data-dismiss="modal" >×</a> + <h3>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> + + <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> + </div> + <div class="modal-footer"> + <a href="#" class="btn btn-primary">Save changes</a> + <a href="#" class="btn" data-dismiss="modal" >Close</a> + </div> + </div> + <a data-toggle="modal" href="#myModal" class="btn btn-primary btn-large">Launch demo modal</a> + + <hr> + + <h2>Using bootstrap-modal</h2> + <p>Call the modal via javascript:</p> + <pre class="prettyprint linenums">$('#myModal').modal(options)</pre> <h3>Options</h3> - <table class="zebra-striped"> + <table class="table table-bordered table-striped"> <thead> <tr> <th style="width: 100px;">Name</th> @@ -103,53 +263,62 @@ <tbody> <tr> <td>backdrop</td> - <td>boolean, string</td> - <td>false</td> - <td>Includes a modal-backdrop element. Set backdrop to <code>"static"</code> if you do not want the modal closed when the backdrop is clicked.</td> + <td>boolean</td> + <td>true</td> + <td>Includes a modal-backdrop element</td> </tr> <tr> <td>keyboard</td> <td>boolean</td> - <td>false</td> + <td>true</td> <td>Closes the modal when escape key is pressed</td> </tr> - <tr> - <td>show</td> - <td>boolean</td> - <td>false</td> - <td>Opens modal on class initialization</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 give an element a <code>data-controls-modal</code> attribute which corresponds to a modal element id, and when clicked, it will launch your modal. To add modal options, just include them as data attributes as well.</p> + <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-controls-modal="my-modal" data-backdrop="static" >Launch Modal</a> +<a class="btn" data-toggle="modal" href="#myModal" >Launch Modal</a> </pre> - <p><span class="label notice">Notice</span> If you want your modal to animate in and out, just add a <code>.fade</code> class to your <code>.modal</code> element (refer to the demo to see this in action).</p> + +<pre class="prettyprint linenums"> +<div class="modal"> + <div class="modal-header"> + <a class="close" data-dismiss="modal">×</a> + <h3>Modal header</h3> + </div> + <div class="modal-body"> + <p>One fine body…</p> + </div> + <div class="modal-footer"> + <a href="#" class="btn btn-primary">Save changes</a> + <a href="#" class="btn">Close</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>Activates your content as a modal. Accepts an optional options <code>object</code>.</p> <pre class="prettyprint linenums"> -$('#my-modal').modal({ - keyboard: true +$('#myModal').modal({ + keyboard: false })</pre> <h4>.modal('toggle')</h4> <p>Manually toggles a modal.</p> - <pre class="prettyprint linenums">$('#my-modal').modal('toggle')</pre> + <pre class="prettyprint linenums">$('#myModal').modal('toggle')</pre> <h4>.modal('show')</h4> <p>Manually opens a modal.</p> - <pre class="prettyprint linenums">$('#my-modal').modal('show')</pre> + <pre class="prettyprint linenums">$('#myModal').modal('show')</pre> <h4>.modal('hide')</h4> <p>Manually hides a modal.</p> - <pre class="prettyprint linenums">$('#my-modal').modal('hide')</pre> - <h4>.modal(true)</h4> - <p>Returns an elements modal class instance.</p> - <pre class="prettyprint linenums">$('#my-modal').modal(true)</pre> - <p><span class="label notice">Notice</span> Alternatively, this can be retrieved with <code>$().data('modal')</code>.</p> + <pre class="prettyprint linenums">$('#myModal').modal('hide')</pre> <h3>Events</h3> - <p>Bootstrap's modal class exposes a few events for hooking into modal functionality. </p> - <table class="zebra-striped"> + <p>Bootstrap's modal class exposes a few events for hooking into modal functionality.</p> + <table class="table table-bordered table-striped"> <thead> <tr> <th style="width: 150px;">Event</th> @@ -177,215 +346,294 @@ $('#my-modal').modal({ </table> <pre class="prettyprint linenums"> -$('#my-modal').bind('hidden', function () { - // do something ... +$('#myModal').on('hidden', function () { + // do something… })</pre> - <h3>Demo</h3> - <!-- sample modal content --> - <div id="modal-from-dom" class="modal hide fade"> - <div class="modal-header"> - <a href="#" class="close">×</a> - <h3>Modal Heading</h3> - </div> - <div class="modal-body"> - <p>One fine body…</p> - </div> - <div class="modal-footer"> - <a href="#" class="btn primary">Primary</a> - <a href="#" class="btn secondary">Secondary</a> - </div> - </div> - - <button data-controls-modal="modal-from-dom" data-backdrop="true" data-keyboard="true" class="btn danger">Launch Modal</button> </div> </div> </section> + <!-- Dropdown ================================================== --> - - <section id="dropdown"> + <section id="dropdowns"> <div class="page-header"> - <h1>Dropdown <small>bootstrap-dropdown.js</small></h1> + <h1>Dropdowns <small>bootstrap-dropdown.js</small></h1> </div> <div class="row"> - <div class="span4 columns"> - <p>This plugin is for adding dropdown interaction to the bootstrap topbar or tabbed navigations.</p> - <a href="../js/bootstrap-dropdown.js" target="_blank" class="btn primary">Download</a> + <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="../js/bootstrap-dropdown.js" target="_blank" class="btn">Download file</a> </div> - <div class="span12 columns"> - <h3>Using bootstrap-dropdown.js</h3> - <pre class="prettyprint linenums">$('#topbar').dropdown()</pre> + <div class="span9 columns"> + <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> + </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> + </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 nav element, use the <code>data-dropdown</code> attribute. Any valid bootstrap dropdown will automatically be activated.</p> + <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> + <pre class="prettyprint linenums"> -<ul class="tabs"> - <li class="active"><a href="#">Home</a></li> - <li class="dropdown" data-dropdown="dropdown" > - <a href="#" class="dropdown-toggle">Dropdown</a> +<ul class="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="#">Secondary link</a></li> + <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="#">Another link</a></li> + <li><a href="#">Separated link</a></li> </ul> </li> + ... </ul></pre> - <p><span class="label notice">Notice</span> If your ui has several dropdowns, consider adding the <code>data-dropdown</code> attribute to a more significant container element like <code>.tabs</code> or <code>.topbar</code>. <h3>Methods</h3> <h4>$().dropdown()</h4> - <p> - A programatic api for activating menus for a given topbar or tabbed navigation. - </p> - <h3>Demo</h3> - <div class="topbar-wrapper"> - <div id="topbar-example" class="topbar" data-dropdown="dropdown"> - <div class="topbar-inner"> - <div class="container"> - <h3><a href="#">Project Name</a></h3> - <ul> - <li><a href="#">Link</a></li> - <li><a href="#">Link</a></li> - </ul> - <form action=""> - <input type="text" placeholder="Search" /> - </form> - <ul class="nav secondary-nav"> - <li class="menu"> - <a href="#" class="menu">Dropdown 1</a> - <ul class="menu-dropdown"> - <li><a href="#">Secondary link</a></li> - <li><a href="#">Something else here</a></li> - <li class="divider"></li> - <li><a href="#">Another link</a></li> - </ul> - </li> - <li class="menu"> - <a href="#" class="menu">Dropdown 2</a> - <ul class="menu-dropdown"> - <li><a href="#">Secondary link</a></li> - <li><a href="#">Something else here</a></li> - <li class="divider"></li> - <li><a href="#">Another link</a></li> - </ul> - </li> - </ul> - </div> - </div> - </div> - </div> + <p>A programatic api for activating menus for a given navbar or tabbed navigation.</p> </div> </div> </section> + + <!-- ScrollSpy ================================================== --> - <section id="scrollspy"> <div class="page-header"> <h1>ScrollSpy <small>bootstrap-scrollspy.js</small></h1> </div> <div class="row"> - <div class="span4 columns"> - <p>This plugin is for adding the scrollspy (auto updating nav) interaction to the bootstrap topbar.</p> - <a href="../js/bootstrap-scrollspy.js" target="_blank" class="btn primary">Download</a> + <div class="span3 columns"> + <p>The ScrollSpy plugin is for automatically updating nav targets based on scroll position.</p> + <a href="../js/bootstrap-scrollspy.js" target="_blank" class="btn">Download file</a> </div> - <div class="span12 columns"> + <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> + </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> + <hr> <h2>Using bootstrap-scrollspy.js</h2> - <pre class="prettyprint linenums">$('#topbar').scrollSpy()</pre> + <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 nav, just add the <code>data-scrollspy</code> attribute to the <code>.topbar</code>. - <pre class="prettyprint linenums"><div class="topbar" data-scrollspy="scrollspy" >...</div></pre> - <h3>Methods</h3> - <h4>$().scrollSpy()</h4> - <p> - Auto activates navigation buttons by users scroll position. - </p> - <pre class="prettyprint linenums">$('body > .topbar').scrollSpy()</pre> - <p><span class="label notice">Notice</span> Topbar anchor tags 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>. - </p> - <h4>.scrollSpy('refresh')</h4> - <p>The scrollspy caches nav buttons and section coordinates for performance. If you need to update this cache (likely if you have dynamic content) just call this refresh method. If you used the data attribute to define your scrollspy, just call refresh on the body.</p> - <pre class="prettyprint linenums">$('body').scrollSpy('refresh')</pre> - <h3>Demo</h3> - <p>Checkout the the topbar navigation on this page.</p> + <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>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>offset</td> + <td>number</td> + <td>10</td> + <td>Pixels to offset from top when calculating position of scroll.</td> + </tr> + </tbody> + </table> </div> </div> </section> - <!-- Buttons - ================================================== --> - - <section id="buttons"> - <div class="page-header"> - <h1>Buttons <small>bootstrap-buttons.js</small></h1> - </div> - <div class="row"> - <div class="span4 columns"> - <p>This plugin offers additional functionality for managing button state.</p> - <a href="../js/bootstrap-buttons.js" target="_blank" class="btn primary">Download</a> - </div> - <div class="span12 columns"> - <h3>Using bootstrap-buttons.js</h3> - <pre class="prettyprint linenums">$('.tabs').button()</pre> - <h3>Methods</h3> - <h4>$().button('toggle')</h4> - <p>Toggles push state. Gives btn the look that it's been activated.</p> - <p><span class="label notice">Notice</span> You can enable auto toggling of a button by using the <code>data-toggle</code> attribute.</p> - <pre class="prettyprint linenums"><button class="btn" data-toggle="toggle" >...</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> - <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> -<script> - $('.btn').button('complete') -</scrip></pre> - <h3>Demo</h3> - <button id="fat-btn" data-loading-text="loading..." class="btn danger">Loading Demo</button> - <button class="btn" data-toggle="toggle">Toggle Demo</button> - <script> - $(function() { - var btn = $('#fat-btn').click(function () { - btn.button('loading') - setTimeout(function () { - btn.button('reset') - }, 3000) - }) - }) - </script> - </div> - </div> - </section> <!-- Tabs ================================================== --> - <section id="tabs"> <div class="page-header"> - <h1>Tabs <small>bootstrap-tabs.js</small></h1> + <h1>Togglable tabs <small>bootstrap-tab.js</small></h1> </div> <div class="row"> - <div class="span4 columns"> - <p>This plugin adds quick, dynamic tab and pill functionality.</p> - <a href="../js/bootstrap-tabs.js" target="_blank" class="btn primary">Download</a> + <div class="span3 columns"> + <p>This plugin adds quick, dynamic tab and pill functionality for transitioning through local content.</p> + <a href="../js/bootstrap-tab.js" target="_blank" class="btn">Download file</a> </div> - <div class="span12 columns"> - <h3>Using bootstrap-tabs.js</h3> - <pre class="prettyprint linenums">$('.tabs').tabs()</pre> + <div class="span9 columns"> + <h2>Example tabs</h2> + <p>Click the tabs below to toggle between hidden panes, even via dropdown menus.</p> + <ul id="tab" 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> + <hr> + <h2>Using bootstrap-tab.js</h2> + <p>Enable tabbable tabs via javascript:</p> + <pre class="prettyprint linenums">$('#myTab').tab('show')</pre> <h3>Markup</h3> - <p>You can activate a tab or pill navigation without writing any javascript by simply giving them a <code>data-tabs</code> or <code>data-pills</code> attribute.</p> - <pre class="prettyprint linenums"> <ul class="tabs" data-tabs="tabs" >...</ul></pre> + <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.</p> +<pre class="prettyprint linenums"> +<ul class="tabs"> + <li><a href="#home" data-toggle="tab">Home</a></li> + <li><a href="#profile" data-toggle="tab">Profile</a></li> + <li><a href="#messages" data-toggle="tab">Messages</a></li> + <li><a href="#ettings" data-toggle="tab">Settings</a></li> +</ul></pre> <h3>Methods</h3> - <h4>$().tabs or $().pills</h4> + <h4>$().tab</h4> <p> - Activates tab and pill functionality for a given container. Tab links should reference IDs in the document. + Activates a tab element and content container. Tab should have either a `data-target` or an `href` targeting a container node in the dom. </p> <pre class="prettyprint linenums"> <ul class="tabs"> @@ -395,157 +643,105 @@ $('#my-modal').bind('hidden', function () { <li><a href="#settings">Settings</a></li> </ul> -<div class="pill-content"> - <div class="active" id="home">...</div> - <div id="profile">...</div> - <div id="messages">...</div> - <div id="settings">...</div> +<div class="tab-content"> + <div class="tab-pane active" id="home">...</div> + <div class="tab-pane" id="profile">...</div> + <div class="tab-pane" id="messages">...</div> + <div class="tab-pane" id="settings">...</div> </div> <script> $(function () { - $('.tabs').tabs() + $('.tabs a:last').tab('show') }) </script></pre> - </p> - <h3>Events</h3> - <table class="zebra-striped"> - <thead> - <tr> - <th style="width: 150px;">Event</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>change</td> - <td>This event fires on tab change. Use <code>event.target</code> and <code>event.relatedTarget</code> to target the active tab and the previous active tab respectively.</td> - </tr> - </tbody> - </table> - - <pre class="prettyprint linenums"> -$('.tabs a').bind('change', function (e) { + <h3>Events</h3> + <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 on tab show, but before the new tab has been shown. Use <code>event.target</code> and <code>event.relatedTarget</code> to target the active tab and the previous active tab (if available) respectively.</td> + </tr> + <tr> + <td>shown</td> + <td>This event fires on tab show after a tab has been shown. Use <code>event.target</code> and <code>event.relatedTarget</code> to target the active tab and the previous active tab (if available) respectively.</td> + </tr> + </tbody> + </table> + + <pre class="prettyprint linenums"> +$('a[data-toggle="tab"]').on('shown', function (e) { e.target // activated tab e.relatedTarget // previous tab })</pre> - <h3>Demo</h3> - <ul class="tabs" data-tabs="tabs"> - <li class="active"><a href="#home">Home</a></li> - <li><a href="#profile">Profile</a></li> - <li><a href="#messages">Messages</a></li> - <li><a href="#settings">Settings</a></li> - <li class="dropdown" data-dropdown="dropdown"> - <a href="#" class="dropdown-toggle">Dropdown</a> - <ul class="dropdown-menu"> - <li><a href="#fat">@fat</a></li> - <li><a href="#mdo">@mdo</a></li> - </ul> - </li> - </ul> - <div id="my-tab-content" class="tab-content"> - <div class="active tab-pane" 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" 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" id="messages"> - <p>Banksy do proident, brooklyn photo booth delectus sunt artisan sed organic exercitation eiusmod four loko. Quis tattooed iphone esse aliqua. Master cleanse vero fixie mcsweeney's. Ethical portland aute, irony food truck pitchfork lomo eu anim. Aesthetic blog DIY, ethical beard leggings tofu consequat whatever cardigan nostrud. Helvetica you probably haven't heard of them carles, marfa veniam occaecat lomo before they sold out in shoreditch scenester sustainable thundercats. Consectetur tofu craft beer, mollit brunch fap echo park pitchfork mustache dolor.</p> - </div> - <div class="tab-pane" id="settings"> - <p>Sunt qui biodiesel mollit officia, fanny pack put a bird on it thundercats seitan squid ad wolf bicycle rights blog. Et aute readymade farm-to-table carles 8-bit, nesciunt nulla etsy adipisicing organic ea. Master cleanse mollit high life, next level Austin nesciunt american apparel twee mustache adipisicing reprehenderit hoodie portland irony. Aliqua tofu quinoa +1 commodo eiusmod. High life williamsburg cupidatat twee homo leggings. Four loko vinyl DIY consectetur nisi, marfa retro keffiyeh vegan. Fanny pack viral retro consectetur gentrify fap.</p> - </div> - <div class="tab-pane" id="fat"> - <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" id="mdo"> - <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> + </div> </div> </section> - <!-- Tips - ================================================== --> - <section id="twipsy"> + <!-- Tooltips + ================================================== --> + <section id="tooltips"> <div class="page-header"> - <h1>Twipsy <small>bootstrap-twipsy.js</small></h1> + <h1>Tooltips <small>bootstrap-tooltip.js</small></h1> </div> <div class="row"> - <div class="span4 columns"> - <p>Based on the excellent jQuery.tipsy plugin written by Jason Frame; twipsy is an updated version, which doesn't rely on images, uses css3 for animations, and data-attributes for title storage!</p> - <a href="../js/bootstrap-twipsy.js" target="_blank" class="btn primary">Download</a> + <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, uss css3 for animations, and data-attributes for local title storage.</p> + <a href="../js/bootstrap-tooltip.js" target="_blank" class="btn">Download file</a> </div> - <div class="span12 columns"> - <h3>Using bootstrap-twipsy.js</h3> - <pre class="prettyprint linenums">$('#example').twipsy(options)</pre> + <div class="span9 columns"> + <h2>Example use of Tooltips</h2> + <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 <a href="#" rel='tooltip' title='Another one here too'>really ironic</a> artisan whatever keytar, 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> + <pre class="prettyprint linenums">$('#example').tooltip(options)</pre> <h3>Options</h3> - <table class="zebra-striped"> + <table class="table table-bordered table-striped"> <thead> <tr> <th style="width: 100px;">Name</th> - <th style="width: 95px;">type</th> - <th style="width: 95px;">default</th> + <th style="width: 100px;">type</th> + <th style="width: 50px;">default</th> <th>description</th> </tr> </thead> <tbody> <tr> - <td>animate</td> + <td>animation</td> <td>boolean</td> <td>true</td> <td>apply a css fade transition to the tooltip</td> </tr> <tr> - <td>delayIn</td> - <td>number</td> - <td>0</td> - <td>delay before showing tooltip (ms)</td> - </tr> - <tr> - <td>delayOut</td> - <td>number</td> - <td>0</td> - <td>delay before hiding tooltip (ms)</td> - </tr> - <tr> - <td>fallback</td> - <td>string</td> - <td>''</td> - <td>text to use when no tooltip title is present</td> - </tr> - <tr> <td>placement</td> <td>string</td> - <td>'above'</td> - <td>how to position the tooltip - above | below | left | right</td> + <td>'top'</td> + <td>how to position the tooltip - top | bottom | left | right</td> </tr> <tr> - <td>html</td> - <td>boolean</td> - <td>false</td> - <td>allows html content within tooltip</td> - </tr> - <tr> - <td>live</td> - <td>boolean</td> + <td>selector</td> + <td>string</td> <td>false</td> - <td>use event delegation instead of individual event handlers</td> - </tr> - <tr> - <td>offset</td> - <td>number</td> - <td>0</td> - <td>pixel offset of tooltip from target element</td> + <td>If a selector is provided, tooltip objects will be delegated to the specified targets.</td> </tr> <tr> <td>title</td> - <td>string, function</td> - <td>'title'</td> - <td>attribute or method for retrieving title text</td> + <td>string | function</td> + <td>''</td> + <td>default title value if `title` tag isn't present</td> </tr> <tr> <td>trigger</td> @@ -554,147 +750,131 @@ $('.tabs a').bind('change', function (e) { <td>how tooltip is triggered - hover | focus | manual</td> </tr> <tr> - <td>template</td> - <td>string</td> - <td>[default markup]</td> - <td>the html template used for rendering a twipsy</td> + <td>delay</td> + <td>number | object</td> + <td>0</td> + <td> + <p>delay showing and hiding the tooltip (ms)</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> - <p><span class="label notice">Notice</span> Individual twipsy instance options can alternatively be specified through the use of data attributes.</code></p> - <pre class="prettyprint linenums"><a href="#" data-placement="below" rel='twipsy' title='Some title text'>text</a></pre> - <h3>Methods</h3> - <h4>$().twipsy(options)</h4> - <p>Attaches a twipsy handler to an element collection.</p> - <h4>.twipsy('show')</h4> - <p>Reveals an elements twipsy.</p> - <pre class="prettyprint linenums">$('#element').twipsy('show')</pre> - <h4>.twipsy('hide')</h4> - <p>Hides an elements twipsy.</p> - <pre class="prettyprint linenums">$('#element').twipsy('hide')</pre> - <h4>.twipsy(true)</h4> - <p>Returns an elements twipsy class instance.</p> - <pre class="prettyprint linenums">$('#element').twipsy(true)</pre> - <p><span class="label notice">Notice</span> Alternatively, this can be retrieved with <code>$().data('twipsy')</code>.</p> - <h3>Demo</h3> - <div class="well"> - <p class="muted">Tight pants next level keffiyeh <a href="#" rel='twipsy' title='Some title text'>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='twipsy' title='Another twipsy'>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 <a href="#" rel='twipsy' title='Another one here too'>really ironic</a> artisan whatever keytar, scenester farm-to-table banksy Austin <a href="#" rel='twipsy' title='The last tip!'>twitter handle</a> freegan cred raw denim single-origin coffee viral. - </p> + <div class="alert alert-info"> + <strong>Heads up!</strong> + Options for individual tooltips can alternatively be specified through the use of data attributes. </div> - <script> - $(function () { - $("a[rel=twipsy]").twipsy({ - live: true - }) - }) - </script> + <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>$().tooltip(options)</h4> + <p>Attaches a tooltip handler to an element collection.</p> + <h4>.tooltip('show')</h4> + <p>Reveals an elements tooltip.</p> + <pre class="prettyprint linenums">$('#element').tooltip('show')</pre> + <h4>.tooltip('hide')</h4> + <p>Hides an elements tooltip.</p> + <pre class="prettyprint linenums">$('#element').tooltip('hide')</pre> + <h4>.tooltip('toggle')</h4> + <p>Toggles an elements tooltip.</p> + <pre class="prettyprint linenums">$('#element').tooltip('toggle')</pre> </div> </div> </section> + + <!-- Popovers ================================================== --> - - <section id="popover"> + <section id="popovers"> <div class="page-header"> <h1>Popovers <small>bootstrap-popover.js</small></h1> </div> <div class="row"> - <div class="span4 columns"> - <p>The popover plugin provides a simple interface for adding popovers to your application. It extends the <a href="#twipsy">bootstrap-twipsy.js</a> plugin, so be sure to grab that file as well when including popovers in your project!</p> - <p><span class="label notice">Notice</span> You must include the bootstrap-twipsy.js file <strong>before</strong> bootstrap-popover.js.</p> - <a href="../js/bootstrap-popover.js" target="_blank" class="btn primary">Download</a> + <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="#tooltip">Tooltip</a> to be included</p> + <a href="../js/bootstrap-popover.js" target="_blank" class="btn">Download file</a> </div> - <div class="span12 columns"> - <h3>Using bootstrap-popover.js</h3> + <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> + </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="zebra-striped"> + <table class="table table-bordered table-striped"> <thead> <tr> <th style="width: 100px;">Name</th> - <th style="width: 95px;">type</th> - <th style="width: 95px;">default</th> + <th style="width: 100px;">type</th> + <th style="width: 50px;">default</th> <th>description</th> </tr> </thead> <tbody> <tr> - <td>animate</td> + <td>animation</td> <td>boolean</td> <td>true</td> <td>apply a css fade transition to the tooltip</td> </tr> <tr> - <td>delayIn</td> - <td>number</td> - <td>0</td> - <td>delay before showing tooltip (ms)</td> - </tr> - <tr> - <td>delayOut</td> - <td>number</td> - <td>0</td> - <td>delay before hiding tooltip (ms)</td> - </tr> - <tr> - <td>fallback</td> - <td>string</td> - <td>''</td> - <td>text to use when no tooltip title is present</td> - </tr> - <tr> <td>placement</td> <td>string</td> <td>'right'</td> - <td>how to position the tooltip - above | below | left | right</td> - </tr> - <tr> - <td>html</td> - <td>boolean</td> - <td>false</td> - <td>allows html content within tooltip</td> + <td>how to position the popover - top | bottom | left | right</td> </tr> <tr> - <td>live</td> - <td>boolean</td> + <td>selector</td> + <td>string</td> <td>false</td> - <td>use event delegation instead of individual event handlers</td> + <td>if a selector is provided, tooltip objects will be delegated to the specified targets</td> </tr> <tr> - <td>offset</td> - <td>number</td> - <td>0</td> - <td>pixel offset of tooltip from target element</td> + <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>'title'</td> - <td>attribute or method for retrieving title text</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>'data-content'</td> - <td>attribute or method for retrieving content text.</td> - </tr> - <tr> - <td>trigger</td> - <td>string</td> - <td>'hover'</td> - <td>how tooltip is triggered - hover | focus | manual</td> + <td>string | function</td> + <td>''</td> + <td>default content value if `data-content` attribute isn't present</td> </tr> <tr> - <td>template</td> - <td>string</td> - <td>[default markup]</td> - <td>the html template used for rendering a popover</td> + <td>delay</td> + <td>number | object</td> + <td>0</td> + <td> + <p>delay showing and hiding the popover (ms)</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> - <p><span class="label notice">Notice</span> Individual popover instance options can alternatively be specified through the use of data attributes.</code></p> - <pre class="prettyprint linenums"><a data-placement="below" href="#" class="btn danger" rel="popover">text</a></pre> + <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 the selector option. + </p> <h3>Methods</h3> <h4>$().popover(options)</h4> <p>Initializes popovers for an element collection.</p> @@ -704,95 +884,580 @@ $('.tabs a').bind('change', function (e) { <h4>.popover('hide')</h4> <p>Hides an elements popover.</p> <pre class="prettyprint linenums">$('#element').popover('hide')</pre> - <h3>Demo</h3> - <a href="#" class="btn danger" rel="popover" title="A title" data-content="And here's some amazing content. It's very engaging. right?">hover for popover</a> - <script> - $(function () { - $("a[rel=popover]") - .popover({ - offset: 10 - }) - .click(function(e) { - e.preventDefault() - }) - }) - </script> + <h4>.popover('toggle')</h4> + <p>Toggles an elements popover.</p> + <pre class="prettyprint linenums">$('#element').popover('toggle')</pre> </div> </div> </section> - <!-- Alerts - ================================================== --> + <!-- Alert + ================================================== --> <section id="alerts"> <div class="page-header"> - <h1>Alerts <small>bootstrap-alerts.js</small></h1> + <h1>Alert messages <small>bootstrap-alert.js</small></h1> </div> <div class="row"> - <div class="span4 columns"> - <p>The alert plugin is a super tiny class for adding close functionality to alerts.</p> - <a href="../js/bootstrap-alerts.js" target="_blank" class="btn primary">Download</a> + <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="../js/bootstrap-alert.js" target="_blank" class="btn">Download</a> </div> - <div class="span12 columns"> - <h3>Using bootstrap-alerts.js</h3> + <div class="span9 columns"> + <h2>Example alerts</h2> + <p>The alerts plugin works on regular alert messages, and block messages.</p> + <div class="alert fade in"> + <a class="close" data-dismiss="alert" href="#">×</a> + <strong>Holy guacamole!</strong> Best check yo self, you’re not looking too good. + </div> + <div class="alert alert-block alert-error fade in"> + <a class="close" data-dismiss="alert" href="#">×</a> + <h4 class="alert-heading">Oh snap! You got an error!</h4> + <p>Change this and that and try again. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Cras mattis consectetur purus sit amet fermentum.</p> + <p> + <a class="btn btn-danger small" href="#">Take this action</a> <a class="btn small" href="#">Or do this</a> + </p> + </div> + <hr> + <h2>Using bootstrap-alerts.js</h2> + <p>Enable dismissal of an alert via javascript:</p> <pre class="prettyprint linenums">$(".alert-message").alert()</pre> <h3>Markup</h3> - <p>Just add a <code>data-alert</code> attribute to your alert messages to automatically give them close functionality.</p> + <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-message").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> + + + + <!-- 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="../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">$('.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> + +<!-- Add data-toggle="buttons-checkbox" for checkbox style toggling on btn-group --> +<div class="btn-group" data-toggle="buttons-checkbox"> + <button class="btn">Left</button> + <button class="btn">Middle</button> + <button class="btn">Right</button> +</div> + +<!-- Add data-toggle="buttons-radio" for radio style toggling on btn-group --> +<div class="btn-group" data-toggle="buttons-radio"> + <button class="btn">Left</button> + <button class="btn">Middle</button> + <button class="btn">Right</button> +</div> +</pre> + <h3>Methods</h3> + <h4>$().button('toggle')</h4> + <p>Toggles push state. Gives btn the look that it's 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> +<script> + $('.btn').button('complete') +</script></pre> + </div> + </div> + </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="../js/bootstrap-collapse.js" target="_blank" class="btn">Download file</a> + </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> + </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. + </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> + + + <hr> + <h2>Using bootstrap-collapse.js</h2> + <p>Enable via javascript:</p> + <pre class="prettyprint linenums">$(".collapse").collapse()</pre> <h3>Options</h3> - <table class="zebra-striped"> + <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;">type</th> <th style="width: 50px;">default</th> <th>description</th> </tr> </thead> <tbody> <tr> + <td>parent</td> <td>selector</td> - <td>string</td> - <td>'.close'</td> - <td>What selector to target for closing an alert.</td> + <td>false</td> + <td>If selector then all collapsible elements under the specified parent will be closed when this collasabile 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"> + simple collapsible +</button> - <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-message").alert('close')</pre> - <h3>Demo</h3> - <div class="alert-message warning fade in" data-alert="alert" > - <a class="close" href="#">×</a> - <p><strong>Holy guacamole!</strong> Best check yo self, you’re not looking too good.</p> +<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> - <div class="alert-message block-message error fade in" data-alert="alert" > - <a class="close" href="#">×</a> - <p><strong>Oh snap! You got an error!</strong> Change this and that and try again. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Cras mattis consectetur purus sit amet fermentum.</p> - <div class="alert-actions"> - <a class="btn small" href="#">Take this action</a> <a class="btn small" href="#">Or do this</a> + <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 class="prettyprint linenums"> +$('#myCollapsible').on('hidden', function () { + // do something… +})</pre> + </div> + </div> + </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="../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> + </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 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 type to delay between automatically cycling an item.</td> + </tr> + </tbody> + </table> + <h3>Markup</h3> + <p>Data attributes are integral to the carousel plugin. Check out the example code below for the various markup types.</p> +<pre class="prettyprint linenums"> +<div class="carousel"> + <!-- Carousel items --> + <div class="carousel-inner"> + ... + </div> + <!-- Carousel nav --> + <a class="carousel-control left" href="#myCarousel" data-slide="prev">&lsaquo;</a> + <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> +<pre class="prettyprint linenums"> +$('.myCarousel').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 modal class exposes a few events for hooking into modal 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 it's slide transition.</td> + </tr> + </tbody> + </table> + </div> + </div> + </section> + + + + <!-- 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="../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> + <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: 100px;">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> + </tr> + </tbody> + </table> + + <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 typahead.</p> </div> </div> </section> + <!-- Footer + ================================================== --> + <footer class="footer"> + <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 --> - <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>.<br /> - Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0" target="_blank">Apache License v2.0</a>. - </p> - </div> - </footer> + + <!-- Le javascript + ================================================== --> + <!-- Placed at the end of the document so the pages load faster --> + <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> + <script src="../js/tests/vendor/jquery.js"></script> + <script src="assets/js/google-code-prettify/prettify.js"></script> + <script src="../js/bootstrap-transition.js"></script> + <script src="../js/bootstrap-alert.js"></script> + <script src="../js/bootstrap-modal.js"></script> + <script src="../js/bootstrap-dropdown.js"></script> + <script src="../js/bootstrap-scrollspy.js"></script> + <script src="../js/bootstrap-tab.js"></script> + <script src="../js/bootstrap-tooltip.js"></script> + <script src="../js/bootstrap-popover.js"></script> + <script src="../js/bootstrap-button.js"></script> + <script src="../js/bootstrap-collapse.js"></script> + <script src="../js/bootstrap-carousel.js"></script> + <script src="../js/bootstrap-typeahead.js"></script> + <script src="assets/js/application.js"></script> </body> </html> |