mirror of
https://github.com/twbs/bootstrap.git
synced 2024-12-01 13:24:25 +01:00
2695 lines
196 KiB
HTML
2695 lines
196 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<!-- Meta, title, CSS, favicons, etc. -->
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<meta name="description" content="Bootstrap, a sleek, intuitive, and powerful mobile first front-end framework for faster and easier web development.">
|
||
<meta name="keywords" content="HTML, CSS, JS, JavaScript, framework, bootstrap, front-end, frontend, web development">
|
||
<meta name="author" content="Mark Otto, Jacob Thornton, and Bootstrap contributors">
|
||
|
||
<title>
|
||
|
||
JavaScript · Bootstrap
|
||
|
||
</title>
|
||
|
||
<!-- Bootstrap core CSS -->
|
||
|
||
<link href="../dist/css/bootstrap.min.css" rel="stylesheet">
|
||
|
||
|
||
<!-- Optional Bootstrap Theme -->
|
||
|
||
<link href="data:text/css;charset=utf-8," data-href="../dist/css/bootstrap-theme.min.css" rel="stylesheet" id="bs-theme-stylesheet">
|
||
|
||
|
||
|
||
<!-- Documentation extras -->
|
||
|
||
<link href="../assets/css/docs.min.css" rel="stylesheet">
|
||
|
||
<!--[if lt IE 9]><script src="../assets/js/ie8-responsive-file-warning.js"></script><![endif]-->
|
||
<script src="../assets/js/ie-emulation-modes-warning.js"></script>
|
||
|
||
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
|
||
<!--[if lt IE 9]>
|
||
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
|
||
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<!-- Favicons -->
|
||
<link rel="apple-touch-icon" href="/apple-touch-icon.png">
|
||
<link rel="icon" href="/favicon.ico">
|
||
|
||
<script>
|
||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
||
ga('create', 'UA-146052-10', 'getbootstrap.com');
|
||
ga('send', 'pageview');
|
||
</script>
|
||
|
||
</head>
|
||
<body>
|
||
<a id="skippy" class="sr-only sr-only-focusable" href="#content"><div class="container"><span class="skiplink-text">Skip to main content</span></div></a>
|
||
|
||
<!-- Docs master nav -->
|
||
<header class="navbar navbar-static-top bs-docs-nav" id="top" role="banner">
|
||
<div class="container">
|
||
<div class="navbar-header">
|
||
<button class="navbar-toggle collapsed" type="button" data-toggle="collapse" data-target=".bs-navbar-collapse">
|
||
<span class="sr-only">Toggle navigation</span>
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
</button>
|
||
<a href="../" class="navbar-brand">Bootstrap</a>
|
||
</div>
|
||
<nav class="collapse navbar-collapse bs-navbar-collapse">
|
||
<ul class="nav navbar-nav">
|
||
<li>
|
||
<a href="../getting-started/">Getting started</a>
|
||
</li>
|
||
<li>
|
||
<a href="../css/">CSS</a>
|
||
</li>
|
||
<li>
|
||
<a href="../components/">Components</a>
|
||
</li>
|
||
<li class="active">
|
||
<a href="../javascript/">JavaScript</a>
|
||
</li>
|
||
<li>
|
||
<a href="../customize/">Customize</a>
|
||
</li>
|
||
</ul>
|
||
<ul class="nav navbar-nav navbar-right">
|
||
<li><a href="http://expo.getbootstrap.com" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Expo');">Expo</a></li>
|
||
<li><a href="http://blog.getbootstrap.com" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Blog');">Blog</a></li>
|
||
</ul>
|
||
</nav>
|
||
</div>
|
||
</header>
|
||
|
||
|
||
<!-- Docs page layout -->
|
||
<div class="bs-docs-header" id="content">
|
||
<div class="container">
|
||
<h1>JavaScript</h1>
|
||
<p>Bring Bootstrap's components to life with over a dozen custom jQuery plugins. Easily include them all, or one by one.</p>
|
||
<div id="carbonads-container"><div class="carbonad"><div id="azcarbon"></div><script>var z = document.createElement("script"); z.async = true; z.src = "http://engine.carbonads.com/z/32341/azcarbon_2_1_0_HORIZ"; var s = document.getElementsByTagName("script")[0]; s.parentNode.insertBefore(z, s);</script></div></div>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div class="container bs-docs-container">
|
||
|
||
<div class="row">
|
||
<div class="col-md-9" role="main">
|
||
<div class="bs-docs-section">
|
||
<h1 id="js-overview" class="page-header">Overview</h1>
|
||
|
||
<h3 id="js-individual-compiled">Individual or compiled</h3>
|
||
<p>Plugins can be included individually (using Bootstrap's individual <code>*.js</code> files), or all at once (using <code>bootstrap.js</code> or the minified <code>bootstrap.min.js</code>).</p>
|
||
|
||
<div class="bs-callout bs-callout-danger" id="callout-overview-not-both">
|
||
<h4>Using the compiled JavaScript</h4>
|
||
<p>Both <code>bootstrap.js</code> and <code>bootstrap.min.js</code> contain all plugins in a single file. Include only one.</p>
|
||
</div>
|
||
|
||
<div class="bs-callout bs-callout-danger" id="callout-overview-dependencies">
|
||
<h4>Plugin dependencies</h4>
|
||
<p>Some plugins and CSS components depend on other plugins. If you include plugins individually, make sure to check for these dependencies in the docs. Also note that all plugins depend on jQuery (this means jQuery must be included <strong>before</strong> the plugin files). <a href="https://github.com/twbs/bootstrap/blob/v3.3.2/bower.json">Consult our <code>bower.json</code></a> to see which versions of jQuery are supported.</p>
|
||
</div>
|
||
|
||
<h3 id="js-data-attrs">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 document namespaced with <code>data-api</code>. This looks like this:</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="nb">document</span><span class="p">).</span><span class="nx">off</span><span class="p">(</span><span class="s1">'.data-api'</span><span class="p">)</span></code></pre></div>
|
||
|
||
<p>Alternatively, to target a specific plugin, just include the plugin's name as a namespace along with the data-api namespace like this:</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="nb">document</span><span class="p">).</span><span class="nx">off</span><span class="p">(</span><span class="s1">'.alert.data-api'</span><span class="p">)</span></code></pre></div>
|
||
|
||
<div class="bs-callout bs-callout-danger" id="callout-overview-single-data">
|
||
<h4>Only one plugin per element via data attributes</h4>
|
||
<p>Don't use data attributes from multiple plugins on the same element. For example, a button cannot both have a tooltip and toggle a modal. To accomplish this, use a wrapping element.</p>
|
||
</div>
|
||
|
||
<h3 id="js-programmatic-api">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>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'.btn.danger'</span><span class="p">).</span><span class="nx">button</span><span class="p">(</span><span class="s1">'toggle'</span><span class="p">).</span><span class="nx">addClass</span><span class="p">(</span><span class="s1">'fat'</span><span class="p">)</span></code></pre></div>
|
||
|
||
<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>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myModal'</span><span class="p">).</span><span class="nx">modal</span><span class="p">()</span> <span class="c1">// initialized with defaults</span>
|
||
<span class="nx">$</span><span class="p">(</span><span class="s1">'#myModal'</span><span class="p">).</span><span class="nx">modal</span><span class="p">({</span> <span class="na">keyboard</span><span class="p">:</span> <span class="kc">false</span> <span class="p">})</span> <span class="c1">// initialized with no keyboard</span>
|
||
<span class="nx">$</span><span class="p">(</span><span class="s1">'#myModal'</span><span class="p">).</span><span class="nx">modal</span><span class="p">(</span><span class="s1">'show'</span><span class="p">)</span> <span class="c1">// initializes and invokes show immediately</span></code></pre></div>
|
||
|
||
<p>Each plugin also exposes its raw constructor on a <code>Constructor</code> 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>
|
||
|
||
<h4>Default settings</h4>
|
||
<p>You can change the default settings for a plugin by modifying the plugin's <code>Constructor.DEFAULTS</code> object:<p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">.</span><span class="nx">fn</span><span class="p">.</span><span class="nx">modal</span><span class="p">.</span><span class="nx">Constructor</span><span class="p">.</span><span class="nx">DEFAULTS</span><span class="p">.</span><span class="nx">keyboard</span> <span class="o">=</span> <span class="kc">false</span> <span class="c1">// changes default for the modal plugin's `keyboard` option to false</span></code></pre></div>
|
||
|
||
<h3 id="js-noconflict">No conflict</h3>
|
||
<p>Sometimes it is necessary to use Bootstrap plugins with other UI frameworks. In these circumstances, namespace collisions can occasionally occur. If this happens, you may call <code>.noConflict</code> on the plugin you wish to revert the value of.</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="kd">var</span> <span class="nx">bootstrapButton</span> <span class="o">=</span> <span class="nx">$</span><span class="p">.</span><span class="nx">fn</span><span class="p">.</span><span class="nx">button</span><span class="p">.</span><span class="nx">noConflict</span><span class="p">()</span> <span class="c1">// return $.fn.button to previously assigned value</span>
|
||
<span class="nx">$</span><span class="p">.</span><span class="nx">fn</span><span class="p">.</span><span class="nx">bootstrapBtn</span> <span class="o">=</span> <span class="nx">bootstrapButton</span> <span class="c1">// give $().bootstrapBtn the Bootstrap functionality</span></code></pre></div>
|
||
|
||
<h3 id="js-events">Events</h3>
|
||
<p>Bootstrap provides custom events for most plugins' 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 its past participle form (ex. <code>shown</code>) is triggered on the completion of an action.</p>
|
||
<p>As of 3.0.0, all Bootstrap events are namespaced.</p>
|
||
<p>All infinitive events provide <code>preventDefault</code> functionality. This provides the ability to stop the execution of an action before it starts.</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myModal'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'show.bs.modal'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">data</span><span class="p">)</span> <span class="k">return</span> <span class="nx">e</span><span class="p">.</span><span class="nx">preventDefault</span><span class="p">()</span> <span class="c1">// stops modal from being shown</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
|
||
<h3 id="js-version-nums">Version numbers</h3>
|
||
<p>The version of each of Bootstrap's jQuery plugins can be accessed via the <code>VERSION</code> property of the plugin's constructor. For example, for the tooltip plugin:</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">.</span><span class="nx">fn</span><span class="p">.</span><span class="nx">tooltip</span><span class="p">.</span><span class="nx">Constructor</span><span class="p">.</span><span class="nx">VERSION</span> <span class="c1">// => "3.3.2"</span></code></pre></div>
|
||
|
||
<h3 id="js-disabled">No special fallbacks when JavaScript is disabled</h3>
|
||
<p>Bootstrap's plugins don't fall back particularly gracefully when JavaScript is disabled. If you care about the user experience in this case, use <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/noscript"><code><noscript></code></a> to explain the situation (and how to re-enable JavaScript) to your users, and/or add your own custom fallbacks.</p>
|
||
|
||
<div class="bs-callout bs-callout-warning" id="callout-third-party-libs">
|
||
<h4>Third-party libraries</h4>
|
||
<p><strong>Bootstrap does not officially support third-party JavaScript libraries</strong> like Prototype or jQuery UI. Despite <code>.noConflict</code> and namespaced events, there may be compatibility problems that you need to fix on your own.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="bs-docs-section">
|
||
<h1 id="transitions" class="page-header">Transitions <small>transition.js</small></h1>
|
||
|
||
<h3>About transitions</h3>
|
||
<p>For simple transition effects, include <code>transition.js</code> once alongside the other JS files. If you're using the compiled (or minified) <code>bootstrap.js</code>, there is no need to include this—it's already there.</p>
|
||
<h3>What's inside</h3>
|
||
<p>Transition.js is a basic helper for <code>transitionEnd</code> events as well as a CSS transition emulator. It's used by the other plugins to check for CSS transition support and to catch hanging transitions.</p>
|
||
</div>
|
||
|
||
<div class="bs-docs-section">
|
||
<h1 id="modals" class="page-header">Modals <small>modal.js</small></h1>
|
||
<p>Modals are streamlined, but flexible, dialog prompts with the minimum required functionality and smart defaults.</p>
|
||
|
||
<div class="bs-callout bs-callout-warning" id="callout-stacked-modals">
|
||
<h4>Overlapping modals not supported</h4>
|
||
<p>Be sure not to open a modal while another is still visible. Showing more than one modal at a time requires custom code.</p>
|
||
</div>
|
||
<div class="bs-callout bs-callout-warning" id="callout-modal-markup-placement">
|
||
<h4>Modal markup placement</h4>
|
||
<p>Always try to place a modal's HTML code in a top-level position in your document to avoid other components affecting the modal's appearance and/or functionality.</p>
|
||
</div>
|
||
<div class="bs-callout bs-callout-warning" id="callout-modal-mobile-caveats">
|
||
<h4>Mobile device caveats</h4>
|
||
<p>There are some caveats regarding using modals on mobile devices. <a href="../getting-started/#support-fixed-position-keyboards">See our browser support docs</a> for details.</p>
|
||
</div>
|
||
|
||
<p><strong class="text-danger">Due to how HTML5 defines its semantics, the <code>autofocus</code> HTML attribute has no effect in Bootstrap modals.</strong> To achieve the same effect, use some custom JavaScript:</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myModal'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'shown.bs.modal'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
||
<span class="nx">$</span><span class="p">(</span><span class="s1">'#myInput'</span><span class="p">).</span><span class="nx">focus</span><span class="p">()</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
|
||
<h2 id="modals-examples">Examples</h2>
|
||
|
||
<h3>Static example</h3>
|
||
<p>A rendered modal with header, body, and set of actions in the footer.</p>
|
||
<div class="bs-example bs-example-modal" data-example-id="static-modal">
|
||
<div class="modal">
|
||
<div class="modal-dialog">
|
||
<div class="modal-content">
|
||
<div class="modal-header">
|
||
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
||
<h4 class="modal-title">Modal title</h4>
|
||
</div>
|
||
<div class="modal-body">
|
||
<p>One fine body…</p>
|
||
</div>
|
||
<div class="modal-footer">
|
||
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
|
||
<button type="button" class="btn btn-primary">Save changes</button>
|
||
</div>
|
||
</div><!-- /.modal-content -->
|
||
</div><!-- /.modal-dialog -->
|
||
</div><!-- /.modal -->
|
||
</div><!-- /example -->
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal fade"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-dialog"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-content"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-header"</span><span class="nt">></span>
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"close"</span> <span class="na">data-dismiss=</span><span class="s">"modal"</span> <span class="na">aria-label=</span><span class="s">"Close"</span><span class="nt">><span</span> <span class="na">aria-hidden=</span><span class="s">"true"</span><span class="nt">></span><span class="ni">&times;</span><span class="nt"></span></button></span>
|
||
<span class="nt"><h4</span> <span class="na">class=</span><span class="s">"modal-title"</span><span class="nt">></span>Modal title<span class="nt"></h4></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-body"</span><span class="nt">></span>
|
||
<span class="nt"><p></span>One fine body<span class="ni">&hellip;</span><span class="nt"></p></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-footer"</span><span class="nt">></span>
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-default"</span> <span class="na">data-dismiss=</span><span class="s">"modal"</span><span class="nt">></span>Close<span class="nt"></button></span>
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-primary"</span><span class="nt">></span>Save changes<span class="nt"></button></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span><span class="c"><!-- /.modal-content --></span>
|
||
<span class="nt"></div></span><span class="c"><!-- /.modal-dialog --></span>
|
||
<span class="nt"></div></span><span class="c"><!-- /.modal --></span></code></pre></div>
|
||
|
||
<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 fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true">
|
||
<div class="modal-dialog">
|
||
<div class="modal-content">
|
||
|
||
<div class="modal-header">
|
||
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
||
<h4 class="modal-title" id="myModalLabel">Modal title</h4>
|
||
</div>
|
||
<div class="modal-body">
|
||
<h4>Text in a modal</h4>
|
||
<p>Duis mollis, est non commodo luctus, nisi erat porttitor ligula.</p>
|
||
|
||
<h4>Popover in a modal</h4>
|
||
<p>This <a href="#" role="button" class="btn btn-default 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 click.</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>
|
||
|
||
<hr>
|
||
|
||
<h4>Overflowing text to show scroll behavior</h4>
|
||
<p>Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.</p>
|
||
<p>Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.</p>
|
||
<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>
|
||
<p>Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.</p>
|
||
<p>Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.</p>
|
||
<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>
|
||
<p>Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.</p>
|
||
<p>Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.</p>
|
||
<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">
|
||
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
|
||
<button type="button" class="btn btn-primary">Save changes</button>
|
||
</div>
|
||
|
||
</div><!-- /.modal-content -->
|
||
</div><!-- /.modal-dialog -->
|
||
</div><!-- /.modal -->
|
||
|
||
<div class="bs-example" style="padding-bottom: 24px;">
|
||
<button type="button" class="btn btn-primary btn-lg" data-toggle="modal" data-target="#myModal">
|
||
Launch demo modal
|
||
</button>
|
||
</div><!-- /example -->
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="c"><!-- Button trigger modal --></span>
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-primary btn-lg"</span> <span class="na">data-toggle=</span><span class="s">"modal"</span> <span class="na">data-target=</span><span class="s">"#myModal"</span><span class="nt">></span>
|
||
Launch demo modal
|
||
<span class="nt"></button></span>
|
||
|
||
<span class="c"><!-- Modal --></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal fade"</span> <span class="na">id=</span><span class="s">"myModal"</span> <span class="na">tabindex=</span><span class="s">"-1"</span> <span class="na">role=</span><span class="s">"dialog"</span> <span class="na">aria-labelledby=</span><span class="s">"myModalLabel"</span> <span class="na">aria-hidden=</span><span class="s">"true"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-dialog"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-content"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-header"</span><span class="nt">></span>
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"close"</span> <span class="na">data-dismiss=</span><span class="s">"modal"</span> <span class="na">aria-label=</span><span class="s">"Close"</span><span class="nt">><span</span> <span class="na">aria-hidden=</span><span class="s">"true"</span><span class="nt">></span><span class="ni">&times;</span><span class="nt"></span></button></span>
|
||
<span class="nt"><h4</span> <span class="na">class=</span><span class="s">"modal-title"</span> <span class="na">id=</span><span class="s">"myModalLabel"</span><span class="nt">></span>Modal title<span class="nt"></h4></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-body"</span><span class="nt">></span>
|
||
...
|
||
<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-footer"</span><span class="nt">></span>
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-default"</span> <span class="na">data-dismiss=</span><span class="s">"modal"</span><span class="nt">></span>Close<span class="nt"></button></span>
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-primary"</span><span class="nt">></span>Save changes<span class="nt"></button></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span></code></pre></div>
|
||
|
||
<div class="bs-callout bs-callout-warning" id="callout-modal-accessibility">
|
||
<h4>Make modals accessible</h4>
|
||
<p>Be sure to add <code>role="dialog"</code> to <code>.modal</code>, <code>aria-labelledby="myModalLabel"</code> attribute to reference the modal title, and <code>aria-hidden="true"</code> to tell assistive technologies to skip the modal's DOM elements.</p>
|
||
<p>Additionally, you may give a description of your modal dialog with <code>aria-describedby</code> on <code>.modal</code>.</p>
|
||
</div>
|
||
|
||
<div class="bs-callout bs-callout-info" id="callout-modal-youtube">
|
||
<h4>Embedding YouTube videos</h4>
|
||
<p>Embedding YouTube videos in modals requires additional JavaScript not in Bootstrap to automatically stop playback and more. <a href="http://stackoverflow.com/questions/18622508/bootstrap-3-and-youtube-in-modal">See this helpful Stack Overflow post</a> for more information.</p>
|
||
</div>
|
||
|
||
<h2 id="modals-sizes">Optional sizes</h2>
|
||
<p>Modals have two optional sizes, available via modifier classes to be placed on a <code>.modal-dialog</code>.</p>
|
||
<div class="bs-example">
|
||
<button type="button" class="btn btn-primary" data-toggle="modal" data-target=".bs-example-modal-lg">Large modal</button>
|
||
<button type="button" class="btn btn-primary" data-toggle="modal" data-target=".bs-example-modal-sm">Small modal</button>
|
||
</div>
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="c"><!-- Large modal --></span>
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-primary"</span> <span class="na">data-toggle=</span><span class="s">"modal"</span> <span class="na">data-target=</span><span class="s">".bs-example-modal-lg"</span><span class="nt">></span>Large modal<span class="nt"></button></span>
|
||
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal fade bs-example-modal-lg"</span> <span class="na">tabindex=</span><span class="s">"-1"</span> <span class="na">role=</span><span class="s">"dialog"</span> <span class="na">aria-labelledby=</span><span class="s">"myLargeModalLabel"</span> <span class="na">aria-hidden=</span><span class="s">"true"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-dialog modal-lg"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-content"</span><span class="nt">></span>
|
||
...
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span>
|
||
|
||
<span class="c"><!-- Small modal --></span>
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-primary"</span> <span class="na">data-toggle=</span><span class="s">"modal"</span> <span class="na">data-target=</span><span class="s">".bs-example-modal-sm"</span><span class="nt">></span>Small modal<span class="nt"></button></span>
|
||
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal fade bs-example-modal-sm"</span> <span class="na">tabindex=</span><span class="s">"-1"</span> <span class="na">role=</span><span class="s">"dialog"</span> <span class="na">aria-labelledby=</span><span class="s">"mySmallModalLabel"</span> <span class="na">aria-hidden=</span><span class="s">"true"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-dialog modal-sm"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-content"</span><span class="nt">></span>
|
||
...
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span></code></pre></div>
|
||
|
||
<!-- Modal content for the above example -->
|
||
<div class="modal fade bs-example-modal-lg" tabindex="-1" role="dialog" aria-labelledby="myLargeModalLabel" aria-hidden="true">
|
||
<div class="modal-dialog modal-lg">
|
||
<div class="modal-content">
|
||
|
||
<div class="modal-header">
|
||
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
||
<h4 class="modal-title" id="myLargeModalLabel">Large modal</h4>
|
||
</div>
|
||
<div class="modal-body">
|
||
...
|
||
</div>
|
||
</div><!-- /.modal-content -->
|
||
</div><!-- /.modal-dialog -->
|
||
</div><!-- /.modal -->
|
||
<div class="modal fade bs-example-modal-sm" tabindex="-1" role="dialog" aria-labelledby="mySmallModalLabel" aria-hidden="true">
|
||
<div class="modal-dialog modal-sm">
|
||
<div class="modal-content">
|
||
|
||
<div class="modal-header">
|
||
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
||
<h4 class="modal-title" id="mySmallModalLabel">Small modal</h4>
|
||
</div>
|
||
<div class="modal-body">
|
||
...
|
||
</div>
|
||
</div><!-- /.modal-content -->
|
||
</div><!-- /.modal-dialog -->
|
||
</div><!-- /.modal -->
|
||
|
||
<h2 id="modals-remove-animation">Remove animation</h2>
|
||
<p>For modals that simply appear rather than fade in to view, remove the <code>.fade</code> class from your modal markup.</p>
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal"</span> <span class="na">tabindex=</span><span class="s">"-1"</span> <span class="na">role=</span><span class="s">"dialog"</span> <span class="na">aria-labelledby=</span><span class="s">""</span> <span class="na">aria-hidden=</span><span class="s">"true"</span><span class="nt">></span>
|
||
...
|
||
<span class="nt"></div></span></code></pre></div>
|
||
|
||
<h2 id="modals-related-target">Varying modal content based on trigger button</h2>
|
||
<p>Have a bunch of buttons that all trigger the same modal, just with slightly different contents? Use <code>event.relatedTarget</code> and <a href="https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/Using_data_attributes">HTML <code>data-*</code> attributes</a> (possibly <a href="http://api.jquery.com/data/">via jQuery</a>) to vary the contents of the modal depending on which button was clicked. See the Modal Events docs for details on <code>relatedTarget</code>,</p>
|
||
<div class="bs-example" style="padding-bottom: 24px;">
|
||
<button type="button" class="btn btn-primary" data-toggle="modal" data-target="#exampleModal" data-whatever="@mdo">Open modal for @mdo</button>
|
||
<button type="button" class="btn btn-primary" data-toggle="modal" data-target="#exampleModal" data-whatever="@fat">Open modal for @fat</button>
|
||
<button type="button" class="btn btn-primary" data-toggle="modal" data-target="#exampleModal" data-whatever="@getbootstrap">Open modal for @getbootstrap</button>
|
||
...more buttons...
|
||
|
||
<div class="modal fade" id="exampleModal" tabindex="-1" role="dialog" aria-labelledby="exampleModalLabel" aria-hidden="true">
|
||
<div class="modal-dialog">
|
||
<div class="modal-content">
|
||
<div class="modal-header">
|
||
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
||
<h4 class="modal-title" id="exampleModalLabel">New message</h4>
|
||
</div>
|
||
<div class="modal-body">
|
||
<form>
|
||
<div class="form-group">
|
||
<label for="recipient-name" class="control-label">Recipient:</label>
|
||
<input type="text" class="form-control" id="recipient-name">
|
||
</div>
|
||
<div class="form-group">
|
||
<label for="message-text" class="control-label">Message:</label>
|
||
<textarea class="form-control" id="message-text"></textarea>
|
||
</div>
|
||
</form>
|
||
</div>
|
||
<div class="modal-footer">
|
||
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
|
||
<button type="button" class="btn btn-primary">Send message</button>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div><!-- /.modal -->
|
||
</div><!-- /.bs-example -->
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-primary"</span> <span class="na">data-toggle=</span><span class="s">"modal"</span> <span class="na">data-target=</span><span class="s">"#exampleModal"</span> <span class="na">data-whatever=</span><span class="s">"@mdo"</span><span class="nt">></span>Open modal for @mdo<span class="nt"></button></span>
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-primary"</span> <span class="na">data-toggle=</span><span class="s">"modal"</span> <span class="na">data-target=</span><span class="s">"#exampleModal"</span> <span class="na">data-whatever=</span><span class="s">"@fat"</span><span class="nt">></span>Open modal for @fat<span class="nt"></button></span>
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-primary"</span> <span class="na">data-toggle=</span><span class="s">"modal"</span> <span class="na">data-target=</span><span class="s">"#exampleModal"</span> <span class="na">data-whatever=</span><span class="s">"@getbootstrap"</span><span class="nt">></span>Open modal for @getbootstrap<span class="nt"></button></span>
|
||
...more buttons...
|
||
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal fade"</span> <span class="na">id=</span><span class="s">"exampleModal"</span> <span class="na">tabindex=</span><span class="s">"-1"</span> <span class="na">role=</span><span class="s">"dialog"</span> <span class="na">aria-labelledby=</span><span class="s">"exampleModalLabel"</span> <span class="na">aria-hidden=</span><span class="s">"true"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-dialog"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-content"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-header"</span><span class="nt">></span>
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"close"</span> <span class="na">data-dismiss=</span><span class="s">"modal"</span> <span class="na">aria-label=</span><span class="s">"Close"</span><span class="nt">><span</span> <span class="na">aria-hidden=</span><span class="s">"true"</span><span class="nt">></span><span class="ni">&times;</span><span class="nt"></span></button></span>
|
||
<span class="nt"><h4</span> <span class="na">class=</span><span class="s">"modal-title"</span> <span class="na">id=</span><span class="s">"exampleModalLabel"</span><span class="nt">></span>New message<span class="nt"></h4></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-body"</span><span class="nt">></span>
|
||
<span class="nt"><form></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"form-group"</span><span class="nt">></span>
|
||
<span class="nt"><label</span> <span class="na">for=</span><span class="s">"recipient-name"</span> <span class="na">class=</span><span class="s">"control-label"</span><span class="nt">></span>Recipient:<span class="nt"></label></span>
|
||
<span class="nt"><input</span> <span class="na">type=</span><span class="s">"text"</span> <span class="na">class=</span><span class="s">"form-control"</span> <span class="na">id=</span><span class="s">"recipient-name"</span><span class="nt">></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"form-group"</span><span class="nt">></span>
|
||
<span class="nt"><label</span> <span class="na">for=</span><span class="s">"message-text"</span> <span class="na">class=</span><span class="s">"control-label"</span><span class="nt">></span>Message:<span class="nt"></label></span>
|
||
<span class="nt"><textarea</span> <span class="na">class=</span><span class="s">"form-control"</span> <span class="na">id=</span><span class="s">"message-text"</span><span class="nt">></textarea></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></form></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"modal-footer"</span><span class="nt">></span>
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-default"</span> <span class="na">data-dismiss=</span><span class="s">"modal"</span><span class="nt">></span>Close<span class="nt"></button></span>
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-primary"</span><span class="nt">></span>Send message<span class="nt"></button></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span></code></pre></div>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#exampleModal'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'show.bs.modal'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">event</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="kd">var</span> <span class="nx">button</span> <span class="o">=</span> <span class="nx">$</span><span class="p">(</span><span class="nx">event</span><span class="p">.</span><span class="nx">relatedTarget</span><span class="p">)</span> <span class="c1">// Button that triggered the modal</span>
|
||
<span class="kd">var</span> <span class="nx">recipient</span> <span class="o">=</span> <span class="nx">button</span><span class="p">.</span><span class="nx">data</span><span class="p">(</span><span class="s1">'whatever'</span><span class="p">)</span> <span class="c1">// Extract info from data-* attributes</span>
|
||
<span class="c1">// If necessary, you could initiate an AJAX request here (and then do the updating in a callback).</span>
|
||
<span class="c1">// Update the modal's content. We'll use jQuery here, but you could use a data binding library or other methods instead.</span>
|
||
<span class="kd">var</span> <span class="nx">modal</span> <span class="o">=</span> <span class="nx">$</span><span class="p">(</span><span class="k">this</span><span class="p">)</span>
|
||
<span class="nx">modal</span><span class="p">.</span><span class="nx">find</span><span class="p">(</span><span class="s1">'.modal-title'</span><span class="p">).</span><span class="nx">text</span><span class="p">(</span><span class="s1">'New message to '</span> <span class="o">+</span> <span class="nx">recipient</span><span class="p">)</span>
|
||
<span class="nx">modal</span><span class="p">.</span><span class="nx">find</span><span class="p">(</span><span class="s1">'.modal-body input'</span><span class="p">).</span><span class="nx">val</span><span class="p">(</span><span class="nx">recipient</span><span class="p">)</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
|
||
<h2 id="modals-usage">Usage</h2>
|
||
<p>The modal plugin toggles your hidden content on demand, via data attributes or JavaScript. It also adds <code>.modal-open</code> to the <code><body></code> to override default scrolling behavior and generates a <code>.modal-backdrop</code> to provide a click area for dismissing shown modals when clicking outside the modal.</p>
|
||
|
||
<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>
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">data-toggle=</span><span class="s">"modal"</span> <span class="na">data-target=</span><span class="s">"#myModal"</span><span class="nt">></span>Launch modal<span class="nt"></button></span></code></pre></div>
|
||
|
||
<h3>Via JavaScript</h3>
|
||
<p>Call a modal with id <code>myModal</code> with a single line of JavaScript:</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myModal'</span><span class="p">).</span><span class="nx">modal</span><span class="p">(</span><span class="nx">options</span><span class="p">)</span></code></pre></div>
|
||
|
||
<h3 id="modals-options">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>
|
||
<div class="table-responsive">
|
||
<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>backdrop</td>
|
||
<td>boolean or the string <code>'static'</code></td>
|
||
<td>true</td>
|
||
<td>Includes a modal-backdrop element. Alternatively, specify <code>static</code> for a backdrop which doesn't close the modal on click.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>keyboard</td>
|
||
<td>boolean</td>
|
||
<td>true</td>
|
||
<td>Closes the modal when escape key is pressed</td>
|
||
</tr>
|
||
<tr>
|
||
<td>show</td>
|
||
<td>boolean</td>
|
||
<td>true</td>
|
||
<td>Shows the modal when initialized.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>remote</td>
|
||
<td>path</td>
|
||
<td>false</td>
|
||
<td>
|
||
<p><strong class="text-danger">This option is deprecated since v3.3.0 and will be removed in v4.</strong> We recommend instead using client-side templating or a data binding framework, or calling <a href="http://api.jquery.com/load/">jQuery.load</a> yourself.</p>
|
||
<p>If a remote URL is provided, <strong>content will be loaded one time</strong> via jQuery's <code>load</code> method and injected into the <code>.modal-content</code> div. If you're using the data-api, you may alternatively use the <code>href</code> attribute to specify the remote source. An example of this is shown below:</p>
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><a</span> <span class="na">data-toggle=</span><span class="s">"modal"</span> <span class="na">href=</span><span class="s">"remote.html"</span> <span class="na">data-target=</span><span class="s">"#modal"</span><span class="nt">></span>Click me<span class="nt"></a></span></code></pre></div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div><!-- /.table-responsive -->
|
||
|
||
<h3 id="modals-methods">Methods</h3>
|
||
|
||
<h4>.modal(options)</h4>
|
||
<p>Activates your content as a modal. Accepts an optional options <code>object</code>.</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myModal'</span><span class="p">).</span><span class="nx">modal</span><span class="p">({</span>
|
||
<span class="na">keyboard</span><span class="p">:</span> <span class="kc">false</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
|
||
<h4>.modal('toggle')</h4>
|
||
<p>Manually toggles a modal. <strong>Returns to the caller before the modal has actually been shown or hidden</strong> (i.e. before the <code>shown.bs.modal</code> or <code>hidden.bs.modal</code> event occurs).</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myModal'</span><span class="p">).</span><span class="nx">modal</span><span class="p">(</span><span class="s1">'toggle'</span><span class="p">)</span></code></pre></div>
|
||
|
||
<h4>.modal('show')</h4>
|
||
<p>Manually opens a modal. <strong>Returns to the caller before the modal has actually been shown</strong> (i.e. before the <code>shown.bs.modal</code> event occurs).</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myModal'</span><span class="p">).</span><span class="nx">modal</span><span class="p">(</span><span class="s1">'show'</span><span class="p">)</span></code></pre></div>
|
||
|
||
<h4>.modal('hide')</h4>
|
||
<p>Manually hides a modal. <strong>Returns to the caller before the modal has actually been hidden</strong> (i.e. before the <code>hidden.bs.modal</code> event occurs).</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myModal'</span><span class="p">).</span><span class="nx">modal</span><span class="p">(</span><span class="s1">'hide'</span><span class="p">)</span></code></pre></div>
|
||
|
||
<h3 id="modals-events">Events</h3>
|
||
<p>Bootstrap's modal class exposes a few events for hooking into modal functionality.</p>
|
||
<div class="table-responsive">
|
||
<table class="table table-bordered table-striped bs-events-table">
|
||
<thead>
|
||
<tr>
|
||
<th style="width: 150px;">Event Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>show.bs.modal</td>
|
||
<td>This event fires immediately when the <code>show</code> instance method is called. If caused by a click, the clicked element is available as the <code>relatedTarget</code> property of the event.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>shown.bs.modal</td>
|
||
<td>This event is fired when the modal has been made visible to the user (will wait for CSS transitions to complete). If caused by a click, the clicked element is available as the <code>relatedTarget</code> property of the event.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>hide.bs.modal</td>
|
||
<td>This event is fired immediately when the <code>hide</code> instance method has been called.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>hidden.bs.modal</td>
|
||
<td>This event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).</td>
|
||
</tr>
|
||
<tr>
|
||
<td>loaded.bs.modal</td>
|
||
<td>This event is fired when the modal has loaded content using the <code>remote</code> option.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div><!-- /.table-responsive -->
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myModal'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'hidden.bs.modal'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="c1">// do something...</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
</div>
|
||
|
||
<div class="bs-docs-section">
|
||
<h1 id="dropdowns" class="page-header">Dropdowns <small>dropdown.js</small></h1>
|
||
|
||
<h2 id="dropdowns-examples">Examples</h2>
|
||
<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-example">
|
||
<nav id="navbar-example" class="navbar navbar-default navbar-static">
|
||
<div class="container-fluid">
|
||
<div class="navbar-header">
|
||
<button class="navbar-toggle collapsed" type="button" data-toggle="collapse" data-target=".bs-example-js-navbar-collapse">
|
||
<span class="sr-only">Toggle navigation</span>
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
</button>
|
||
<a class="navbar-brand" href="#">Project Name</a>
|
||
</div>
|
||
<div class="collapse navbar-collapse bs-example-js-navbar-collapse">
|
||
<ul class="nav navbar-nav">
|
||
<li class="dropdown">
|
||
<a id="drop1" href="#" class="dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" role="button" aria-expanded="false">
|
||
Dropdown
|
||
<span class="caret"></span>
|
||
</a>
|
||
<ul class="dropdown-menu" role="menu" aria-labelledby="drop1">
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Action</a></li>
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Another action</a></li>
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Something else here</a></li>
|
||
<li role="presentation" class="divider"></li>
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Separated link</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="dropdown">
|
||
<a id="drop2" href="#" class="dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" role="button" aria-expanded="false">
|
||
Dropdown
|
||
<span class="caret"></span>
|
||
</a>
|
||
<ul class="dropdown-menu" role="menu" aria-labelledby="drop2">
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Action</a></li>
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Another action</a></li>
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Something else here</a></li>
|
||
<li role="presentation" class="divider"></li>
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Separated link</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul class="nav navbar-nav navbar-right">
|
||
<li id="fat-menu" class="dropdown">
|
||
<a id="drop3" href="#" class="dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" role="button" aria-expanded="false">
|
||
Dropdown
|
||
<span class="caret"></span>
|
||
</a>
|
||
<ul class="dropdown-menu" role="menu" aria-labelledby="drop3">
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Action</a></li>
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Another action</a></li>
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Something else here</a></li>
|
||
<li role="presentation" class="divider"></li>
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Separated link</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div><!-- /.nav-collapse -->
|
||
</div><!-- /.container-fluid -->
|
||
</nav> <!-- /navbar-example -->
|
||
</div> <!-- /example -->
|
||
|
||
<h3>Within pills</h3>
|
||
<div class="bs-example">
|
||
<ul class="nav nav-pills" role="tablist">
|
||
<li role="presentation" class="active"><a href="#">Regular link</a></li>
|
||
<li role="presentation" class="dropdown">
|
||
<a id="drop4" href="#" class="dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" role="button" aria-expanded="false">
|
||
Dropdown
|
||
<span class="caret"></span>
|
||
</a>
|
||
<ul id="menu1" class="dropdown-menu" role="menu" aria-labelledby="drop4">
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Action</a></li>
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Another action</a></li>
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Something else here</a></li>
|
||
<li role="presentation" class="divider"></li>
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Separated link</a></li>
|
||
</ul>
|
||
</li>
|
||
<li role="presentation" class="dropdown">
|
||
<a id="drop5" href="#" class="dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" role="button" aria-expanded="false">
|
||
Dropdown
|
||
<span class="caret"></span>
|
||
</a>
|
||
<ul id="menu2" class="dropdown-menu" role="menu" aria-labelledby="drop5">
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Action</a></li>
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Another action</a></li>
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Something else here</a></li>
|
||
<li role="presentation" class="divider"></li>
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Separated link</a></li>
|
||
</ul>
|
||
</li>
|
||
<li role="presentation" class="dropdown">
|
||
<a id="drop6" href="#" class="dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" role="button" aria-expanded="false">
|
||
Dropdown
|
||
<span class="caret"></span>
|
||
</a>
|
||
<ul id="menu3" class="dropdown-menu" role="menu" aria-labelledby="drop6">
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Action</a></li>
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Another action</a></li>
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Something else here</a></li>
|
||
<li role="presentation" class="divider"></li>
|
||
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/fat">Separated link</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul> <!-- /pills -->
|
||
</div> <!-- /example -->
|
||
|
||
|
||
<h2 id="dropdowns-usage">Usage</h2>
|
||
<p>Via data attributes or JavaScript, the dropdown plugin toggles hidden content (dropdown menus) by toggling the <code>.open</code> class on the parent list item.</p>
|
||
<p>On mobile devices, opening a dropdown adds a <code>.dropdown-backdrop</code> as a tap area for closing dropdown menus when tapping outside the menu, a requirement for proper iOS support. <strong class="text-danger">This means that switching from an open dropdown menu to a different dropdown menu requires an extra tap on mobile.</strong></p>
|
||
<p>Note: The <code>data-toggle="dropdown"</code> attribute is relied on for closing dropdown menus at an application level, so it's a good idea to always use it.</p>
|
||
|
||
<h3>Via data attributes</h3>
|
||
<p>Add <code>data-toggle="dropdown"</code> to a link or button to toggle a dropdown.</p>
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><div</span> <span class="na">class=</span><span class="s">"dropdown"</span><span class="nt">></span>
|
||
<span class="nt"><button</span> <span class="na">id=</span><span class="s">"dLabel"</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">data-toggle=</span><span class="s">"dropdown"</span> <span class="na">aria-haspopup=</span><span class="s">"true"</span> <span class="na">aria-expanded=</span><span class="s">"false"</span><span class="nt">></span>
|
||
Dropdown trigger
|
||
<span class="nt"><span</span> <span class="na">class=</span><span class="s">"caret"</span><span class="nt">></span></span>
|
||
<span class="nt"></button></span>
|
||
<span class="nt"><ul</span> <span class="na">class=</span><span class="s">"dropdown-menu"</span> <span class="na">role=</span><span class="s">"menu"</span> <span class="na">aria-labelledby=</span><span class="s">"dLabel"</span><span class="nt">></span>
|
||
...
|
||
<span class="nt"></ul></span>
|
||
<span class="nt"></div></span></code></pre></div>
|
||
<p>To keep URLs intact with link buttons, use the <code>data-target</code> attribute instead of <code>href="#"</code>.</p>
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><div</span> <span class="na">class=</span><span class="s">"dropdown"</span><span class="nt">></span>
|
||
<span class="nt"><a</span> <span class="na">id=</span><span class="s">"dLabel"</span> <span class="na">data-target=</span><span class="s">"#"</span> <span class="na">href=</span><span class="s">"http://example.com"</span> <span class="na">data-toggle=</span><span class="s">"dropdown"</span> <span class="na">aria-haspopup=</span><span class="s">"true"</span> <span class="na">role=</span><span class="s">"button"</span> <span class="na">aria-expanded=</span><span class="s">"false"</span><span class="nt">></span>
|
||
Dropdown trigger
|
||
<span class="nt"><span</span> <span class="na">class=</span><span class="s">"caret"</span><span class="nt">></span></span>
|
||
<span class="nt"></a></span>
|
||
|
||
<span class="nt"><ul</span> <span class="na">class=</span><span class="s">"dropdown-menu"</span> <span class="na">role=</span><span class="s">"menu"</span> <span class="na">aria-labelledby=</span><span class="s">"dLabel"</span><span class="nt">></span>
|
||
...
|
||
<span class="nt"></ul></span>
|
||
<span class="nt"></div></span></code></pre></div>
|
||
|
||
<h3>Via JavaScript</h3>
|
||
<p>Call the dropdowns via JavaScript:</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'.dropdown-toggle'</span><span class="p">).</span><span class="nx">dropdown</span><span class="p">()</span></code></pre></div>
|
||
<div class="bs-callout bs-callout-info" id="callout-dropdowns-data-required">
|
||
<h4><code>data-toggle="dropdown"</code> still required</h4>
|
||
<p>Regardless of whether you call your dropdown via JavaScript or instead use the data-api, <code>data-toggle="dropdown"</code> is always required to be present on the dropdown's trigger element.</p>
|
||
</div>
|
||
|
||
<h3 id="dropdowns-options">Options</h3>
|
||
<p><em>None</em></p>
|
||
|
||
<h3 id="dropdowns-methods">Methods</h3>
|
||
<h4>$().dropdown('toggle')</h4>
|
||
<p>Toggles the dropdown menu of a given navbar or tabbed navigation.</p>
|
||
|
||
<h3 id="dropdowns-events">Events</h3>
|
||
<p>All dropdown events are fired at the <code>.dropdown-menu</code>'s parent element.</p>
|
||
<p>All dropdown events have a <code>relatedTarget</code> property, whose value is the toggling anchor element.</p>
|
||
<div class="table-responsive">
|
||
<table class="table table-bordered table-striped bs-events-table">
|
||
<thead>
|
||
<tr>
|
||
<th style="width: 150px;">Event Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>show.bs.dropdown</td>
|
||
<td>This event fires immediately when the show instance method is called.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>shown.bs.dropdown</td>
|
||
<td>This event is fired when the dropdown has been made visible to the user (will wait for CSS transitions, to complete).</td>
|
||
</tr>
|
||
<tr>
|
||
<td>hide.bs.dropdown</td>
|
||
<td>This event is fired immediately when the hide instance method has been called.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>hidden.bs.dropdown</td>
|
||
<td>This event is fired when the dropdown has finished being hidden from the user (will wait for CSS transitions, to complete).</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div><!-- ./bs-table-responsive -->
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myDropdown'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'show.bs.dropdown'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
||
<span class="c1">// do something…</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
</div>
|
||
|
||
<div class="bs-docs-section">
|
||
<h1 id="scrollspy" class="page-header">ScrollSpy <small>scrollspy.js</small></h1>
|
||
|
||
<h2 id="scrollspy-examples">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-example" data-example-id="embedded-scrollspy">
|
||
<nav id="navbar-example2" class="navbar navbar-default navbar-static">
|
||
<div class="container-fluid">
|
||
<div class="navbar-header">
|
||
<button class="navbar-toggle collapsed" type="button" data-toggle="collapse" data-target=".bs-example-js-navbar-scrollspy">
|
||
<span class="sr-only">Toggle navigation</span>
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
</button>
|
||
<a class="navbar-brand" href="#">Project Name</a>
|
||
</div>
|
||
<div class="collapse navbar-collapse bs-example-js-navbar-scrollspy">
|
||
<ul class="nav navbar-nav">
|
||
<li><a href="#fat">@fat</a></li>
|
||
<li><a href="#mdo">@mdo</a></li>
|
||
<li class="dropdown">
|
||
<a href="#" id="navbarDrop1" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Dropdown <span class="caret"></span></a>
|
||
<ul class="dropdown-menu" role="menu" aria-labelledby="navbarDrop1">
|
||
<li><a href="#one" tabindex="-1">one</a></li>
|
||
<li><a href="#two" tabindex="-1">two</a></li>
|
||
<li class="divider"></li>
|
||
<li><a href="#three" tabindex="-1">three</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
<div data-spy="scroll" data-target="#navbar-example2" 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><!-- /example -->
|
||
|
||
|
||
<h2 id="scrollspy-usage">Usage</h2>
|
||
|
||
<div class="bs-callout bs-callout-warning" id="callout-scrollspy-needs-nav">
|
||
<h4>Requires Bootstrap nav</h4>
|
||
<p>Scrollspy currently requires the use of a <a href="../components/#nav">Bootstrap nav component</a> for proper highlighting of active links.</p>
|
||
</div>
|
||
<div class="bs-callout bs-callout-danger" id="callout-scrollspy-target-ids">
|
||
<h4>Resolvable ID targets required</h4>
|
||
<p>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>.</p>
|
||
</div>
|
||
<div class="bs-callout bs-callout-info" id="callout-scrollspy-invisible-targets">
|
||
<h4>Non-<code>:visible</code> target elements ignored</h4>
|
||
<p>Target elements that are not <a href="http://api.jquery.com/visible-selector/"><code>:visible</code> according to jQuery</a> will be ignored and their corresponding nav items will never be highlighted.</p>
|
||
</div>
|
||
|
||
<h3>Requires relative positioning</h3>
|
||
<p>No matter the implementation method, scrollspy requires the use of <code>position: relative;</code> on the element you're spying on. In most cases this is the <code><body></code>.</p>
|
||
|
||
<h3>Via data attributes</h3>
|
||
<p>To easily add scrollspy behavior to your topbar navigation, add <code>data-spy="scroll"</code> to the element you want to spy on (most typically this would be the <code><body></code>). Then add the <code>data-target</code> attribute with the ID or class of the parent element of any Bootstrap <code>.nav</code> component.</p>
|
||
<div class="highlight"><pre><code class="language-css" data-lang="css"><span class="nt">body</span> <span class="p">{</span>
|
||
<span class="nl">position</span><span class="p">:</span> <span class="nb">relative</span><span class="p">;</span>
|
||
<span class="p">}</span></code></pre></div>
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><body</span> <span class="na">data-spy=</span><span class="s">"scroll"</span> <span class="na">data-target=</span><span class="s">".navbar-example"</span><span class="nt">></span>
|
||
...
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"navbar-example"</span><span class="nt">></span>
|
||
<span class="nt"><ul</span> <span class="na">class=</span><span class="s">"nav nav-tabs"</span> <span class="na">role=</span><span class="s">"tablist"</span><span class="nt">></span>
|
||
...
|
||
<span class="nt"></ul></span>
|
||
<span class="nt"></div></span>
|
||
...
|
||
<span class="nt"></body></span></code></pre></div>
|
||
|
||
<h3>Via JavaScript</h3>
|
||
<p>After adding <code>position: relative;</code> in your CSS, call the scrollspy via JavaScript:</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'body'</span><span class="p">).</span><span class="nx">scrollspy</span><span class="p">({</span> <span class="na">target</span><span class="p">:</span> <span class="s1">'.navbar-example'</span> <span class="p">})</span></code></pre></div>
|
||
|
||
|
||
<h3 id="scrollspy-methods">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>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'[data-spy="scroll"]'</span><span class="p">).</span><span class="nx">each</span><span class="p">(</span><span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
||
<span class="kd">var</span> <span class="nx">$spy</span> <span class="o">=</span> <span class="nx">$</span><span class="p">(</span><span class="k">this</span><span class="p">).</span><span class="nx">scrollspy</span><span class="p">(</span><span class="s1">'refresh'</span><span class="p">)</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
|
||
|
||
<h3 id="scrollspy-options">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>
|
||
<div class="table-responsive">
|
||
<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><!-- ./bs-table-responsive -->
|
||
|
||
<h3 id="scrollspy-events">Events</h3>
|
||
<div class="table-responsive">
|
||
<table class="table table-bordered table-striped bs-events-table">
|
||
<thead>
|
||
<tr>
|
||
<th style="width: 150px;">Event Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>activate.bs.scrollspy</td>
|
||
<td>This event fires whenever a new item becomes activated by the scrollspy.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div><!-- ./bs-table-responsive -->
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myScrollspy'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'activate.bs.scrollspy'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
||
<span class="c1">// do something…</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
</div>
|
||
|
||
<div class="bs-docs-section">
|
||
<h1 id="tabs" class="page-header">Togglable tabs <small>tab.js</small></h1>
|
||
|
||
<h2 id="tabs-examples">Example tabs</h2>
|
||
<p>Add quick, dynamic tab functionality to transition through panes of local content, even via dropdown menus.</p>
|
||
<div class="bs-example bs-example-tabs" role="tabpanel" data-example-id="togglable-tabs">
|
||
<ul id="myTab" class="nav nav-tabs" role="tablist">
|
||
<li role="presentation" class="active"><a href="#home" id="home-tab" role="tab" data-toggle="tab" aria-controls="home" aria-expanded="true">Home</a></li>
|
||
<li role="presentation"><a href="#profile" role="tab" id="profile-tab" data-toggle="tab" aria-controls="profile">Profile</a></li>
|
||
<li role="presentation" class="dropdown">
|
||
<a href="#" id="myTabDrop1" class="dropdown-toggle" data-toggle="dropdown" aria-controls="myTabDrop1-contents">Dropdown <span class="caret"></span></a>
|
||
<ul class="dropdown-menu" role="menu" aria-labelledby="myTabDrop1" id="myTabDrop1-contents">
|
||
<li><a href="#dropdown1" tabindex="-1" role="tab" id="dropdown1-tab" data-toggle="tab" aria-controls="dropdown1">@fat</a></li>
|
||
<li><a href="#dropdown2" tabindex="-1" role="tab" id="dropdown2-tab" data-toggle="tab" aria-controls="dropdown2">@mdo</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<div id="myTabContent" class="tab-content">
|
||
<div role="tabpanel" class="tab-pane fade in active" id="home" aria-labelledBy="home-tab">
|
||
<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 role="tabpanel" class="tab-pane fade" id="profile" aria-labelledBy="profile-tab">
|
||
<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 role="tabpanel" class="tab-pane fade" id="dropdown1" aria-labelledBy="dropdown1-tab">
|
||
<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 role="tabpanel" class="tab-pane fade" id="dropdown2" aria-labelledBy="dropdown2-tab">
|
||
<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><!-- /example -->
|
||
|
||
<div class="bs-callout bs-callout-info" id="callout-tabs-extends-component">
|
||
<h4>Extends tabbed navigation</h4>
|
||
<p>This plugin extends the <a href="../components/#nav-tabs">tabbed navigation component</a> to add tabbable areas.</p>
|
||
</div>
|
||
|
||
|
||
<h2 id="tabs-usage">Usage</h2>
|
||
<p>Enable tabbable tabs via JavaScript (each tab needs to be activated individually):</p>
|
||
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myTab a'</span><span class="p">).</span><span class="nx">click</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="nx">e</span><span class="p">.</span><span class="nx">preventDefault</span><span class="p">()</span>
|
||
<span class="nx">$</span><span class="p">(</span><span class="k">this</span><span class="p">).</span><span class="nx">tab</span><span class="p">(</span><span class="s1">'show'</span><span class="p">)</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
|
||
<p>You can activate individual tabs in several ways:</p>
|
||
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myTab a[href="#profile"]'</span><span class="p">).</span><span class="nx">tab</span><span class="p">(</span><span class="s1">'show'</span><span class="p">)</span> <span class="c1">// Select tab by name</span>
|
||
<span class="nx">$</span><span class="p">(</span><span class="s1">'#myTab a:first'</span><span class="p">).</span><span class="nx">tab</span><span class="p">(</span><span class="s1">'show'</span><span class="p">)</span> <span class="c1">// Select first tab</span>
|
||
<span class="nx">$</span><span class="p">(</span><span class="s1">'#myTab a:last'</span><span class="p">).</span><span class="nx">tab</span><span class="p">(</span><span class="s1">'show'</span><span class="p">)</span> <span class="c1">// Select last tab</span>
|
||
<span class="nx">$</span><span class="p">(</span><span class="s1">'#myTab li:eq(2) a'</span><span class="p">).</span><span class="nx">tab</span><span class="p">(</span><span class="s1">'show'</span><span class="p">)</span> <span class="c1">// Select third tab (0-indexed)</span></code></pre></div>
|
||
|
||
<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 <a href="../components/#nav-tabs">tab styling</a>, while adding the <code>nav</code> and <code>nav-pills</code> classes will apply <a href="../components/#nav-pills">pill styling</a>.</p>
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><div</span> <span class="na">role=</span><span class="s">"tabpanel"</span><span class="nt">></span>
|
||
|
||
<span class="c"><!-- Nav tabs --></span>
|
||
<span class="nt"><ul</span> <span class="na">class=</span><span class="s">"nav nav-tabs"</span> <span class="na">role=</span><span class="s">"tablist"</span><span class="nt">></span>
|
||
<span class="nt"><li</span> <span class="na">role=</span><span class="s">"presentation"</span> <span class="na">class=</span><span class="s">"active"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"#home"</span> <span class="na">aria-controls=</span><span class="s">"home"</span> <span class="na">role=</span><span class="s">"tab"</span> <span class="na">data-toggle=</span><span class="s">"tab"</span><span class="nt">></span>Home<span class="nt"></a></li></span>
|
||
<span class="nt"><li</span> <span class="na">role=</span><span class="s">"presentation"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"#profile"</span> <span class="na">aria-controls=</span><span class="s">"profile"</span> <span class="na">role=</span><span class="s">"tab"</span> <span class="na">data-toggle=</span><span class="s">"tab"</span><span class="nt">></span>Profile<span class="nt"></a></li></span>
|
||
<span class="nt"><li</span> <span class="na">role=</span><span class="s">"presentation"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"#messages"</span> <span class="na">aria-controls=</span><span class="s">"messages"</span> <span class="na">role=</span><span class="s">"tab"</span> <span class="na">data-toggle=</span><span class="s">"tab"</span><span class="nt">></span>Messages<span class="nt"></a></li></span>
|
||
<span class="nt"><li</span> <span class="na">role=</span><span class="s">"presentation"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"#settings"</span> <span class="na">aria-controls=</span><span class="s">"settings"</span> <span class="na">role=</span><span class="s">"tab"</span> <span class="na">data-toggle=</span><span class="s">"tab"</span><span class="nt">></span>Settings<span class="nt"></a></li></span>
|
||
<span class="nt"></ul></span>
|
||
|
||
<span class="c"><!-- Tab panes --></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"tab-content"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">role=</span><span class="s">"tabpanel"</span> <span class="na">class=</span><span class="s">"tab-pane active"</span> <span class="na">id=</span><span class="s">"home"</span><span class="nt">></span>...<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">role=</span><span class="s">"tabpanel"</span> <span class="na">class=</span><span class="s">"tab-pane"</span> <span class="na">id=</span><span class="s">"profile"</span><span class="nt">></span>...<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">role=</span><span class="s">"tabpanel"</span> <span class="na">class=</span><span class="s">"tab-pane"</span> <span class="na">id=</span><span class="s">"messages"</span><span class="nt">></span>...<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">role=</span><span class="s">"tabpanel"</span> <span class="na">class=</span><span class="s">"tab-pane"</span> <span class="na">id=</span><span class="s">"settings"</span><span class="nt">></span>...<span class="nt"></div></span>
|
||
<span class="nt"></div></span>
|
||
|
||
<span class="nt"></div></span></code></pre></div>
|
||
|
||
<h3>Fade effect</h3>
|
||
<p>To make tabs fade in, add <code>.fade</code> to each <code>.tab-pane</code>. The first tab pane must also have <code>.in</code> to properly fade in initial content.</p>
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><div</span> <span class="na">class=</span><span class="s">"tab-content"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">role=</span><span class="s">"tabpanel"</span> <span class="na">class=</span><span class="s">"tab-pane fade in active"</span> <span class="na">id=</span><span class="s">"home"</span><span class="nt">></span>...<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">role=</span><span class="s">"tabpanel"</span> <span class="na">class=</span><span class="s">"tab-pane fade"</span> <span class="na">id=</span><span class="s">"profile"</span><span class="nt">></span>...<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">role=</span><span class="s">"tabpanel"</span> <span class="na">class=</span><span class="s">"tab-pane fade"</span> <span class="na">id=</span><span class="s">"messages"</span><span class="nt">></span>...<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">role=</span><span class="s">"tabpanel"</span> <span class="na">class=</span><span class="s">"tab-pane fade"</span> <span class="na">id=</span><span class="s">"settings"</span><span class="nt">></span>...<span class="nt"></div></span>
|
||
<span class="nt"></div></span></code></pre></div>
|
||
|
||
<h3 id="tabs-methods">Methods</h3>
|
||
<h4>$().tab</h4>
|
||
<p>
|
||
Activates a tab element and content container. Tab should have either a <code>data-target</code> or an <code>href</code> targeting a container node in the DOM.
|
||
</p>
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><ul</span> <span class="na">class=</span><span class="s">"nav nav-tabs"</span> <span class="na">role=</span><span class="s">"tablist"</span> <span class="na">id=</span><span class="s">"myTab"</span><span class="nt">></span>
|
||
<span class="nt"><li</span> <span class="na">role=</span><span class="s">"presentation"</span> <span class="na">class=</span><span class="s">"active"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"#home"</span> <span class="na">aria-controls=</span><span class="s">"home"</span> <span class="na">role=</span><span class="s">"tab"</span> <span class="na">data-toggle=</span><span class="s">"tab"</span><span class="nt">></span>Home<span class="nt"></a></li></span>
|
||
<span class="nt"><li</span> <span class="na">role=</span><span class="s">"presentation"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"#profile"</span> <span class="na">aria-controls=</span><span class="s">"profile"</span> <span class="na">role=</span><span class="s">"tab"</span> <span class="na">data-toggle=</span><span class="s">"tab"</span><span class="nt">></span>Profile<span class="nt"></a></li></span>
|
||
<span class="nt"><li</span> <span class="na">role=</span><span class="s">"presentation"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"#messages"</span> <span class="na">aria-controls=</span><span class="s">"messages"</span> <span class="na">role=</span><span class="s">"tab"</span> <span class="na">data-toggle=</span><span class="s">"tab"</span><span class="nt">></span>Messages<span class="nt"></a></li></span>
|
||
<span class="nt"><li</span> <span class="na">role=</span><span class="s">"presentation"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"#settings"</span> <span class="na">aria-controls=</span><span class="s">"settings"</span> <span class="na">role=</span><span class="s">"tab"</span> <span class="na">data-toggle=</span><span class="s">"tab"</span><span class="nt">></span>Settings<span class="nt"></a></li></span>
|
||
<span class="nt"></ul></span>
|
||
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"tab-content"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">role=</span><span class="s">"tabpanel"</span> <span class="na">class=</span><span class="s">"tab-pane active"</span> <span class="na">id=</span><span class="s">"home"</span><span class="nt">></span>...<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">role=</span><span class="s">"tabpanel"</span> <span class="na">class=</span><span class="s">"tab-pane"</span> <span class="na">id=</span><span class="s">"profile"</span><span class="nt">></span>...<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">role=</span><span class="s">"tabpanel"</span> <span class="na">class=</span><span class="s">"tab-pane"</span> <span class="na">id=</span><span class="s">"messages"</span><span class="nt">></span>...<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">role=</span><span class="s">"tabpanel"</span> <span class="na">class=</span><span class="s">"tab-pane"</span> <span class="na">id=</span><span class="s">"settings"</span><span class="nt">></span>...<span class="nt"></div></span>
|
||
<span class="nt"></div></span>
|
||
|
||
<span class="nt"><script></span>
|
||
<span class="nx">$</span><span class="p">(</span><span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
||
<span class="nx">$</span><span class="p">(</span><span class="s1">'#myTab a:last'</span><span class="p">).</span><span class="nx">tab</span><span class="p">(</span><span class="s1">'show'</span><span class="p">)</span>
|
||
<span class="p">})</span>
|
||
<span class="nt"></script></span></code></pre></div>
|
||
|
||
<h3 id="tabs-events">Events</h3>
|
||
<p>When showing a new tab, the events fire in the following order:</p>
|
||
<ol>
|
||
<li><code>hide.bs.tab</code> (on the current active tab)</li>
|
||
<li><code>show.bs.tab</code> (on the to-be-shown tab)</li>
|
||
<li><code>hidden.bs.tab</code> (on the previous active tab, the same one as for the <code>hide.bs.tab</code> event)</li>
|
||
<li><code>shown.bs.tab</code> (on the newly-active just-shown tab, the same one as for the <code>show.bs.tab</code> event)</li>
|
||
</ol>
|
||
<p>If no tab was already active, then the <code>hide.bs.tab</code> and <code>hidden.bs.tab</code> events will not be fired.</p>
|
||
<div class="table-responsive">
|
||
<table class="table table-bordered table-striped bs-events-table">
|
||
<thead>
|
||
<tr>
|
||
<th style="width: 150px;">Event Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>show.bs.tab</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.bs.tab</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>
|
||
<tr>
|
||
<td>hide.bs.tab</td>
|
||
<td>This event fires when a new tab is to be shown (and thus the previous active tab is to be hidden). Use <code>event.target</code> and <code>event.relatedTarget</code> to target the current active tab and the new soon-to-be-active tab, respectively.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>hidden.bs.tab</td>
|
||
<td>This event fires after a new tab is shown (and thus the previous active tab is hidden). Use <code>event.target</code> and <code>event.relatedTarget</code> to target the previous active tab and the new active tab, respectively.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div><!-- /.table-responsive -->
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'a[data-toggle="tab"]'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'shown.bs.tab'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="nx">e</span><span class="p">.</span><span class="nx">target</span> <span class="c1">// newly activated tab</span>
|
||
<span class="nx">e</span><span class="p">.</span><span class="nx">relatedTarget</span> <span class="c1">// previous active tab</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
</div>
|
||
|
||
<div class="bs-docs-section">
|
||
<h1 id="tooltips" class="page-header">Tooltips <small>tooltip.js</small></h1>
|
||
<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>Tooltips with zero-length titles are never displayed.</p>
|
||
|
||
<h2 id="tooltips-examples">Examples</h2>
|
||
<p>Hover over the links below to see tooltips:</p>
|
||
<div class="bs-example tooltip-demo">
|
||
<p>Tight pants next level keffiyeh <a href="#" data-toggle="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="#" data-toggle="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="#" data-toggle="tooltip" title="Another one here too">whatever keytar</a>, scenester farm-to-table banksy Austin <a href="#" data-toggle="tooltip" title="The last tip!">twitter handle</a> freegan cred raw denim single-origin coffee viral.</p>
|
||
</div><!-- /example -->
|
||
|
||
<h3>Static tooltip</h3>
|
||
<p>Four options are available: top, right, bottom, and left aligned.</p>
|
||
<div class="bs-example bs-example-tooltip" data-example-id="static-tooltips">
|
||
<div class="tooltip left" role="tooltip">
|
||
<div class="tooltip-arrow"></div>
|
||
<div class="tooltip-inner">
|
||
Tooltip on the left
|
||
</div>
|
||
</div>
|
||
<div class="tooltip top" role="tooltip">
|
||
<div class="tooltip-arrow"></div>
|
||
<div class="tooltip-inner">
|
||
Tooltip on the top
|
||
</div>
|
||
</div>
|
||
<div class="tooltip bottom" role="tooltip">
|
||
<div class="tooltip-arrow"></div>
|
||
<div class="tooltip-inner">
|
||
Tooltip on the bottom
|
||
</div>
|
||
</div>
|
||
<div class="tooltip right" role="tooltip">
|
||
<div class="tooltip-arrow"></div>
|
||
<div class="tooltip-inner">
|
||
Tooltip on the right
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<h3>Four directions</h3>
|
||
<div class="bs-example tooltip-demo">
|
||
<div class="bs-example-tooltips">
|
||
<button type="button" class="btn btn-default" data-toggle="tooltip" data-placement="left" title="Tooltip on left">Tooltip on left</button>
|
||
<button type="button" class="btn btn-default" data-toggle="tooltip" data-placement="top" title="Tooltip on top">Tooltip on top</button>
|
||
<button type="button" class="btn btn-default" data-toggle="tooltip" data-placement="bottom" title="Tooltip on bottom">Tooltip on bottom</button>
|
||
<button type="button" class="btn btn-default" data-toggle="tooltip" data-placement="right" title="Tooltip on right">Tooltip on right</button>
|
||
</div>
|
||
</div><!-- /example -->
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-default"</span> <span class="na">data-toggle=</span><span class="s">"tooltip"</span> <span class="na">data-placement=</span><span class="s">"left"</span> <span class="na">title=</span><span class="s">"Tooltip on left"</span><span class="nt">></span>Tooltip on left<span class="nt"></button></span>
|
||
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-default"</span> <span class="na">data-toggle=</span><span class="s">"tooltip"</span> <span class="na">data-placement=</span><span class="s">"top"</span> <span class="na">title=</span><span class="s">"Tooltip on top"</span><span class="nt">></span>Tooltip on top<span class="nt"></button></span>
|
||
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-default"</span> <span class="na">data-toggle=</span><span class="s">"tooltip"</span> <span class="na">data-placement=</span><span class="s">"bottom"</span> <span class="na">title=</span><span class="s">"Tooltip on bottom"</span><span class="nt">></span>Tooltip on bottom<span class="nt"></button></span>
|
||
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-default"</span> <span class="na">data-toggle=</span><span class="s">"tooltip"</span> <span class="na">data-placement=</span><span class="s">"right"</span> <span class="na">title=</span><span class="s">"Tooltip on right"</span><span class="nt">></span>Tooltip on right<span class="nt"></button></span></code></pre></div>
|
||
|
||
<div class="bs-callout bs-callout-danger" id="callout-tooltip-opt-in">
|
||
<h4>Opt-in functionality</h4>
|
||
<p>For performance reasons, the Tooltip and Popover data-apis are opt-in, meaning <strong>you must initialize them yourself</strong>.</p>
|
||
<p>One way to initialize all tooltips on a page would be to select them by their <code>data-toggle</code> attribute:</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
||
<span class="nx">$</span><span class="p">(</span><span class="s1">'[data-toggle="tooltip"]'</span><span class="p">).</span><span class="nx">tooltip</span><span class="p">()</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
|
||
</div>
|
||
<div class="bs-callout bs-callout-warning" id="callout-tooltip-groups">
|
||
<h4>Tooltips in button groups and input groups require special setting</h4>
|
||
<p>When using tooltips on elements within a <code>.btn-group</code> or an <code>.input-group</code>, you'll have to specify the option <code>container: 'body'</code> (documented below) to avoid unwanted side effects (such as the element growing wider and/or losing its rounded corners when the tooltip is triggered).</p>
|
||
</div>
|
||
<div class="bs-callout bs-callout-warning" id="callout-tooltip-hidden">
|
||
<h4>Don't try to show tooltips on hidden elements</h4>
|
||
<p>Invoking <code>$(...).tooltip('show')</code> when the target element is <code>display: none;</code> will cause the tooltip to be incorrectly positioned.</p>
|
||
</div>
|
||
<div class="bs-callout bs-callout-info" id="callout-tooltip-disabled">
|
||
<h4>Tooltips on disabled elements require wrapper elements</h4>
|
||
<p>To add a tooltip to a <code>disabled</code> or <code>.disabled</code> element, put the element inside of a <code><div></code> and apply the tooltip to that <code><div></code> instead.</p>
|
||
</div>
|
||
|
||
<h2 id="tooltips-usage">Usage</h2>
|
||
<p>The tooltip plugin generates content and markup on demand, and by default places tooltips after their trigger element.</p>
|
||
<p>Trigger the tooltip via JavaScript:</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#example'</span><span class="p">).</span><span class="nx">tooltip</span><span class="p">(</span><span class="nx">options</span><span class="p">)</span></code></pre></div>
|
||
|
||
<h3>Markup</h3>
|
||
<p>The required markup for a tooltip is only a <code>data</code> attribute and <code>title</code> on the HTML element you wish to have a tooltip. The generated markup of a tooltip is rather simple, though it does require a position (by default, set to <code>top</code> by the plugin).</p>
|
||
<div class="bs-callout bs-callout-warning" id="callout-tooltip-multiline">
|
||
<h4>Multiple-line links</h4>
|
||
<p>Sometimes you want to add a tooltip to a hyperlink that wraps multiple lines. The default behavior of the tooltip plugin is to center it horizontally and vertically. Add <code>white-space: nowrap;</code> to your anchors to avoid this.</p>
|
||
</div>
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="c"><!-- HTML to write --></span>
|
||
<span class="nt"><a</span> <span class="na">href=</span><span class="s">"#"</span> <span class="na">data-toggle=</span><span class="s">"tooltip"</span> <span class="na">title=</span><span class="s">"Some tooltip text!"</span><span class="nt">></span>Hover over me<span class="nt"></a></span>
|
||
|
||
<span class="c"><!-- Generated markup by the plugin --></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"tooltip top"</span> <span class="na">role=</span><span class="s">"tooltip"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"tooltip-arrow"</span><span class="nt">></div></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"tooltip-inner"</span><span class="nt">></span>
|
||
Some tooltip text!
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span></code></pre></div>
|
||
|
||
<h3 id="tooltips-options">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>
|
||
<div class="table-responsive">
|
||
<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>container</td>
|
||
<td>string | false</td>
|
||
<td>false</td>
|
||
<td>
|
||
<p>Appends the tooltip to a specific element. Example: <code>container: 'body'</code>. This option is particularly useful in that it allows you to position the tooltip in the flow of the document near the triggering element - which will prevent the tooltip from floating away from the triggering element during a window resize.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>delay</td>
|
||
<td>number | object</td>
|
||
<td>0</td>
|
||
<td>
|
||
<p>Delay showing and hiding the tooltip (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>
|
||
<tr>
|
||
<td>html</td>
|
||
<td>boolean</td>
|
||
<td>false</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>
|
||
<td>
|
||
<p>How to position the tooltip - top | bottom | left | right | auto.<br>When "auto" is specified, it will dynamically reorient the tooltip. For example, if placement is "auto left", the tooltip will display to the left when possible, otherwise it will display right.</p>
|
||
<p>When a function is used to determine the placement, it is called with the tooltip DOM node as its first argument and the triggering element DOM node as its second. The <code>this</code> context is set to the tooltip instance.</p>
|
||
</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. In practice, this is used to enable dynamic HTML content to have tooltips added. See <a href="https://github.com/twbs/bootstrap/issues/4215">this</a> and <a href="http://jsbin.com/zopod/1/edit">an informative example</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>template</td>
|
||
<td>string</td>
|
||
<td><code>'<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>'</code></td>
|
||
<td>
|
||
<p>Base HTML to use when creating the tooltip.</p>
|
||
<p>The tooltip's <code>title</code> will be injected into the <code>.tooltip-inner</code>.</p>
|
||
<p><code>.tooltip-arrow</code> will become the tooltip's arrow.</p>
|
||
<p>The outermost wrapper element should have the <code>.tooltip</code> class.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>title</td>
|
||
<td>string | function</td>
|
||
<td>''</td>
|
||
<td>
|
||
<p>Default title value if <code>title</code> attribute isn't present.</p>
|
||
<p>If a function is given, it will be called with its <code>this</code> reference set to the element that the tooltip is attached to.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>trigger</td>
|
||
<td>string</td>
|
||
<td>'hover focus'</td>
|
||
<td>How tooltip is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>viewport</td>
|
||
<td>string | object</td>
|
||
<td>{ selector: 'body', padding: 0 }</td>
|
||
<td>
|
||
<p>Keeps the tooltip within the bounds of this element. Example: <code>viewport: '#viewport'</code> or <code>{ "selector": "#viewport", "padding": 0 }</code></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div><!-- /.table-responsive -->
|
||
<div class="bs-callout bs-callout-info" id="callout-tooltip-data">
|
||
<h4>Data attributes for individual tooltips</h4>
|
||
<p>Options for individual tooltips can alternatively be specified through the use of data attributes, as explained above.</p>
|
||
</div>
|
||
|
||
<h3 id="tooltips-methods">Methods</h3>
|
||
|
||
<h4>$().tooltip(options)</h4>
|
||
<p>Attaches a tooltip handler to an element collection.</p>
|
||
|
||
<h4>.tooltip('show')</h4>
|
||
<p>Reveals an element's tooltip. <strong>Returns to the caller before the tooltip has actually been shown</strong> (i.e. before the <code>shown.bs.tooltip</code> event occurs). This is considered a "manual" triggering of the tooltip. Tooltips with zero-length titles are never displayed.</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">tooltip</span><span class="p">(</span><span class="s1">'show'</span><span class="p">)</span></code></pre></div>
|
||
|
||
<h4>.tooltip('hide')</h4>
|
||
<p>Hides an element's tooltip. <strong>Returns to the caller before the tooltip has actually been hidden</strong> (i.e. before the <code>hidden.bs.tooltip</code> event occurs). This is considered a "manual" triggering of the tooltip.</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">tooltip</span><span class="p">(</span><span class="s1">'hide'</span><span class="p">)</span></code></pre></div>
|
||
|
||
<h4>.tooltip('toggle')</h4>
|
||
<p>Toggles an element's tooltip. <strong>Returns to the caller before the tooltip has actually been shown or hidden</strong> (i.e. before the <code>shown.bs.tooltip</code> or <code>hidden.bs.tooltip</code> event occurs). This is considered a "manual" triggering of the tooltip.</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">tooltip</span><span class="p">(</span><span class="s1">'toggle'</span><span class="p">)</span></code></pre></div>
|
||
|
||
<h4>.tooltip('destroy')</h4>
|
||
<p>Hides and destroys an element's tooltip.</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">tooltip</span><span class="p">(</span><span class="s1">'destroy'</span><span class="p">)</span></code></pre></div>
|
||
|
||
<h3 id="tooltips-events">Events</h3>
|
||
<div class="table-responsive">
|
||
<table class="table table-bordered table-striped bs-events-table">
|
||
<thead>
|
||
<tr>
|
||
<th style="width: 150px;">Event Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>show.bs.tooltip</td>
|
||
<td>This event fires immediately when the <code>show</code> instance method is called.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>shown.bs.tooltip</td>
|
||
<td>This event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete).</td>
|
||
</tr>
|
||
<tr>
|
||
<td>hide.bs.tooltip</td>
|
||
<td>This event is fired immediately when the <code>hide</code> instance method has been called.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>hidden.bs.tooltip</td>
|
||
<td>This event is fired when the tooltip has finished being hidden from the user (will wait for CSS transitions to complete).</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div><!-- /.table-responsive -->
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myTooltip'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'hidden.bs.tooltip'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
||
<span class="c1">// do something…</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
</div>
|
||
|
||
<div class="bs-docs-section">
|
||
<h1 id="popovers" class="page-header">Popovers <small>popover.js</small></h1>
|
||
|
||
<p>Add small overlays of content, like those on the iPad, to any element for housing secondary information.</p>
|
||
<p>Popovers whose both title and content are zero-length are never displayed.</p>
|
||
|
||
<div class="bs-callout bs-callout-danger" id="callout-popover-needs-tooltip">
|
||
<h4>Plugin dependency</h4>
|
||
<p>Popovers require the <a href="#tooltips">tooltip plugin</a> to be included in your version of Bootstrap.</p>
|
||
</div>
|
||
<div class="bs-callout bs-callout-danger" id="callout-popover-opt-in">
|
||
<h4>Opt-in functionality</h4>
|
||
<p>For performance reasons, the Tooltip and Popover data-apis are opt-in, meaning <strong>you must initialize them yourself</strong>.</p>
|
||
<p>One way to initialize all popovers on a page would be to select them by their <code>data-toggle</code> attribute:</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
||
<span class="nx">$</span><span class="p">(</span><span class="s1">'[data-toggle="popover"]'</span><span class="p">).</span><span class="nx">popover</span><span class="p">()</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
</div>
|
||
<div class="bs-callout bs-callout-warning" id="callout-popover-groups">
|
||
<h4>Popovers in button groups and input groups require special setting</h4>
|
||
<p>When using popovers on elements within a <code>.btn-group</code> or an <code>.input-group</code>, you'll have to specify the option <code>container: 'body'</code> (documented below) to avoid unwanted side effects (such as the element growing wider and/or losing its rounded corners when the popover is triggered).</p>
|
||
</div>
|
||
<div class="bs-callout bs-callout-warning" id="callout-popover-hidden">
|
||
<h4>Don't try to show popovers on hidden elements</h4>
|
||
<p>Invoking <code>$(...).popover('show')</code> when the target element is <code>display: none;</code> will cause the popover to be incorrectly positioned.</p>
|
||
</div>
|
||
<div class="bs-callout bs-callout-info" id="callout-popover-disabled">
|
||
<h4>Popovers on disabled elements require wrapper elements</h4>
|
||
<p>To add a popover to a <code>disabled</code> or <code>.disabled</code> element, put the element inside of a <code><div></code> and apply the popover to that <code><div></code> instead.</p>
|
||
</div>
|
||
<div class="bs-callout bs-callout-info" id="callout-popover-multiline">
|
||
<h4>Multiple-line links</h4>
|
||
<p>Sometimes you want to add a popover to a hyperlink that wraps multiple lines. The default behavior of the popover plugin is to center it horizontally and vertically. Add <code>white-space: nowrap;</code> to your anchors to avoid this.</p>
|
||
</div>
|
||
|
||
<h2 id="popovers-examples">Examples</h2>
|
||
<h3>Static popover</h3>
|
||
<p>Four options are available: top, right, bottom, and left aligned.</p>
|
||
<div class="bs-example bs-example-popover" data-example-id="static-popovers">
|
||
<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>
|
||
|
||
<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>
|
||
|
||
<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>
|
||
|
||
<h3>Live demo</h3>
|
||
<div class="bs-example" style="padding-bottom: 24px;">
|
||
<button type="button" class="btn btn-lg btn-danger bs-docs-popover" data-toggle="popover" title="Popover title" data-content="And here's some amazing content. It's very engaging. Right?">Click to toggle popover</button>
|
||
</div>
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-lg btn-danger"</span> <span class="na">data-toggle=</span><span class="s">"popover"</span> <span class="na">title=</span><span class="s">"Popover title"</span> <span class="na">data-content=</span><span class="s">"And here's some amazing content. It's very engaging. Right?"</span><span class="nt">></span>Click to toggle popover<span class="nt"></button></span></code></pre></div>
|
||
|
||
<h4>Four directions</h4>
|
||
<div class="bs-example popover-demo">
|
||
<div class="bs-example-popovers">
|
||
<button type="button" class="btn btn-default" data-container="body" data-toggle="popover" data-placement="left" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
|
||
Popover on left
|
||
</button>
|
||
<button type="button" class="btn btn-default" data-container="body" data-toggle="popover" data-placement="top" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
|
||
Popover on top
|
||
</button>
|
||
<button type="button" class="btn btn-default" data-container="body" data-toggle="popover" data-placement="bottom" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
|
||
Popover on bottom
|
||
</button>
|
||
<button type="button" class="btn btn-default" data-container="body" data-toggle="popover" data-placement="right" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
|
||
Popover on right
|
||
</button>
|
||
</div>
|
||
</div><!-- /example -->
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-default"</span> <span class="na">data-container=</span><span class="s">"body"</span> <span class="na">data-toggle=</span><span class="s">"popover"</span> <span class="na">data-placement=</span><span class="s">"left"</span> <span class="na">data-content=</span><span class="s">"Vivamus sagittis lacus vel augue laoreet rutrum faucibus."</span><span class="nt">></span>
|
||
Popover on left
|
||
<span class="nt"></button></span>
|
||
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-default"</span> <span class="na">data-container=</span><span class="s">"body"</span> <span class="na">data-toggle=</span><span class="s">"popover"</span> <span class="na">data-placement=</span><span class="s">"top"</span> <span class="na">data-content=</span><span class="s">"Vivamus sagittis lacus vel augue laoreet rutrum faucibus."</span><span class="nt">></span>
|
||
Popover on top
|
||
<span class="nt"></button></span>
|
||
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-default"</span> <span class="na">data-container=</span><span class="s">"body"</span> <span class="na">data-toggle=</span><span class="s">"popover"</span> <span class="na">data-placement=</span><span class="s">"bottom"</span> <span class="na">data-content=</span><span class="s">"Vivamus
|
||
sagittis lacus vel augue laoreet rutrum faucibus."</span><span class="nt">></span>
|
||
Popover on bottom
|
||
<span class="nt"></button></span>
|
||
|
||
<span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-default"</span> <span class="na">data-container=</span><span class="s">"body"</span> <span class="na">data-toggle=</span><span class="s">"popover"</span> <span class="na">data-placement=</span><span class="s">"right"</span> <span class="na">data-content=</span><span class="s">"Vivamus sagittis lacus vel augue laoreet rutrum faucibus."</span><span class="nt">></span>
|
||
Popover on right
|
||
<span class="nt"></button></span></code></pre></div>
|
||
|
||
<h4>Dismiss on next click</h4>
|
||
<p>Use the <code>focus</code> trigger to dismiss popovers on the next click that the user makes.</p>
|
||
<div class="bs-callout bs-callout-danger" id="callout-popover-dismiss-click">
|
||
<h4>Specific markup required for dismiss-on-next-click</h4>
|
||
<p>For proper cross-browser and cross-platform behavior, you must use the <code><a></code> tag, <i>not</i> the <code><button></code> tag, and you also must include a <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes#tabindex"><code>tabindex</code></a> attribute.</p>
|
||
</div>
|
||
<div class="bs-example" style="padding-bottom: 24px;">
|
||
<a tabindex="0" class="btn btn-lg btn-danger bs-docs-popover" role="button" data-toggle="popover" data-trigger="focus" title="Dismissible popover" data-content="And here's some amazing content. It's very engaging. Right?">Dismissible popover</a>
|
||
</div>
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><a</span> <span class="na">tabindex=</span><span class="s">"0"</span> <span class="na">class=</span><span class="s">"btn btn-lg btn-danger"</span> <span class="na">role=</span><span class="s">"button"</span> <span class="na">data-toggle=</span><span class="s">"popover"</span> <span class="na">data-trigger=</span><span class="s">"focus"</span> <span class="na">title=</span><span class="s">"Dismissible popover"</span> <span class="na">data-content=</span><span class="s">"And here's some amazing content. It's very engaging. Right?"</span><span class="nt">></span>Dismissible popover<span class="nt"></a></span></code></pre></div>
|
||
|
||
|
||
<h2 id="popovers-usage">Usage</h2>
|
||
<p>Enable popovers via JavaScript:</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#example'</span><span class="p">).</span><span class="nx">popover</span><span class="p">(</span><span class="nx">options</span><span class="p">)</span></code></pre></div>
|
||
|
||
<h3 id="popovers-options">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>
|
||
<div class="table-responsive">
|
||
<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 popover</td>
|
||
</tr>
|
||
<tr>
|
||
<td>container</td>
|
||
<td>string | false</td>
|
||
<td>false</td>
|
||
<td>
|
||
<p>Appends the popover to a specific element. Example: <code>container: 'body'</code>. This option is particularly useful in that it allows you to position the popover in the flow of the document near the triggering element - which will prevent the popover from floating away from the triggering element during a window resize.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>content</td>
|
||
<td>string | function</td>
|
||
<td>''</td>
|
||
<td>
|
||
<p>Default content value if <code>data-content</code> attribute isn't present.</p>
|
||
<p>If a function is given, it will be called with its <code>this</code> reference set to the element that the popover is attached to.</p>
|
||
</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>
|
||
<tr>
|
||
<td>html</td>
|
||
<td>boolean</td>
|
||
<td>false</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>
|
||
<p>How to position the popover - top | bottom | left | right | auto.<br>When "auto" is specified, it will dynamically reorient the popover. For example, if placement is "auto left", the popover will display to the left when possible, otherwise it will display right.</p>
|
||
<p>When a function is used to determine the placement, it is called with the popover DOM node as its first argument and the triggering element DOM node as its second. The <code>this</code> context is set to the popover instance.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>selector</td>
|
||
<td>string</td>
|
||
<td>false</td>
|
||
<td>If a selector is provided, popover objects will be delegated to the specified targets. In practice, this is used to enable dynamic HTML content to have popovers added. See <a href="https://github.com/twbs/bootstrap/issues/4215">this</a> and <a href="http://jsbin.com/zopod/1/edit">an informative example</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>template</td>
|
||
<td>string</td>
|
||
<td><code>'<div class="popover" role="tooltip"><div class="arrow"></div><h3 class="popover-title"></h3><div class="popover-content"></div></div>'</code></td>
|
||
<td>
|
||
<p>Base HTML to use when creating the popover.</p>
|
||
<p>The popover's <code>title</code> will be injected into the <code>.popover-title</code>.</p>
|
||
<p>The popover's <code>content</code> will be injected into the <code>.popover-content</code>.</p>
|
||
<p><code>.arrow</code> will become the popover's arrow.</p>
|
||
<p>The outermost wrapper element should have the <code>.popover</code> class.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>title</td>
|
||
<td>string | function</td>
|
||
<td>''</td>
|
||
<td>
|
||
<p>Default title value if <code>title</code> attribute isn't present.</p>
|
||
<p>If a function is given, it will be called with its <code>this</code> reference set to the element that the popover is attached to.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>trigger</td>
|
||
<td>string</td>
|
||
<td>'click'</td>
|
||
<td>How popover is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>viewport</td>
|
||
<td>string | object</td>
|
||
<td>{ selector: 'body', padding: 0 }</td>
|
||
<td>
|
||
<p>Keeps the popover within the bounds of this element. Example: <code>viewport: '#viewport'</code> or <code>{ "selector": "#viewport", "padding": 0 }</code></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div><!-- /.table-responsive -->
|
||
<div class="bs-callout bs-callout-info" id="callout-popover-data">
|
||
<h4>Data attributes for individual popovers</h4>
|
||
<p>Options for individual popovers can alternatively be specified through the use of data attributes, as explained above.</p>
|
||
</div>
|
||
|
||
<h3>Methods</h3>
|
||
<h4>$().popover(options)</h4>
|
||
<p>Initializes popovers for an element collection.</p>
|
||
|
||
<h4>.popover('show')</h4>
|
||
<p>Reveals an element's popover. <strong>Returns to the caller before the popover has actually been shown</strong> (i.e. before the <code>shown.bs.popover</code> event occurs). This is considered a "manual" triggering of the popover. Popovers whose both title and content are zero-length are never displayed.</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">popover</span><span class="p">(</span><span class="s1">'show'</span><span class="p">)</span></code></pre></div>
|
||
|
||
<h4>.popover('hide')</h4>
|
||
<p>Hides an element's popover. <strong>Returns to the caller before the popover has actually been hidden</strong> (i.e. before the <code>hidden.bs.popover</code> event occurs). This is considered a "manual" triggering of the popover.</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">popover</span><span class="p">(</span><span class="s1">'hide'</span><span class="p">)</span></code></pre></div>
|
||
|
||
<h4>.popover('toggle')</h4>
|
||
<p>Toggles an element's popover. <strong>Returns to the caller before the popover has actually been shown or hidden</strong> (i.e. before the <code>shown.bs.popover</code> or <code>hidden.bs.popover</code> event occurs). This is considered a "manual" triggering of the popover.</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">popover</span><span class="p">(</span><span class="s1">'toggle'</span><span class="p">)</span></code></pre></div>
|
||
|
||
<h4>.popover('destroy')</h4>
|
||
<p>Hides and destroys an element's popover.</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">popover</span><span class="p">(</span><span class="s1">'destroy'</span><span class="p">)</span></code></pre></div>
|
||
|
||
<h3 id="popovers-events">Events</h3>
|
||
<div class="table-responsive">
|
||
<table class="table table-bordered table-striped bs-events-table">
|
||
<thead>
|
||
<tr>
|
||
<th style="width: 150px;">Event Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>show.bs.popover</td>
|
||
<td>This event fires immediately when the <code>show</code> instance method is called.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>shown.bs.popover</td>
|
||
<td>This event is fired when the popover has been made visible to the user (will wait for CSS transitions to complete).</td>
|
||
</tr>
|
||
<tr>
|
||
<td>hide.bs.popover</td>
|
||
<td>This event is fired immediately when the <code>hide</code> instance method has been called.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>hidden.bs.popover</td>
|
||
<td>This event is fired when the popover has finished being hidden from the user (will wait for CSS transitions to complete).</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div><!-- /.table-responsive -->
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myPopover'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'hidden.bs.popover'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
||
<span class="c1">// do something…</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
</div>
|
||
|
||
<div class="bs-docs-section">
|
||
<h1 id="alerts" class="page-header">Alert messages <small>alert.js</small></h1>
|
||
|
||
<h2 id="alerts-examples">Example alerts</h2>
|
||
<p>Add dismiss functionality to all alert messages with this plugin.</p>
|
||
<p>When using a <code>.close</code> button, it must be the first child of the <code>.alert-dismissible</code> and no text content may come before it in the markup.</p>
|
||
<div class="bs-example bs-example-standalone" data-example-id="dismissible-alert-js">
|
||
<div class="alert alert-warning alert-dismissible fade in" role="alert">
|
||
<button type="button" class="close" data-dismiss="alert" aria-label="Close"><span aria-hidden="true">×</span></button>
|
||
<strong>Holy guacamole!</strong> Best check yo self, you're not looking too good.
|
||
</div>
|
||
|
||
<div class="alert alert-danger alert-dismissible fade in" role="alert">
|
||
<button type="button" class="close" data-dismiss="alert" aria-label="Close"><span aria-hidden="true">×</span></button>
|
||
<h4>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>
|
||
<button type="button" class="btn btn-danger">Take this action</button>
|
||
<button type="button" class="btn btn-default">Or do this</button>
|
||
</p>
|
||
</div>
|
||
</div><!-- /example -->
|
||
|
||
|
||
<h2 id="alerts-usage">Usage</h2>
|
||
|
||
<p>Just add <code>data-dismiss="alert"</code> to your close button to automatically give an alert close functionality. Closing an alert removes it from the DOM.</p>
|
||
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"close"</span> <span class="na">data-dismiss=</span><span class="s">"alert"</span> <span class="na">aria-label=</span><span class="s">"Close"</span><span class="nt">></span>
|
||
<span class="nt"><span</span> <span class="na">aria-hidden=</span><span class="s">"true"</span><span class="nt">></span><span class="ni">&times;</span><span class="nt"></span></span>
|
||
<span class="nt"></button></span></code></pre></div>
|
||
|
||
<p>To have your alerts use animation when closing, make sure they have the <code>.fade</code> and <code>.in</code> classes already applied to them.</p>
|
||
|
||
<h3 id="alerts-methods">Methods</h3>
|
||
|
||
<h4>$().alert()</h4>
|
||
<p>Makes an alert listen for click events on descendant elements which have the <code>data-dismiss="alert"</code> attribute. (Not necessary when using the data-api's auto-initialization.)</p>
|
||
|
||
<h4>$().alert('close')</h4>
|
||
<p>Closes an alert by removing it from the DOM. If the <code>.fade</code> and <code>.in</code> classes are present on the element, the alert will fade out before it is removed.</p>
|
||
|
||
|
||
<h3 id="alerts-events">Events</h3>
|
||
<p>Bootstrap's alert plugin exposes a few events for hooking into alert functionality.</p>
|
||
<div class="table-responsive">
|
||
<table class="table table-bordered table-striped bs-events-table">
|
||
<thead>
|
||
<tr>
|
||
<th style="width: 150px;">Event Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>close.bs.alert</td>
|
||
<td>This event fires immediately when the <code>close</code> instance method is called.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>closed.bs.alert</td>
|
||
<td>This event is fired when the alert has been closed (will wait for CSS transitions to complete).</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div><!-- /.table-responsive -->
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myAlert'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'closed.bs.alert'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
||
<span class="c1">// do something…</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
</div>
|
||
|
||
<div class="bs-docs-section">
|
||
<h1 id="buttons" class="page-header">Buttons <small>button.js</small></h1>
|
||
|
||
<p class="lead">Do more with buttons. Control button states or create groups of buttons for more components like toolbars.</p>
|
||
|
||
<div class="bs-callout bs-callout-danger" id="callout-buttons-ff-autocomplete">
|
||
<h4>Cross-browser compatibility</h4>
|
||
<p><a href="https://github.com/twbs/bootstrap/issues/793">Firefox persists form control states (disabledness and checkedness) across page loads</a>. A workaround for this is to use <code>autocomplete="off"</code>. See <a href="https://bugzilla.mozilla.org/show_bug.cgi?id=654072">Mozilla bug #654072</a>.</p>
|
||
</div>
|
||
|
||
<h2 id="buttons-stateful">Stateful</h2>
|
||
<p>Add <code>data-loading-text="Loading..."</code> to use a loading state on a button.</p>
|
||
<div class="bs-callout bs-callout-info" id="callout-buttons-state-names">
|
||
<h4>Use whichever state you like!</h4>
|
||
<p>For the sake of this demonstration, we are using <code>data-loading-text</code> and <code>$().button('loading')</code>, but that's not the only state you can use. <a href="#buttons-methods">See more on this below in the <code>$().button(string)</code> documentation</a>.</p>
|
||
</div>
|
||
<div class="bs-example">
|
||
<button type="button" id="loading-example-btn" data-loading-text="Loading..." class="btn btn-primary" autocomplete="off">
|
||
Loading state
|
||
</button>
|
||
</div><!-- /example -->
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">id=</span><span class="s">"myButton"</span> <span class="na">data-loading-text=</span><span class="s">"Loading..."</span> <span class="na">class=</span><span class="s">"btn btn-primary"</span> <span class="na">autocomplete=</span><span class="s">"off"</span><span class="nt">></span>
|
||
Loading state
|
||
<span class="nt"></button></span>
|
||
|
||
<span class="nt"><script></span>
|
||
<span class="nx">$</span><span class="p">(</span><span class="s1">'#myButton'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'click'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
||
<span class="kd">var</span> <span class="nx">$btn</span> <span class="o">=</span> <span class="nx">$</span><span class="p">(</span><span class="k">this</span><span class="p">).</span><span class="nx">button</span><span class="p">(</span><span class="s1">'loading'</span><span class="p">)</span>
|
||
<span class="c1">// business logic...</span>
|
||
<span class="nx">$btn</span><span class="p">.</span><span class="nx">button</span><span class="p">(</span><span class="s1">'reset'</span><span class="p">)</span>
|
||
<span class="p">})</span>
|
||
<span class="nt"></script></span></code></pre></div>
|
||
|
||
<h2 id="buttons-single-toggle">Single toggle</h2>
|
||
<p>Add <code>data-toggle="button"</code> to activate toggling on a single button.</p>
|
||
<div class="bs-callout bs-callout-warning" id="callout-buttons-single-pretoggled">
|
||
<h4>Pre-toggled buttons need <code>.active</code> and <code>aria-pressed="true"</code></h4>
|
||
<p>For pre-toggled buttons, you must add the <code>.active</code> class and the <code>aria-pressed="true"</code> attribute to the <code>button</code> yourself.</p>
|
||
</div>
|
||
<div class="bs-example">
|
||
<button type="button" class="btn btn-primary" data-toggle="button" aria-pressed="false" autocomplete="off">
|
||
Single toggle
|
||
</button>
|
||
</div><!-- /example -->
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-primary"</span> <span class="na">data-toggle=</span><span class="s">"button"</span> <span class="na">aria-pressed=</span><span class="s">"false"</span> <span class="na">autocomplete=</span><span class="s">"off"</span><span class="nt">></span>
|
||
Single toggle
|
||
<span class="nt"></button></span></code></pre></div>
|
||
|
||
<h2 id="buttons-checkbox-radio">Checkbox / Radio</h2>
|
||
<p>Add <code>data-toggle="buttons"</code> to a <code>.btn-group</code> containing checkbox or radio inputs to enable toggling in their respective styles.</p>
|
||
<div class="bs-callout bs-callout-warning" id="callout-buttons-multi-preselected">
|
||
<h4>Preselected options need <code>.active</code></h4>
|
||
<p>For preselected options, you must add the <code>.active</code> class to the input's <code>label</code> yourself.</p>
|
||
</div>
|
||
<div class="bs-callout bs-callout-warning" id="callout-buttons-only-click">
|
||
<h4>Visual checked state only updated on click</h4>
|
||
<p>If the checked state of a checkbox button is updated without firing a <code>click</code> event on the button (e.g. via <code><input type="reset"></code> or via setting the <code>checked</code> property of the input), you will need to toggle the <code>.active</code> class on the input's <code>label</code> yourself.</p>
|
||
</div>
|
||
<div class="bs-example" data-example-id="buttons-checkbox">
|
||
<div class="btn-group" data-toggle="buttons">
|
||
<label class="btn btn-primary active">
|
||
<input type="checkbox" checked autocomplete="off"> Checkbox 1 (pre-checked)
|
||
</label>
|
||
<label class="btn btn-primary">
|
||
<input type="checkbox" autocomplete="off"> Checkbox 2
|
||
</label>
|
||
<label class="btn btn-primary">
|
||
<input type="checkbox" autocomplete="off"> Checkbox 3
|
||
</label>
|
||
</div>
|
||
</div><!-- /example -->
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><div</span> <span class="na">class=</span><span class="s">"btn-group"</span> <span class="na">data-toggle=</span><span class="s">"buttons"</span><span class="nt">></span>
|
||
<span class="nt"><label</span> <span class="na">class=</span><span class="s">"btn btn-primary active"</span><span class="nt">></span>
|
||
<span class="nt"><input</span> <span class="na">type=</span><span class="s">"checkbox"</span> <span class="na">autocomplete=</span><span class="s">"off"</span> <span class="na">checked</span><span class="nt">></span> Checkbox 1 (pre-checked)
|
||
<span class="nt"></label></span>
|
||
<span class="nt"><label</span> <span class="na">class=</span><span class="s">"btn btn-primary"</span><span class="nt">></span>
|
||
<span class="nt"><input</span> <span class="na">type=</span><span class="s">"checkbox"</span> <span class="na">autocomplete=</span><span class="s">"off"</span><span class="nt">></span> Checkbox 2
|
||
<span class="nt"></label></span>
|
||
<span class="nt"><label</span> <span class="na">class=</span><span class="s">"btn btn-primary"</span><span class="nt">></span>
|
||
<span class="nt"><input</span> <span class="na">type=</span><span class="s">"checkbox"</span> <span class="na">autocomplete=</span><span class="s">"off"</span><span class="nt">></span> Checkbox 3
|
||
<span class="nt"></label></span>
|
||
<span class="nt"></div></span></code></pre></div>
|
||
|
||
<div class="bs-example" data-example-id="buttons-radio">
|
||
<div class="btn-group" data-toggle="buttons">
|
||
<label class="btn btn-primary active">
|
||
<input type="radio" name="options" id="option1" autocomplete="off" checked> Radio 1 (preselected)
|
||
</label>
|
||
<label class="btn btn-primary">
|
||
<input type="radio" name="options" id="option2" autocomplete="off"> Radio 2
|
||
</label>
|
||
<label class="btn btn-primary">
|
||
<input type="radio" name="options" id="option3" autocomplete="off"> Radio 3
|
||
</label>
|
||
</div>
|
||
</div><!-- /example -->
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><div</span> <span class="na">class=</span><span class="s">"btn-group"</span> <span class="na">data-toggle=</span><span class="s">"buttons"</span><span class="nt">></span>
|
||
<span class="nt"><label</span> <span class="na">class=</span><span class="s">"btn btn-primary active"</span><span class="nt">></span>
|
||
<span class="nt"><input</span> <span class="na">type=</span><span class="s">"radio"</span> <span class="na">name=</span><span class="s">"options"</span> <span class="na">id=</span><span class="s">"option1"</span> <span class="na">autocomplete=</span><span class="s">"off"</span> <span class="na">checked</span><span class="nt">></span> Radio 1 (preselected)
|
||
<span class="nt"></label></span>
|
||
<span class="nt"><label</span> <span class="na">class=</span><span class="s">"btn btn-primary"</span><span class="nt">></span>
|
||
<span class="nt"><input</span> <span class="na">type=</span><span class="s">"radio"</span> <span class="na">name=</span><span class="s">"options"</span> <span class="na">id=</span><span class="s">"option2"</span> <span class="na">autocomplete=</span><span class="s">"off"</span><span class="nt">></span> Radio 2
|
||
<span class="nt"></label></span>
|
||
<span class="nt"><label</span> <span class="na">class=</span><span class="s">"btn btn-primary"</span><span class="nt">></span>
|
||
<span class="nt"><input</span> <span class="na">type=</span><span class="s">"radio"</span> <span class="na">name=</span><span class="s">"options"</span> <span class="na">id=</span><span class="s">"option3"</span> <span class="na">autocomplete=</span><span class="s">"off"</span><span class="nt">></span> Radio 3
|
||
<span class="nt"></label></span>
|
||
<span class="nt"></div></span></code></pre></div>
|
||
|
||
<h2 id="buttons-methods">Methods</h2>
|
||
|
||
<h4>$().button('toggle')</h4>
|
||
<p>Toggles push state. Gives the button the appearance that it has been activated.</p>
|
||
|
||
<h4>$().button('reset')</h4>
|
||
<p>Resets button state - swaps text to original text.</p>
|
||
|
||
<h4>$().button(string)</h4>
|
||
<p>Swaps text to any data defined text state.</p>
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">id=</span><span class="s">"myStateButton"</span> <span class="na">data-complete-text=</span><span class="s">"finished!"</span> <span class="na">class=</span><span class="s">"btn btn-primary"</span> <span class="na">autocomplete=</span><span class="s">"off"</span><span class="nt">></span>
|
||
...
|
||
<span class="nt"></button></span>
|
||
|
||
<span class="nt"><script></span>
|
||
<span class="nx">$</span><span class="p">(</span><span class="s1">'#myStateButton'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'click'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
||
<span class="nx">$</span><span class="p">(</span><span class="k">this</span><span class="p">).</span><span class="nx">button</span><span class="p">(</span><span class="s1">'complete'</span><span class="p">)</span> <span class="c1">// button text will be "finished!"</span>
|
||
<span class="p">})</span>
|
||
<span class="nt"></script></span></code></pre></div>
|
||
</div>
|
||
|
||
<div class="bs-docs-section">
|
||
<h1 id="collapse" class="page-header">Collapse <small>collapse.js</small></h1>
|
||
|
||
<p class="lead">Flexible plugin that utilizes a handful of classes for easy toggle behavior.</p>
|
||
|
||
<div class="bs-callout bs-callout-danger" id="callout-collapse-dependency">
|
||
<h4>Plugin dependency</h4>
|
||
<p>Collapse requires the <a href="#transitions">transitions plugin</a> to be included in your version of Bootstrap.</p>
|
||
</div>
|
||
|
||
<h2 id="collapse-example">Example</h2>
|
||
<p>Click the buttons below to show and hide another element via class changes:</p>
|
||
<ul>
|
||
<li><code>.collapse</code> hides content</li>
|
||
<li><code>.collapsing</code> is applied during transitions</li>
|
||
<li><code>.collapse.in</code> shows content</li>
|
||
</ul>
|
||
<p>You can use a link with the <code>href</code> attribute, or a button with the <code>data-target</code> attribute. In both cases, the <code>data-toggle="collapse"</code> is required.</p>
|
||
|
||
<div class="bs-example">
|
||
<p>
|
||
<a class="btn btn-primary" data-toggle="collapse" href="#collapseExample" aria-expanded="false" aria-controls="collapseExample">
|
||
Link with href
|
||
</a>
|
||
<button class="btn btn-primary" type="button" data-toggle="collapse" data-target="#collapseExample" aria-expanded="false" aria-controls="collapseExample">
|
||
Button with data-target
|
||
</button>
|
||
</p>
|
||
<div class="collapse" id="collapseExample">
|
||
<div class="well">
|
||
Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident.
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><a</span> <span class="na">class=</span><span class="s">"btn btn-primary"</span> <span class="na">data-toggle=</span><span class="s">"collapse"</span> <span class="na">href=</span><span class="s">"#collapseExample"</span> <span class="na">aria-expanded=</span><span class="s">"false"</span> <span class="na">aria-controls=</span><span class="s">"collapseExample"</span><span class="nt">></span>
|
||
Link with href
|
||
<span class="nt"></a></span>
|
||
<span class="nt"><button</span> <span class="na">class=</span><span class="s">"btn btn-primary"</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">data-toggle=</span><span class="s">"collapse"</span> <span class="na">data-target=</span><span class="s">"#collapseExample"</span> <span class="na">aria-expanded=</span><span class="s">"false"</span> <span class="na">aria-controls=</span><span class="s">"collapseExample"</span><span class="nt">></span>
|
||
Button with data-target
|
||
<span class="nt"></button></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"collapse"</span> <span class="na">id=</span><span class="s">"collapseExample"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"well"</span><span class="nt">></span>
|
||
...
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span></code></pre></div>
|
||
|
||
<h2 id="collapse-example-accordion">Accordion example</h2>
|
||
<p>Extend the default collapse behavior to create an accordion with the panel component.</p>
|
||
|
||
<div class="bs-example" data-example-id="collapse-accordion">
|
||
<div class="panel-group" id="accordion" role="tablist" aria-multiselectable="true">
|
||
<div class="panel panel-default">
|
||
<div class="panel-heading" role="tab" id="headingOne">
|
||
<h4 class="panel-title">
|
||
<a data-toggle="collapse" data-parent="#accordion" href="#collapseOne" aria-expanded="true" aria-controls="collapseOne">
|
||
Collapsible Group Item #1
|
||
</a>
|
||
</h4>
|
||
</div>
|
||
<div id="collapseOne" class="panel-collapse collapse in" role="tabpanel" aria-labelledby="headingOne">
|
||
<div class="panel-body">
|
||
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="panel panel-default">
|
||
<div class="panel-heading" role="tab" id="headingTwo">
|
||
<h4 class="panel-title">
|
||
<a class="collapsed" data-toggle="collapse" data-parent="#accordion" href="#collapseTwo" aria-expanded="false" aria-controls="collapseTwo">
|
||
Collapsible Group Item #2
|
||
</a>
|
||
</h4>
|
||
</div>
|
||
<div id="collapseTwo" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingTwo">
|
||
<div class="panel-body">
|
||
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="panel panel-default">
|
||
<div class="panel-heading" role="tab" id="headingThree">
|
||
<h4 class="panel-title">
|
||
<a class="collapsed" data-toggle="collapse" data-parent="#accordion" href="#collapseThree" aria-expanded="false" aria-controls="collapseThree">
|
||
Collapsible Group Item #3
|
||
</a>
|
||
</h4>
|
||
</div>
|
||
<div id="collapseThree" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingThree">
|
||
<div class="panel-body">
|
||
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><!-- /example -->
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><div</span> <span class="na">class=</span><span class="s">"panel-group"</span> <span class="na">id=</span><span class="s">"accordion"</span> <span class="na">role=</span><span class="s">"tablist"</span> <span class="na">aria-multiselectable=</span><span class="s">"true"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"panel panel-default"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"panel-heading"</span> <span class="na">role=</span><span class="s">"tab"</span> <span class="na">id=</span><span class="s">"headingOne"</span><span class="nt">></span>
|
||
<span class="nt"><h4</span> <span class="na">class=</span><span class="s">"panel-title"</span><span class="nt">></span>
|
||
<span class="nt"><a</span> <span class="na">data-toggle=</span><span class="s">"collapse"</span> <span class="na">data-parent=</span><span class="s">"#accordion"</span> <span class="na">href=</span><span class="s">"#collapseOne"</span> <span class="na">aria-expanded=</span><span class="s">"true"</span> <span class="na">aria-controls=</span><span class="s">"collapseOne"</span><span class="nt">></span>
|
||
Collapsible Group Item #1
|
||
<span class="nt"></a></span>
|
||
<span class="nt"></h4></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">id=</span><span class="s">"collapseOne"</span> <span class="na">class=</span><span class="s">"panel-collapse collapse in"</span> <span class="na">role=</span><span class="s">"tabpanel"</span> <span class="na">aria-labelledby=</span><span class="s">"headingOne"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"panel-body"</span><span class="nt">></span>
|
||
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.
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"panel panel-default"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"panel-heading"</span> <span class="na">role=</span><span class="s">"tab"</span> <span class="na">id=</span><span class="s">"headingTwo"</span><span class="nt">></span>
|
||
<span class="nt"><h4</span> <span class="na">class=</span><span class="s">"panel-title"</span><span class="nt">></span>
|
||
<span class="nt"><a</span> <span class="na">class=</span><span class="s">"collapsed"</span> <span class="na">data-toggle=</span><span class="s">"collapse"</span> <span class="na">data-parent=</span><span class="s">"#accordion"</span> <span class="na">href=</span><span class="s">"#collapseTwo"</span> <span class="na">aria-expanded=</span><span class="s">"false"</span> <span class="na">aria-controls=</span><span class="s">"collapseTwo"</span><span class="nt">></span>
|
||
Collapsible Group Item #2
|
||
<span class="nt"></a></span>
|
||
<span class="nt"></h4></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">id=</span><span class="s">"collapseTwo"</span> <span class="na">class=</span><span class="s">"panel-collapse collapse"</span> <span class="na">role=</span><span class="s">"tabpanel"</span> <span class="na">aria-labelledby=</span><span class="s">"headingTwo"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"panel-body"</span><span class="nt">></span>
|
||
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.
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"panel panel-default"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"panel-heading"</span> <span class="na">role=</span><span class="s">"tab"</span> <span class="na">id=</span><span class="s">"headingThree"</span><span class="nt">></span>
|
||
<span class="nt"><h4</span> <span class="na">class=</span><span class="s">"panel-title"</span><span class="nt">></span>
|
||
<span class="nt"><a</span> <span class="na">class=</span><span class="s">"collapsed"</span> <span class="na">data-toggle=</span><span class="s">"collapse"</span> <span class="na">data-parent=</span><span class="s">"#accordion"</span> <span class="na">href=</span><span class="s">"#collapseThree"</span> <span class="na">aria-expanded=</span><span class="s">"false"</span> <span class="na">aria-controls=</span><span class="s">"collapseThree"</span><span class="nt">></span>
|
||
Collapsible Group Item #3
|
||
<span class="nt"></a></span>
|
||
<span class="nt"></h4></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">id=</span><span class="s">"collapseThree"</span> <span class="na">class=</span><span class="s">"panel-collapse collapse"</span> <span class="na">role=</span><span class="s">"tabpanel"</span> <span class="na">aria-labelledby=</span><span class="s">"headingThree"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"panel-body"</span><span class="nt">></span>
|
||
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.
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span></code></pre></div>
|
||
|
||
<p>It's also possible to swap out <code>.panel-body</code>s with <code>.list-group</code>s.</p>
|
||
|
||
<div class="panel-group" role="tablist">
|
||
<div class="panel panel-default">
|
||
<div class="panel-heading" role="tab" id="collapseListGroupHeading1">
|
||
<h4 class="panel-title">
|
||
<a class="collapsed" data-toggle="collapse" href="#collapseListGroup1" aria-expanded="false" aria-controls="collapseListGroup1">
|
||
Collapsible list group
|
||
</a>
|
||
</h4>
|
||
</div>
|
||
<div id="collapseListGroup1" class="panel-collapse collapse" role="tabpanel" aria-labelledby="collapseListGroupHeading1">
|
||
<ul class="list-group">
|
||
<li class="list-group-item">Bootply</li>
|
||
<li class="list-group-item">One itmus ac facilin</li>
|
||
<li class="list-group-item">Second eros</li>
|
||
</ul>
|
||
<div class="panel-footer">Footer</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="bs-callout bs-callout-warning" id="callout-collapse-accessibility">
|
||
<h4>Make expand/collapse controls accessible</h4>
|
||
<p>Be sure to add <code>aria-expanded</code> to the control element. This attribute explicitly defines the current state of the collapsible element to screen readers and similar assistive technologies. If the collapsible element is closed by default, it should have a value of <code>aria-expanded="false"</code>. If you've set the collapsible element to be open by default using the <code>in</code> class, set <code>aria-expanded="true"</code> on the control instead. The plugin will automatically toggle this attribute based on whether or not the collapsible element has been opened or closed.</p>
|
||
<p>Additionally, if your control element is targetting a single collapsible element – i.e. the <code>data-target</code> attribute is pointing to an <code>id</code> selector – you may add an additional <code>aria-controls</code> attribute to the control element, containing the <code>id</code> of the collapsible element. Modern screen readers and similar assistive technologies make use of this attribute to provide users with additional shortcuts to navigate directly to the collapsible element itself.</p>
|
||
</div>
|
||
|
||
<h2 id="collapse-usage">Usage</h2>
|
||
<p>The collapse plugin utilizes a few classes to handle the heavy lifting:</p>
|
||
<ul>
|
||
<li><code>.collapse</code> hides the content</li>
|
||
<li><code>.collapse.in</code> shows the content</li>
|
||
<li><code>.collapsing</code> is added when the transition starts, and removed when it finishes</li>
|
||
</ul>
|
||
<p>These classes can be found in <code>component-animations.less</code>.</p>
|
||
|
||
<h3>Via data attributes</h3>
|
||
<p>Just add <code>data-toggle="collapse"</code> and a <code>data-target</code> to the 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>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'.collapse'</span><span class="p">).</span><span class="nx">collapse</span><span class="p">()</span></code></pre></div>
|
||
|
||
<h3 id="collapse-options">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>
|
||
<div class="table-responsive">
|
||
<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 a selector is provided, then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior - this is dependent on the <code>panel</code> class)</td>
|
||
</tr>
|
||
<tr>
|
||
<td>toggle</td>
|
||
<td>boolean</td>
|
||
<td>true</td>
|
||
<td>Toggles the collapsible element on invocation</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div><!-- /.table-responsive -->
|
||
|
||
<h3 id="collapse-methods">Methods</h3>
|
||
|
||
<h4>.collapse(options)</h4>
|
||
<p>Activates your content as a collapsible element. Accepts an optional options <code>object</code>.
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myCollapsible'</span><span class="p">).</span><span class="nx">collapse</span><span class="p">({</span>
|
||
<span class="na">toggle</span><span class="p">:</span> <span class="kc">false</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
|
||
<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 id="collapse-events">Events</h3>
|
||
<p>Bootstrap's collapse class exposes a few events for hooking into collapse functionality.</p>
|
||
<div class="table-responsive">
|
||
<table class="table table-bordered table-striped bs-events-table">
|
||
<thead>
|
||
<tr>
|
||
<th style="width: 150px;">Event Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>show.bs.collapse</td>
|
||
<td>This event fires immediately when the <code>show</code> instance method is called.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>shown.bs.collapse</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.bs.collapse</td>
|
||
<td>
|
||
This event is fired immediately when the <code>hide</code> method has been called.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>hidden.bs.collapse</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>
|
||
</div><!-- /.table-responsive -->
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myCollapsible'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'hidden.bs.collapse'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
||
<span class="c1">// do something…</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
</div>
|
||
|
||
<div class="bs-docs-section">
|
||
<h1 id="carousel" class="page-header">Carousel <small>carousel.js</small></h1>
|
||
|
||
<p>A slideshow component for cycling through elements, like a carousel. <strong>Nested carousels are not supported.</strong></p>
|
||
|
||
<h2 id="carousel-examples">Examples</h2>
|
||
<div class="bs-example" data-example-id="simple-carousel">
|
||
<div id="carousel-example-generic" class="carousel slide" data-ride="carousel">
|
||
<ol class="carousel-indicators">
|
||
<li data-target="#carousel-example-generic" data-slide-to="0" class="active"></li>
|
||
<li data-target="#carousel-example-generic" data-slide-to="1"></li>
|
||
<li data-target="#carousel-example-generic" data-slide-to="2"></li>
|
||
</ol>
|
||
<div class="carousel-inner" role="listbox">
|
||
<div class="item active">
|
||
<img data-src="holder.js/900x500/auto/#777:#555/text:First slide" alt="First slide">
|
||
</div>
|
||
<div class="item">
|
||
<img data-src="holder.js/900x500/auto/#666:#444/text:Second slide" alt="Second slide">
|
||
</div>
|
||
<div class="item">
|
||
<img data-src="holder.js/900x500/auto/#555:#333/text:Third slide" alt="Third slide">
|
||
</div>
|
||
</div>
|
||
<a class="left carousel-control" href="#carousel-example-generic" role="button" data-slide="prev">
|
||
<span class="glyphicon glyphicon-chevron-left" aria-hidden="true"></span>
|
||
<span class="sr-only">Previous</span>
|
||
</a>
|
||
<a class="right carousel-control" href="#carousel-example-generic" role="button" data-slide="next">
|
||
<span class="glyphicon glyphicon-chevron-right" aria-hidden="true"></span>
|
||
<span class="sr-only">Next</span>
|
||
</a>
|
||
</div>
|
||
</div><!-- /example -->
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><div</span> <span class="na">id=</span><span class="s">"carousel-example-generic"</span> <span class="na">class=</span><span class="s">"carousel slide"</span> <span class="na">data-ride=</span><span class="s">"carousel"</span><span class="nt">></span>
|
||
<span class="c"><!-- Indicators --></span>
|
||
<span class="nt"><ol</span> <span class="na">class=</span><span class="s">"carousel-indicators"</span><span class="nt">></span>
|
||
<span class="nt"><li</span> <span class="na">data-target=</span><span class="s">"#carousel-example-generic"</span> <span class="na">data-slide-to=</span><span class="s">"0"</span> <span class="na">class=</span><span class="s">"active"</span><span class="nt">></li></span>
|
||
<span class="nt"><li</span> <span class="na">data-target=</span><span class="s">"#carousel-example-generic"</span> <span class="na">data-slide-to=</span><span class="s">"1"</span><span class="nt">></li></span>
|
||
<span class="nt"><li</span> <span class="na">data-target=</span><span class="s">"#carousel-example-generic"</span> <span class="na">data-slide-to=</span><span class="s">"2"</span><span class="nt">></li></span>
|
||
<span class="nt"></ol></span>
|
||
|
||
<span class="c"><!-- Wrapper for slides --></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-inner"</span> <span class="na">role=</span><span class="s">"listbox"</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"item active"</span><span class="nt">></span>
|
||
<span class="nt"><img</span> <span class="na">src=</span><span class="s">"..."</span> <span class="na">alt=</span><span class="s">"..."</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-caption"</span><span class="nt">></span>
|
||
...
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"item"</span><span class="nt">></span>
|
||
<span class="nt"><img</span> <span class="na">src=</span><span class="s">"..."</span> <span class="na">alt=</span><span class="s">"..."</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-caption"</span><span class="nt">></span>
|
||
...
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span>
|
||
...
|
||
<span class="nt"></div></span>
|
||
|
||
<span class="c"><!-- Controls --></span>
|
||
<span class="nt"><a</span> <span class="na">class=</span><span class="s">"left carousel-control"</span> <span class="na">href=</span><span class="s">"#carousel-example-generic"</span> <span class="na">role=</span><span class="s">"button"</span> <span class="na">data-slide=</span><span class="s">"prev"</span><span class="nt">></span>
|
||
<span class="nt"><span</span> <span class="na">class=</span><span class="s">"glyphicon glyphicon-chevron-left"</span> <span class="na">aria-hidden=</span><span class="s">"true"</span><span class="nt">></span></span>
|
||
<span class="nt"><span</span> <span class="na">class=</span><span class="s">"sr-only"</span><span class="nt">></span>Previous<span class="nt"></span></span>
|
||
<span class="nt"></a></span>
|
||
<span class="nt"><a</span> <span class="na">class=</span><span class="s">"right carousel-control"</span> <span class="na">href=</span><span class="s">"#carousel-example-generic"</span> <span class="na">role=</span><span class="s">"button"</span> <span class="na">data-slide=</span><span class="s">"next"</span><span class="nt">></span>
|
||
<span class="nt"><span</span> <span class="na">class=</span><span class="s">"glyphicon glyphicon-chevron-right"</span> <span class="na">aria-hidden=</span><span class="s">"true"</span><span class="nt">></span></span>
|
||
<span class="nt"><span</span> <span class="na">class=</span><span class="s">"sr-only"</span><span class="nt">></span>Next<span class="nt"></span></span>
|
||
<span class="nt"></a></span>
|
||
<span class="nt"></div></span></code></pre></div>
|
||
|
||
<div class="bs-callout bs-callout-danger" id="callout-carousel-accessibility">
|
||
<h4>Accessibility issue</h4>
|
||
<p>The carousel component is generally not compliant with accessibility standards. If you need to be compliant, please consider other options for presenting your content.</p>
|
||
</div>
|
||
|
||
<div class="bs-callout bs-callout-warning" id="callout-carousel-transitions">
|
||
<h4>Transition animations not supported in Internet Explorer 8 & 9</h4>
|
||
<p>Bootstrap exclusively uses CSS3 for its animations, but Internet Explorer 8 & 9 don't support the necessary CSS properties. Thus, there are no slide transition animations when using these browsers. We have intentionally decided not to include jQuery-based fallbacks for the transitions.</p>
|
||
</div>
|
||
|
||
<div class="bs-callout bs-callout-warning" id="callout-carousel-active">
|
||
<h4>Initial active element required</h4>
|
||
<p>The <code>.active</code> class needs to be added to one of the slides. Otherwise, the carousel will not be visible.</p>
|
||
</div>
|
||
|
||
<h3>Optional captions</h3>
|
||
<p>Add captions to your slides easily with the <code>.carousel-caption</code> element within any <code>.item</code>. Place just about any optional HTML within there and it will be automatically aligned and formatted.</p>
|
||
<div class="bs-example" data-example-id="carousel-with-captions">
|
||
<div id="carousel-example-captions" class="carousel slide" data-ride="carousel">
|
||
<ol class="carousel-indicators">
|
||
<li data-target="#carousel-example-captions" data-slide-to="0" class="active"></li>
|
||
<li data-target="#carousel-example-captions" data-slide-to="1"></li>
|
||
<li data-target="#carousel-example-captions" data-slide-to="2"></li>
|
||
</ol>
|
||
<div class="carousel-inner" role="listbox">
|
||
<div class="item active">
|
||
<img data-src="holder.js/900x500/auto/#777:#777" alt="First slide image">
|
||
<div class="carousel-caption">
|
||
<h3>First slide label</h3>
|
||
<p>Nulla vitae elit libero, a pharetra augue mollis interdum.</p>
|
||
</div>
|
||
</div>
|
||
<div class="item">
|
||
<img data-src="holder.js/900x500/auto/#666:#666" alt="Second slide image">
|
||
<div class="carousel-caption">
|
||
<h3>Second slide label</h3>
|
||
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>
|
||
</div>
|
||
</div>
|
||
<div class="item">
|
||
<img data-src="holder.js/900x500/auto/#555:#5555" alt="Third slide image">
|
||
<div class="carousel-caption">
|
||
<h3>Third slide label</h3>
|
||
<p>Praesent commodo cursus magna, vel scelerisque nisl consectetur.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<a class="left carousel-control" href="#carousel-example-captions" role="button" data-slide="prev">
|
||
<span class="glyphicon glyphicon-chevron-left" aria-hidden="true"></span>
|
||
<span class="sr-only">Previous</span>
|
||
</a>
|
||
<a class="right carousel-control" href="#carousel-example-captions" role="button" data-slide="next">
|
||
<span class="glyphicon glyphicon-chevron-right" aria-hidden="true"></span>
|
||
<span class="sr-only">Next</span>
|
||
</a>
|
||
</div>
|
||
</div><!-- /example -->
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><div</span> <span class="na">class=</span><span class="s">"item"</span><span class="nt">></span>
|
||
<span class="nt"><img</span> <span class="na">src=</span><span class="s">"..."</span> <span class="na">alt=</span><span class="s">"..."</span><span class="nt">></span>
|
||
<span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-caption"</span><span class="nt">></span>
|
||
<span class="nt"><h3></span>...<span class="nt"></h3></span>
|
||
<span class="nt"><p></span>...<span class="nt"></p></span>
|
||
<span class="nt"></div></span>
|
||
<span class="nt"></div></span></code></pre></div>
|
||
|
||
<h2 id="carousel-usage">Usage</h2>
|
||
|
||
<h3>Multiple carousels</h3>
|
||
<p>Carousels require the use of an <code>id</code> on the outermost container (the <code>.carousel</code>) for carousel controls to function properly. When adding multiple carousels, or when changing a carousel's <code>id</code>, be sure to update the relevant controls.</p>
|
||
|
||
<h3>Via data attributes</h3>
|
||
<p>Use data attributes to easily control the position of the carousel. <code>data-slide</code> accepts the keywords <code>prev</code> or <code>next</code>, which alters the slide position relative to its current position. Alternatively, use <code>data-slide-to</code> to pass a raw slide index to the carousel <code>data-slide-to="2"</code>, which shifts the slide position to a particular index beginning with <code>0</code>.</p>
|
||
<p>The <code>data-ride="carousel"</code> attribute is used to mark a carousel as animating starting at page load. <strong class="text-danger">It cannot be used in combination with (redundant and unnecessary) explicit JavaScript initialization of the same carousel.</strong></p>
|
||
|
||
<h3>Via JavaScript</h3>
|
||
<p>Call carousel manually with:</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'.carousel'</span><span class="p">).</span><span class="nx">carousel</span><span class="p">()</span></code></pre></div>
|
||
|
||
<h3 id="carousel-options">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>
|
||
<div class="table-responsive">
|
||
<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>
|
||
<tr>
|
||
<td>wrap</td>
|
||
<td>boolean</td>
|
||
<td>true</td>
|
||
<td>Whether the carousel should cycle continuously or have hard stops.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>keyboard</td>
|
||
<td>boolean</td>
|
||
<td>true</td>
|
||
<td>Whether the carousel should react to keyboard events.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div><!-- /.table-responsive -->
|
||
|
||
<h3 id="carousel-methods">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="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'.carousel'</span><span class="p">).</span><span class="nx">carousel</span><span class="p">({</span>
|
||
<span class="na">interval</span><span class="p">:</span> <span class="mi">2000</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
|
||
<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 id="carousel-events">Events</h3>
|
||
<p>Bootstrap's carousel class exposes two events for hooking into carousel functionality.</p>
|
||
<p>Both events have the following additional properties:</p>
|
||
<ul>
|
||
<li><code>direction</code>: The direction in which the carousel is sliding (either <code>"left"</code> or <code>"right"</code>).</li>
|
||
<li><code>relatedTarget</code>: The DOM element that is being slid into place as the active item.</li>
|
||
</ul>
|
||
<div class="table-responsive">
|
||
<table class="table table-bordered table-striped bs-events-table">
|
||
<thead>
|
||
<tr>
|
||
<th style="width: 150px;">Event Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>slide.bs.carousel</td>
|
||
<td>This event fires immediately when the <code>slide</code> instance method is invoked.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>slid.bs.carousel</td>
|
||
<td>This event is fired when the carousel has completed its slide transition.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div><!-- /.table-responsive -->
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myCarousel'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'slide.bs.carousel'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
||
<span class="c1">// do something…</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
</div>
|
||
|
||
<div class="bs-docs-section">
|
||
<h1 id="affix" class="page-header">Affix <small>affix.js</small></h1>
|
||
|
||
<h2 id="affix-examples">Example</h2>
|
||
<p>The subnavigation on the right is a live demo of the affix plugin.</p>
|
||
|
||
<hr class="bs-docs-separator">
|
||
|
||
<h2 id="affix-usage">Usage</h2>
|
||
<p>Use the affix plugin via data attributes or manually with your own JavaScript. <strong class="text-danger">In both situations, you must provide CSS for the positioning and width of your affixed content.</strong></p>
|
||
|
||
<h3>Positioning via CSS</h3>
|
||
<p>The affix plugin toggles between three classes, each representing a particular state: <code>.affix</code>, <code>.affix-top</code>, and <code>.affix-bottom</code>. You must provide the styles for these classes yourself (independent of this plugin) to handle the actual positions.</p>
|
||
<p>Here's how the affix plugin works:</p>
|
||
<ol>
|
||
<li>To start, the plugin adds <code>.affix-top</code> to indicate the element is in its top-most position. At this point no CSS positioning is required.</li>
|
||
<li>Scrolling past the element you want affixed should trigger the actual affixing. This is where <code>.affix</code> replaces <code>.affix-top</code> and sets <code>position: fixed;</code> (provided by Bootstrap's CSS).</li>
|
||
<li>If a bottom offset is defined, scrolling past it should replace <code>.affix</code> with <code>.affix-bottom</code>. Since offsets are optional, setting one requires you to set the appropriate CSS. In this case, add <code>position: absolute;</code> when necessary. The plugin uses the data attribute or JavaScript option to determine where to position the element from there.</li>
|
||
</ol>
|
||
<p>Follow the above steps to set your CSS for either of the usage options below.</p>
|
||
|
||
<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. Use offsets to define when to toggle the pinning of an element.</p>
|
||
|
||
<div class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><div</span> <span class="na">data-spy=</span><span class="s">"affix"</span> <span class="na">data-offset-top=</span><span class="s">"60"</span> <span class="na">data-offset-bottom=</span><span class="s">"200"</span><span class="nt">></span>
|
||
...
|
||
<span class="nt"></div></span></code></pre></div>
|
||
|
||
<h3>Via JavaScript</h3>
|
||
<p>Call the affix plugin via JavaScript:</p>
|
||
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myAffix'</span><span class="p">).</span><span class="nx">affix</span><span class="p">({</span>
|
||
<span class="na">offset</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="na">top</span><span class="p">:</span> <span class="mi">100</span><span class="p">,</span>
|
||
<span class="na">bottom</span><span class="p">:</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
||
<span class="k">return</span> <span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">bottom</span> <span class="o">=</span> <span class="nx">$</span><span class="p">(</span><span class="s1">'.footer'</span><span class="p">).</span><span class="nx">outerHeight</span><span class="p">(</span><span class="kc">true</span><span class="p">))</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
<span class="p">})</span></code></pre></div>
|
||
|
||
|
||
<h3 id="affix-options">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>
|
||
|
||
<div class="table-responsive">
|
||
<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 | function | object</td>
|
||
<td>10</td>
|
||
<td>Pixels to offset from screen when calculating position of scroll. If a single number is provided, the offset will be applied in both top and bottom directions. To provide a unique, bottom and top offset just provide an object <code>offset: { top: 10 }</code> or <code>offset: { top: 10, bottom: 5 }</code>. Use a function when you need to dynamically calculate an offset.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>target</td>
|
||
<td>selector | node | jQuery element</td>
|
||
<td>the <code>window</code> object</td>
|
||
<td>Specifies the target element of the affix.</td>
|
||
</tr>
|
||
|
||
</tbody>
|
||
</table>
|
||
</div><!-- /.table-responsive -->
|
||
|
||
|
||
<h3 id="affix-events">Events</h3>
|
||
<p>Bootstrap's affix plugin exposes a few events for hooking into affix functionality.</p>
|
||
<div class="table-responsive">
|
||
<table class="table table-bordered table-striped bs-events-table">
|
||
<thead>
|
||
<tr>
|
||
<th style="width: 150px;">Event Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>affix.bs.affix</td>
|
||
<td>This event fires immediately before the element has been affixed.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>affixed.bs.affix</td>
|
||
<td>This event is fired after the element has been affixed.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>affix-top.bs.affix</td>
|
||
<td>This event fires immediately before the element has been affixed-top.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>affixed-top.bs.affix</td>
|
||
<td>This event is fired after the element has been affixed-top.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>affix-bottom.bs.affix</td>
|
||
<td>This event fires immediately before the element has been affixed-bottom.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>affixed-bottom.bs.affix</td>
|
||
<td>This event is fired after the element has been affixed-bottom.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div><!-- /.table-responsive -->
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="col-md-3" role="complementary">
|
||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm">
|
||
<ul class="nav bs-docs-sidenav">
|
||
|
||
<li>
|
||
<a href="#js-overview">Overview</a>
|
||
<ul class="nav">
|
||
<li><a href="#js-individual-compiled">Individual or compiled</a></li>
|
||
<li><a href="#js-data-attrs">Data attributes</a></li>
|
||
<li><a href="#js-programmatic-api">Programmatic API</a></li>
|
||
<li><a href="#js-noconflict">No conflict</a></li>
|
||
<li><a href="#js-events">Events</a></li>
|
||
<li><a href="#js-version-nums">Version numbers</a></li>
|
||
<li><a href="#js-disabled">When JavaScript is disabled</a></li>
|
||
<li><a href="#callout-third-party-libs">Third-party libraries</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#transitions">Transitions</a></li>
|
||
<li>
|
||
<a href="#modals">Modal</a>
|
||
<ul class="nav">
|
||
<li><a href="#modals-examples">Examples</a></li>
|
||
<li><a href="#modals-sizes">Sizes</a></li>
|
||
<li><a href="#modals-remove-animation">Remove animation</a></li>
|
||
<li><a href="#modals-related-target">Varying content based on trigger button</a></li>
|
||
<li><a href="#modals-usage">Usage</a></li>
|
||
<li><a href="#modals-options">Options</a></li>
|
||
<li><a href="#modals-methods">Methods</a></li>
|
||
<li><a href="#modals-events">Events</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="#dropdowns">Dropdown</a>
|
||
<ul class="nav">
|
||
<li><a href="#dropdowns-examples">Examples</a></li>
|
||
<li><a href="#dropdowns-usage">Usage</a></li>
|
||
<li><a href="#dropdowns-methods">Methods</a></li>
|
||
<li><a href="#dropdowns-events">Events</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="#scrollspy">Scrollspy</a>
|
||
<ul class="nav">
|
||
<li><a href="#scrollspy-examples">Examples</a></li>
|
||
<li><a href="#scrollspy-usage">Usage</a></li>
|
||
<li><a href="#scrollspy-methods">Methods</a></li>
|
||
<li><a href="#scrollspy-options">Options</a></li>
|
||
<li><a href="#scrollspy-events">Events</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="#tabs">Tab</a>
|
||
<ul class="nav">
|
||
<li><a href="#tabs-examples">Examples</a></li>
|
||
<li><a href="#tabs-usage">Usage</a></li>
|
||
<li><a href="#tabs-methods">Methods</a></li>
|
||
<li><a href="#tabs-events">Events</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="#tooltips">Tooltip</a>
|
||
<ul class="nav">
|
||
<li><a href="#tooltips-examples">Examples</a></li>
|
||
<li><a href="#tooltips-usage">Usage</a></li>
|
||
<li><a href="#tooltips-options">Options</a></li>
|
||
<li><a href="#tooltips-methods">Methods</a></li>
|
||
<li><a href="#tooltips-events">Events</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="#popovers">Popover</a>
|
||
<ul class="nav">
|
||
<li><a href="#popovers-examples">Examples</a></li>
|
||
<li><a href="#popovers-usage">Usage</a></li>
|
||
<li><a href="#popovers-options">Options</a></li>
|
||
<li><a href="#popovers-events">Events</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="#alerts">Alert</a>
|
||
<ul class="nav">
|
||
<li><a href="#alerts-examples">Examples</a></li>
|
||
<li><a href="#alerts-usage">Usage</a></li>
|
||
<li><a href="#alerts-methods">Methods</a></li>
|
||
<li><a href="#alerts-events">Events</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="#buttons">Button</a>
|
||
<ul class="nav">
|
||
<li><a href="#buttons-stateful">Stateful</a></li>
|
||
<li><a href="#buttons-single-toggle">Single toggle</a></li>
|
||
<li><a href="#buttons-checkbox-radio">Checkbox / Radio</a></li>
|
||
<li><a href="#buttons-methods">Methods</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="#collapse">Collapse</a>
|
||
<ul class="nav">
|
||
<li><a href="#collapse-example">Example</a></li>
|
||
<li><a href="#collapse-example-accordion">Accordion example</a></li>
|
||
<li><a href="#collapse-usage">Usage</a></li>
|
||
<li><a href="#collapse-options">Options</a></li>
|
||
<li><a href="#collapse-methods">Methods</a></li>
|
||
<li><a href="#collapse-events">Events</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="#carousel">Carousel</a>
|
||
<ul class="nav">
|
||
<li><a href="#carousel-examples">Examples</a></li>
|
||
<li><a href="#carousel-usage">Usage</a></li>
|
||
<li><a href="#carousel-options">Options</a></li>
|
||
<li><a href="#carousel-methods">Methods</a></li>
|
||
<li><a href="#carousel-events">Events</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="#affix">Affix</a>
|
||
<ul class="nav">
|
||
<li><a href="#affix-examples">Examples</a></li>
|
||
<li><a href="#affix-usage">Usage</a></li>
|
||
<li><a href="#affix-options">Options</a></li>
|
||
<li><a href="#affix-events">Events</a></li>
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
</ul>
|
||
<a class="back-to-top" href="#top">
|
||
Back to top
|
||
</a>
|
||
|
||
<a href="#" class="bs-docs-theme-toggle" role="button">
|
||
Preview theme
|
||
</a>
|
||
|
||
</nav>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<!-- Footer
|
||
================================================== -->
|
||
<footer class="bs-docs-footer" role="contentinfo">
|
||
<div class="container">
|
||
<div class="bs-docs-social">
|
||
<ul class="bs-docs-social-buttons">
|
||
<li>
|
||
<iframe class="github-btn" src="http://ghbtns.com/github-btn.html?user=twbs&repo=bootstrap&type=watch&count=true" width="100" height="20" title="Star on GitHub"></iframe>
|
||
</li>
|
||
<li>
|
||
<iframe class="github-btn" src="http://ghbtns.com/github-btn.html?user=twbs&repo=bootstrap&type=fork&count=true" width="102" height="20" title="Fork on GitHub"></iframe>
|
||
</li>
|
||
<li class="follow-btn">
|
||
<a href="https://twitter.com/getbootstrap" class="twitter-follow-button" data-link-color="#0069D6" data-show-count="true">Follow @getbootstrap</a>
|
||
</li>
|
||
<li class="tweet-btn">
|
||
<a href="https://twitter.com/share" class="twitter-share-button" data-url="http://getbootstrap.com/" data-count="horizontal" data-via="getbootstrap" data-related="mdo:Creator of Bootstrap">Tweet</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
<p>Designed and built with all the love in the world by <a href="https://twitter.com/mdo" target="_blank">@mdo</a> and <a href="https://twitter.com/fat" target="_blank">@fat</a>.</p>
|
||
<p>Maintained by the <a href="https://github.com/orgs/twbs/people">core team</a> with the help of <a href="https://github.com/twbs/bootstrap/graphs/contributors">our contributors</a>.</p>
|
||
<p>Code licensed under <a href="https://github.com/twbs/bootstrap/blob/master/LICENSE" target="_blank">MIT</a>, documentation under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</p>
|
||
<ul class="bs-docs-footer-links text-muted">
|
||
<li>Currently v3.3.2</li>
|
||
<li>·</li>
|
||
<li><a href="https://github.com/twbs/bootstrap">GitHub</a></li>
|
||
<li>·</li>
|
||
<li><a href="../getting-started/#examples">Examples</a></li>
|
||
<li>·</li>
|
||
<li><a href="../2.3.2/">v2.3.2 docs</a></li>
|
||
<li>·</li>
|
||
<li><a href="../about/">About</a></li>
|
||
<li>·</li>
|
||
<li><a href="http://expo.getbootstrap.com">Expo</a></li>
|
||
<li>·</li>
|
||
<li><a href="http://blog.getbootstrap.com">Blog</a></li>
|
||
<li>·</li>
|
||
<li><a href="https://github.com/twbs/bootstrap/issues">Issues</a></li>
|
||
<li>·</li>
|
||
<li><a href="https://github.com/twbs/bootstrap/releases">Releases</a></li>
|
||
</ul>
|
||
</div>
|
||
</footer>
|
||
|
||
<!-- Bootstrap core JavaScript
|
||
================================================== -->
|
||
<!-- Placed at the end of the document so the pages load faster -->
|
||
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
|
||
|
||
|
||
<script src="../dist/js/bootstrap.min.js"></script>
|
||
|
||
|
||
|
||
<script src="../assets/js/docs.min.js"></script>
|
||
|
||
|
||
|
||
|
||
<!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->
|
||
<script src="../assets/js/ie10-viewport-bug-workaround.js"></script>
|
||
|
||
|
||
<script>
|
||
window.twttr = (function (d,s,id) {
|
||
var t, js, fjs = d.getElementsByTagName(s)[0];
|
||
if (d.getElementById(id)) return; js=d.createElement(s); js.id=id; js.async=1;
|
||
js.src="https://platform.twitter.com/widgets.js"; fjs.parentNode.insertBefore(js, fjs);
|
||
return window.twttr || (t = { _e: [], ready: function(f){ t._e.push(f) } });
|
||
}(document, "script", "twitter-wjs"));
|
||
</script>
|
||
|
||
<!-- Analytics
|
||
================================================== -->
|
||
<script>
|
||
var _gauges = _gauges || [];
|
||
(function() {
|
||
var t = document.createElement('script');
|
||
t.async = true;
|
||
t.id = 'gauges-tracker';
|
||
t.setAttribute('data-site-id', '4f0dc9fef5a1f55508000013');
|
||
t.src = '//secure.gaug.es/track.js';
|
||
var s = document.getElementsByTagName('script')[0];
|
||
s.parentNode.insertBefore(t, s);
|
||
})();
|
||
</script>
|
||
|
||
</body>
|
||
</html>
|