mirror of
https://github.com/twbs/bootstrap.git
synced 2024-12-10 22:24:19 +01:00
132 lines
64 KiB
HTML
132 lines
64 KiB
HTML
<!DOCTYPE html> <html lang=en> <head> <meta charset=utf-8> <meta content="IE=edge" http-equiv=X-UA-Compatible> <meta content="width=device-width,initial-scale=1" name=viewport> <meta content="Bootstrap, a sleek, intuitive, and powerful mobile first front-end framework for faster and easier web development." name=description> <meta content="Mark Otto, Jacob Thornton, and Bootstrap contributors" name=author> <title> Getting started · Bootstrap </title> <link href=../dist/css/bootstrap.min.css rel=stylesheet> <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> <!--[if lt IE 9]> <script src=https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js></script> <script src=https://oss.maxcdn.com/respond/1.4.2/respond.min.js></script> <![endif]--> <link href=/apple-touch-icon.png rel=apple-touch-icon> <link href=/favicon.ico rel=icon> <script>!function(e,t,a,n,c,o,s){e.GoogleAnalyticsObject=c,e[c]=e[c]||function(){(e[c].q=e[c].q||[]).push(arguments)},e[c].l=1*new Date,o=t.createElement(a),s=t.getElementsByTagName(a)[0],o.async=1,o.src=n,s.parentNode.insertBefore(o,s)}(window,document,"script","//www.google-analytics.com/analytics.js","ga"),ga("create","UA-146052-10","getbootstrap.com"),ga("send","pageview")</script> </head> <body> <a href=#content class="sr-only sr-only-focusable" id=skippy><div class=container><span class=skiplink-text>Skip to main content</span></div></a> <a href=http://blog.getbootstrap.com/2016/09/05/bootstrap-4-alpha-4/ class=v4-tease>Aww yeah, Bootstrap 4 is coming!</a> <header class="bs-docs-nav navbar navbar-static-top" id=top> <div class=container> <div class=navbar-header> <button aria-controls=bs-navbar aria-expanded=false class="collapsed navbar-toggle" data-target=#bs-navbar data-toggle=collapse type=button> <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" id=bs-navbar> <ul class="nav navbar-nav"> <li class=active> <a href=../getting-started/ >Getting started</a> </li> <li> <a href=../css/ >CSS</a> </li> <li> <a href=../components/ >Components</a> </li> <li> <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://themes.getbootstrap.com onclick='ga("send","event","Navbar","Community links","Themes")'>Themes</a></li> <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> <div class=bs-docs-header id=content tabindex=-1> <div class=container> <h1>Getting started</h1> <p>An overview of Bootstrap, how to download and use, basic templates and examples, and more.</p> <div id=carbonads-container><div class=carbonad><div id=azcarbon></div><script>var z=document.createElement("script");z.async=!0,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 class=page-header id=download>Download</h1> <p class=lead>Bootstrap (currently v3.3.7) has a few easy ways to quickly get started, each one appealing to a different skill level and use case. Read through to see what suits your particular needs.</p> <div class="row bs-downloads"> <div class=col-sm-4> <h3 id=download-bootstrap>Bootstrap</h3> <p>Compiled and minified CSS, JavaScript, and fonts. No docs or original source files are included.</p> <p> <a href=https://github.com/twbs/bootstrap/releases/download/v3.3.7/bootstrap-3.3.7-dist.zip class="btn btn-lg btn-outline" onclick='ga("send","event","Getting started","Download","Download compiled")'>Download Bootstrap</a> </p> </div> <div class=col-sm-4> <h3 id=download-source>Source code</h3> <p>Source Less, JavaScript, and font files, along with our docs. <strong>Requires a Less compiler and <a href=#grunt>some setup.</a></strong></p> <p> <a href=https://github.com/twbs/bootstrap/archive/v3.3.7.zip class="btn btn-lg btn-outline" onclick='ga("send","event","Getting started","Download","Download source")'>Download source</a> </p> </div> <div class=col-sm-4> <h3 id=download-sass>Sass</h3> <p><a href=https://github.com/twbs/bootstrap-sass>Bootstrap ported from Less to Sass</a> for easy inclusion in Rails, Compass, or Sass-only projects.</p> <p> <a href=https://github.com/twbs/bootstrap-sass/archive/v3.3.7.tar.gz class="btn btn-lg btn-outline" onclick='ga("send","event","Getting started","Download","Download Sass")'>Download Sass</a> </p> </div> </div> <h2 id=download-cdn>Bootstrap CDN</h2> <p>The folks over at <a href=https://www.maxcdn.com/ >MaxCDN</a> graciously provide CDN support for Bootstrap's CSS and JavaScript. Just use these <a href=https://www.bootstrapcdn.com/ >Bootstrap CDN</a> links.</p> <figure class=highlight><pre><code class=language-html data-lang=html><span class=c><!-- Latest compiled and minified CSS --></span>
|
|
<span class=nt><link</span> <span class=na>rel=</span><span class=s>"stylesheet"</span> <span class=na>href=</span><span class=s>"https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"</span> <span class=na>integrity=</span><span class=s>"sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u"</span> <span class=na>crossorigin=</span><span class=s>"anonymous"</span><span class=nt>></span>
|
|
|
|
<span class=c><!-- Optional theme --></span>
|
|
<span class=nt><link</span> <span class=na>rel=</span><span class=s>"stylesheet"</span> <span class=na>href=</span><span class=s>"https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap-theme.min.css"</span> <span class=na>integrity=</span><span class=s>"sha384-rHyoN1iRsVXV4nD0JutlnGaslCJuC7uwjduW9SVrLvRYooPp2bWYgmgJQIXwl/Sp"</span> <span class=na>crossorigin=</span><span class=s>"anonymous"</span><span class=nt>></span>
|
|
|
|
<span class=c><!-- Latest compiled and minified JavaScript --></span>
|
|
<span class=nt><script </span><span class=na>src=</span><span class=s>"https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"</span> <span class=na>integrity=</span><span class=s>"sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa"</span> <span class=na>crossorigin=</span><span class=s>"anonymous"</span><span class=nt>></script></span></code></pre></figure> <h2 id=download-bower>Install with Bower</h2> <p>You can also install and manage Bootstrap's Less, CSS, JavaScript, and fonts using <a href=http://bower.io>Bower</a>:</p> <figure class=highlight><pre><code class=language-bash data-lang=bash><span class=gp>$ </span>bower install bootstrap</code></pre></figure> <h2 id=download-npm>Install with npm</h2> <p>You can also install Bootstrap using <a href=https://www.npmjs.com>npm</a>:</p> <figure class=highlight><pre><code class=language-bash data-lang=bash><span class=gp>$ </span>npm install bootstrap@3</code></pre></figure> <p><code>require('bootstrap')</code> will load all of Bootstrap's jQuery plugins onto the jQuery object. The <code>bootstrap</code> module itself does not export anything. You can manually load Bootstrap's jQuery plugins individually by loading the <code>/js/*.js</code> files under the package's top-level directory.</p> <p>Bootstrap's <code>package.json</code> contains some additional metadata under the following keys:</p> <ul> <li><code>less</code> - path to Bootstrap's main <a href=http://lesscss.org>Less</a> source file</li> <li><code>style</code> - path to Bootstrap's non-minified CSS that's been precompiled using the default settings (no customization)</li> </ul> <h2 id=download-composer>Install with Composer</h2> <p>You can also install and manage Bootstrap's Less, CSS, JavaScript, and fonts using <a href=https://getcomposer.org>Composer</a>:</p> <figure class=highlight><pre><code class=language-bash data-lang=bash><span class=gp>$ </span>composer require twbs/bootstrap</code></pre></figure> <h2 id=download-autoprefixer>Autoprefixer required for Less/Sass</h2> <p>Bootstrap uses <a href=https://github.com/postcss/autoprefixer>Autoprefixer</a> to deal with <a href=http://webdesign.about.com/od/css/a/css-vendor-prefixes.htm>CSS vendor prefixes</a>. If you're compiling Bootstrap from its Less/Sass source and not using our Gruntfile, you'll need to integrate Autoprefixer into your build process yourself. If you're using precompiled Bootstrap or using our Gruntfile, you don't need to worry about this because Autoprefixer is already integrated into our Gruntfile.</p> </div> <div class=bs-docs-section> <h1 class=page-header id=whats-included>What's included</h1> <p class=lead>Bootstrap is downloadable in two forms, within which you'll find the following directories and files, logically grouping common resources and providing both compiled and minified variations.</p> <div class="bs-callout bs-callout-warning" id=jquery-required> <h4>jQuery required</h4> <p>Please note that <strong>all JavaScript plugins require jQuery</strong> to be included, as shown in the <a href=#template>starter template</a>. <a href=https://github.com/twbs/bootstrap/blob/v3.3.7/bower.json>Consult our <code>bower.json</code></a> to see which versions of jQuery are supported.</p> </div> <h2 id=whats-included-precompiled>Precompiled Bootstrap</h2> <p>Once downloaded, unzip the compressed folder to see the structure of (the compiled) Bootstrap. You'll see something like this:</p> <figure class=highlight><pre><code class=language-bash data-lang=bash>bootstrap/
|
|
├── css/
|
|
│ ├── bootstrap.css
|
|
│ ├── bootstrap.css.map
|
|
│ ├── bootstrap.min.css
|
|
│ ├── bootstrap.min.css.map
|
|
│ ├── bootstrap-theme.css
|
|
│ ├── bootstrap-theme.css.map
|
|
│ ├── bootstrap-theme.min.css
|
|
│ └── bootstrap-theme.min.css.map
|
|
├── js/
|
|
│ ├── bootstrap.js
|
|
│ └── bootstrap.min.js
|
|
└── fonts/
|
|
├── glyphicons-halflings-regular.eot
|
|
├── glyphicons-halflings-regular.svg
|
|
├── glyphicons-halflings-regular.ttf
|
|
├── glyphicons-halflings-regular.woff
|
|
└── glyphicons-halflings-regular.woff2</code></pre></figure> <p>This is the most basic form of Bootstrap: precompiled files for quick drop-in usage in nearly any web project. We provide compiled CSS and JS (<code>bootstrap.*</code>), as well as compiled and minified CSS and JS (<code>bootstrap.min.*</code>). CSS <a href=https://developer.chrome.com/devtools/docs/css-preprocessors>source maps</a> (<code>bootstrap.*.map</code>) are available for use with certain browsers' developer tools. Fonts from Glyphicons are included, as is the optional Bootstrap theme.</p> <h2 id=whats-included-source>Bootstrap source code</h2> <p>The Bootstrap source code download includes the precompiled CSS, JavaScript, and font assets, along with source Less, JavaScript, and documentation. More specifically, it includes the following and more:</p> <figure class=highlight><pre><code class=language-bash data-lang=bash>bootstrap/
|
|
├── less/
|
|
├── js/
|
|
├── fonts/
|
|
├── dist/
|
|
│ ├── css/
|
|
│ ├── js/
|
|
│ └── fonts/
|
|
└── docs/
|
|
└── examples/</code></pre></figure> <p>The <code>less/</code>, <code>js/</code>, and <code>fonts/</code> are the source code for our CSS, JS, and icon fonts (respectively). The <code>dist/</code> folder includes everything listed in the precompiled download section above. The <code>docs/</code> folder includes the source code for our documentation, and <code>examples/</code> of Bootstrap usage. Beyond that, any other included file provides support for packages, license information, and development.</p> </div> <div class=bs-docs-section> <h1 class=page-header id=grunt>Compiling CSS and JavaScript</h1> <p class=lead>Bootstrap uses <a href=http://gruntjs.com>Grunt</a> for its build system, with convenient methods for working with the framework. It's how we compile our code, run tests, and more.</p> <h2 id=grunt-installing>Installing Grunt</h2> <p>To install Grunt, you must <strong>first <a href=https://nodejs.org/download/ >download and install node.js</a></strong> (which includes npm). npm stands for <a href=https://www.npmjs.com/ >node packaged modules</a> and is a way to manage development dependencies through node.js.</p> Then, from the command line: <ol> <li>Install <code>grunt-cli</code> globally with <code>npm install -g grunt-cli</code>.</li> <li>Navigate to the root <code>/bootstrap/</code> directory, then run <code>npm install</code>. npm will look at the <a href=https://github.com/twbs/bootstrap/blob/master/package.json><code>package.json</code></a> file and automatically install the necessary local dependencies listed there.</li> </ol> <p>When completed, you'll be able to run the various Grunt commands provided from the command line.</p> <h2 id=grunt-commands>Available Grunt commands</h2> <h3><code>grunt dist</code> (Just compile CSS and JavaScript)</h3> <p>Regenerates the <code>/dist/</code> directory with compiled and minified CSS and JavaScript files. As a Bootstrap user, this is normally the command you want.</p> <h3><code>grunt watch</code> (Watch)</h3> <p>Watches the Less source files and automatically recompiles them to CSS whenever you save a change.</p> <h3><code>grunt test</code> (Run tests)</h3> <p>Runs <a href=http://jshint.com>JSHint</a> and runs the <a href=http://qunitjs.com>QUnit</a> tests headlessly in <a href=http://phantomjs.org>PhantomJS</a>.</p> <h3><code>grunt docs</code> (Build & test the docs assets)</h3> <p>Builds and tests CSS, JavaScript, and other assets which are used when running the documentation locally via <code>bundle exec jekyll serve</code>.</p> <h3><code>grunt</code> (Build absolutely everything and run tests)</h3> <p>Compiles and minifies CSS and JavaScript, builds the documentation website, runs the HTML5 validator against the docs, regenerates the Customizer assets, and more. Requires <a href=http://jekyllrb.com/docs/installation/ >Jekyll</a>. Usually only necessary if you're hacking on Bootstrap itself.</p> <h2 id=grunt-troubleshooting>Troubleshooting</h2> <p>Should you encounter problems with installing dependencies or running Grunt commands, first delete the <code>/node_modules/</code> directory generated by npm. Then, rerun <code>npm install</code>.</p> </div> <div class=bs-docs-section> <h1 class=page-header id=template>Basic template</h1> <p class=lead>Start with this basic HTML template, or modify <a href=#examples>these examples</a>. We hope you'll customize our templates and examples, adapting them to suit your needs.</p> <p>Copy the HTML below to begin working with a minimal Bootstrap document.</p> <figure class=highlight><pre><code class=language-html data-lang=html><span class=cp><!DOCTYPE html></span>
|
|
<span class=nt><html</span> <span class=na>lang=</span><span class=s>"en"</span><span class=nt>></span>
|
|
<span class=nt><head></span>
|
|
<span class=nt><meta</span> <span class=na>charset=</span><span class=s>"utf-8"</span><span class=nt>></span>
|
|
<span class=nt><meta</span> <span class=na>http-equiv=</span><span class=s>"X-UA-Compatible"</span> <span class=na>content=</span><span class=s>"IE=edge"</span><span class=nt>></span>
|
|
<span class=nt><meta</span> <span class=na>name=</span><span class=s>"viewport"</span> <span class=na>content=</span><span class=s>"width=device-width, initial-scale=1"</span><span class=nt>></span>
|
|
<span class=c><!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --></span>
|
|
<span class=nt><title></span>Bootstrap 101 Template<span class=nt></title></span>
|
|
|
|
<span class=c><!-- Bootstrap --></span>
|
|
<span class=nt><link</span> <span class=na>href=</span><span class=s>"css/bootstrap.min.css"</span> <span class=na>rel=</span><span class=s>"stylesheet"</span><span class=nt>></span>
|
|
|
|
<span class=c><!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --></span>
|
|
<span class=c><!-- WARNING: Respond.js doesn't work if you view the page via file:// --></span>
|
|
<span class=c><!--[if lt IE 9]>
|
|
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
<![endif]--></span>
|
|
<span class=nt></head></span>
|
|
<span class=nt><body></span>
|
|
<span class=nt><h1></span>Hello, world!<span class=nt></h1></span>
|
|
|
|
<span class=c><!-- jQuery (necessary for Bootstrap's JavaScript plugins) --></span>
|
|
<span class=nt><script </span><span class=na>src=</span><span class=s>"https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"</span><span class=nt>></script></span>
|
|
<span class=c><!-- Include all compiled plugins (below), or include individual files as needed --></span>
|
|
<span class=nt><script </span><span class=na>src=</span><span class=s>"js/bootstrap.min.js"</span><span class=nt>></script></span>
|
|
<span class=nt></body></span>
|
|
<span class=nt></html></span></code></pre></figure> </div> <div class=bs-docs-section> <h1 class=page-header id=examples>Examples</h1> <p class=lead>Build on the basic template above with Bootstrap's many components. We encourage you to customize and adapt Bootstrap to suit your individual project's needs.</p> <p>Get the source code for every example below by <a href=https://github.com/twbs/bootstrap/archive/v3.3.7.zip>downloading the Bootstrap repository</a>. Examples can be found in the <code>docs/examples/</code> directory.</p> <h2 id=examples-framework>Using the framework</h2> <div class="row bs-examples"> <div class="col-xs-6 col-md-4"> <a href=../examples/starter-template/ class=thumbnail> <img alt="Starter template example" src=../examples/screenshots/starter-template.jpg> </a> <h3>Starter template</h3> <p>Nothing but the basics: compiled CSS and JavaScript along with a container.</p> </div> <div class="col-xs-6 col-md-4"> <a href=../examples/theme/ class=thumbnail> <img alt="Bootstrap theme example" src=../examples/screenshots/theme.jpg> </a> <h3>Bootstrap theme</h3> <p>Load the optional Bootstrap theme for a visually enhanced experience.</p> </div> <div class="clearfix visible-xs"></div> <div class="col-xs-6 col-md-4"> <a href=../examples/grid/ class=thumbnail> <img alt="Multiple grids example" src=../examples/screenshots/grid.jpg> </a> <h3>Grids</h3> <p>Multiple examples of grid layouts with all four tiers, nesting, and more.</p> </div> <div class="col-xs-6 col-md-4"> <a href=../examples/jumbotron/ class=thumbnail> <img alt="Jumbotron example" src=../examples/screenshots/jumbotron.jpg> </a> <h3>Jumbotron</h3> <p>Build around the jumbotron with a navbar and some basic grid columns.</p> </div> <div class="clearfix visible-xs"></div> <div class="col-xs-6 col-md-4"> <a href=../examples/jumbotron-narrow/ class=thumbnail> <img alt="Narrow jumbotron example" src=../examples/screenshots/jumbotron-narrow.jpg> </a> <h3>Narrow jumbotron</h3> <p>Build a more custom page by narrowing the default container and jumbotron.</p> </div> </div> <h2 id=examples-navbars>Navbars in action</h2> <div class="row bs-examples"> <div class="col-xs-6 col-md-4"> <a href=../examples/navbar/ class=thumbnail> <img alt="Navbar example" src=../examples/screenshots/navbar.jpg> </a> <h3>Navbar</h3> <p>Super basic template that includes the navbar along with some additional content.</p> </div> <div class="col-xs-6 col-md-4"> <a href=../examples/navbar-static-top/ class=thumbnail> <img alt="Static top navbar example" src=../examples/screenshots/navbar-static.jpg> </a> <h3>Static top navbar</h3> <p>Super basic template with a static top navbar along with some additional content.</p> </div> <div class="clearfix visible-xs"></div> <div class="col-xs-6 col-md-4"> <a href=../examples/navbar-fixed-top/ class=thumbnail> <img alt="Fixed navbar example" src=../examples/screenshots/navbar-fixed.jpg> </a> <h3>Fixed navbar</h3> <p>Super basic template with a fixed top navbar along with some additional content.</p> </div> </div> <h2 id=examples-custom>Custom components</h2> <div class="row bs-examples"> <div class="col-xs-6 col-md-4"> <a href=../examples/cover/ class=thumbnail> <img alt="A one-page template example" src=../examples/screenshots/cover.jpg> </a> <h3>Cover</h3> <p>A one-page template for building simple and beautiful home pages.</p> </div> <div class="col-xs-6 col-md-4"> <a href=../examples/carousel/ class=thumbnail> <img alt="Carousel example" src=../examples/screenshots/carousel.jpg> </a> <h3>Carousel</h3> <p>Customize the navbar and carousel, then add some new components.</p> </div> <div class="clearfix visible-xs"></div> <div class="col-xs-6 col-md-4"> <a href=../examples/blog/ class=thumbnail> <img alt="Blog layout example" src=../examples/screenshots/blog.jpg> </a> <h3>Blog</h3> <p>Simple two-column blog layout with custom navigation, header, and type.</p> </div> <div class="col-xs-6 col-md-4"> <a href=../examples/dashboard/ class=thumbnail> <img alt="Dashboard example" src=../examples/screenshots/dashboard.jpg> </a> <h3>Dashboard</h3> <p>Basic structure for an admin dashboard with fixed sidebar and navbar.</p> </div> <div class="clearfix visible-xs"></div> <div class="col-xs-6 col-md-4"> <a href=../examples/signin/ class=thumbnail> <img alt="Sign-in page example" src=../examples/screenshots/sign-in.jpg> </a> <h3>Sign-in page</h3> <p>Custom form layout and design for a simple sign in form.</p> </div> <div class="col-xs-6 col-md-4"> <a href=../examples/justified-nav/ class=thumbnail> <img alt="Justified nav example" src=../examples/screenshots/justified-nav.jpg> </a> <h3>Justified nav</h3> <p>Create a custom navbar with justified links. Heads up! <a href=../components/#nav-justified>Not too Safari friendly.</a></p> </div> <div class="clearfix visible-xs"></div> <div class="col-xs-6 col-md-4"> <a href=../examples/sticky-footer/ class=thumbnail> <img alt="Sticky footer example" src=../examples/screenshots/sticky-footer.jpg> </a> <h3>Sticky footer</h3> <p>Attach a footer to the bottom of the viewport when the content is shorter than it.</p> </div> <div class="col-xs-6 col-md-4"> <a href=../examples/sticky-footer-navbar/ class=thumbnail> <img alt="Sticky footer with navbar example" src=../examples/screenshots/sticky-footer-navbar.jpg> </a> <h3>Sticky footer with navbar</h3> <p>Attach a footer to the bottom of the viewport with a fixed navbar at the top.</p> </div> </div> <h2 id=examples-experiments>Experiments</h2> <div class="row bs-examples"> <div class="col-xs-6 col-md-4"> <a href=../examples/non-responsive/ class=thumbnail> <img alt="Non-responsive example" src=../examples/screenshots/non-responsive.jpg> </a> <h3>Non-responsive Bootstrap</h3> <p>Easily disable the responsiveness of Bootstrap <a href=#disable-responsive>per our docs</a>.</p> </div> <div class="col-xs-6 col-md-4"> <a href=../examples/offcanvas/ class=thumbnail> <img alt="Off-canvas navigation example" src=../examples/screenshots/offcanvas.jpg> </a> <h3>Off-canvas</h3> <p>Build a toggleable off-canvas navigation menu for use with Bootstrap.</p> </div> </div> </div> <div class=bs-docs-section> <h1 class=page-header id=tools>Tools</h1> <h2 id=tools-bootlint>Bootlint</h2> <p><strong><a href=https://github.com/twbs/bootlint>Bootlint</a></strong> is the official Bootstrap HTML <a href=http://en.wikipedia.org/wiki/Lint_(software)>linter</a> tool. It automatically checks for several common HTML mistakes in webpages that are using Bootstrap in a fairly "vanilla" way. Vanilla Bootstrap's components/widgets require their parts of the DOM to conform to certain structures. Bootlint checks that instances of Bootstrap components have correctly-structured HTML. Consider adding Bootlint to your Bootstrap web development toolchain so that none of the common mistakes slow down your project's development.</p> </div> <div class=bs-docs-section> <h1 class=page-header id=community>Community</h1> <p class=lead>Stay up to date on the development of Bootstrap and reach out to the community with these helpful resources.</p> <ul> <li>Read and subscribe to <a href=http://blog.getbootstrap.com/ >The Official Bootstrap Blog</a>.</li> <li>Chat with fellow Bootstrappers using IRC in the <code>irc.freenode.net</code> server, in the <a href=irc://irc.freenode.net/%23bootstrap>##bootstrap channel</a>.</li> <li>For help using Bootstrap, ask on <a href=https://stackoverflow.com/questions/tagged/twitter-bootstrap-3>StackOverflow using the tag <code>twitter-bootstrap-3</code></a>.</li> <li>Developers should use the keyword <code>bootstrap</code> on packages which modify or add to the functionality of Bootstrap when distributing through <a href=https://www.npmjs.com/browse/keyword/bootstrap>npm</a> or similar delivery mechanisms for maximum discoverability.</li> <li>Find inspiring examples of people building with Bootstrap at the <a href=http://expo.getbootstrap.com>Bootstrap Expo</a>.</li> </ul> <p>You can also follow <a href=https://twitter.com/getbootstrap>@getbootstrap on Twitter</a> for the latest gossip and awesome music videos.</p> </div> <div class=bs-docs-section> <h1 class=page-header id=disable-responsive>Disabling responsiveness</h1> <p class=lead>Bootstrap automatically adapts your pages for various screen sizes. Here's how to disable this feature so your page works like <a href=../examples/non-responsive/ >this non-responsive example</a>.</p> <h2>Steps to disable page responsiveness</h2> <ol> <li>Omit the viewport <code><meta></code> mentioned in <a href=../css/#overview-mobile>the CSS docs</a></li> <li>Override the <code>width</code> on the <code>.container</code> for each grid tier with a single width, for example <code>width: 970px !important;</code> Be sure that this comes after the default Bootstrap CSS. You can optionally avoid the <code>!important</code> with media queries or some selector-fu.</li> <li>If using navbars, remove all navbar collapsing and expanding behavior.</li> <li>For grid layouts, use <code>.col-xs-*</code> classes in addition to, or in place of, the medium/large ones. Don't worry, the extra-small device grid scales to all resolutions.</li> </ol> <p>You'll still need Respond.js for IE8 (since our media queries are still there and need to be processed). This disables the "mobile site" aspects of Bootstrap.</p> <h2>Bootstrap template with responsiveness disabled</h2> <p>We've applied these steps to an example. Read its source code to see the specific changes implemented.</p> <p> <a href=../examples/non-responsive/ class="btn btn-primary">View non-responsive example</a> </p> </div> <div class="bs-callout bs-callout-info" id=migration> <h4>Migrating from v2.x to v3.x</h4> <p>Looking to migrate from an older version of Bootstrap to v3.x? Check out <a href=../migration>our migration guide</a>.</p> </div> <div class=bs-docs-section> <h1 class=page-header id=support>Browser and device support</h1> <p class=lead>Bootstrap is built to work best in the latest desktop and mobile browsers, meaning older browsers might display differently styled, though fully functional, renderings of certain components.</p> <h2 id=support-browsers>Supported browsers</h2> <p>Specifically, we support the <strong>latest versions</strong> of the following browsers and platforms.</p> <p>Alternative browsers which use the latest version of WebKit, Blink, or Gecko, whether directly or via the platform's web view API, are not explicitly supported. However, Bootstrap should (in most cases) display and function correctly in these browsers as well. More specific support information is provided below.</p> <h3 id=mobile-devices>Mobile devices</h3> <p>Generally speaking, Bootstrap supports the latest versions of each major platform's default browsers. Note that proxy browsers (such as Opera Mini, Opera Mobile's Turbo mode, UC Browser Mini, Amazon Silk) are not supported.</p> <div class=table-responsive> <table class="table table-bordered table-striped"> <thead> <tr> <td></td> <th>Chrome</th> <th>Firefox</th> <th>Safari</th> </tr> </thead> <tbody> <tr> <th scope=row>Android</th> <td class=text-success><span class="glyphicon glyphicon-ok" aria-hidden=true></span> Supported</td> <td class=text-success><span class="glyphicon glyphicon-ok" aria-hidden=true></span> Supported</td> <td class=text-muted>N/A</td> </tr> <tr> <th scope=row>iOS</th> <td class=text-success><span class="glyphicon glyphicon-ok" aria-hidden=true></span> Supported</td> <td class=text-success><span class="glyphicon glyphicon-ok" aria-hidden=true></span> Supported</td> <td class=text-success><span class="glyphicon glyphicon-ok" aria-hidden=true></span> Supported</td> </tr> </tbody> </table> </div> <h3 id=desktop-browsers>Desktop browsers</h3> <p>Similarly, the latest versions of most desktop browsers are supported.</p> <div class=table-responsive> <table class="table table-bordered table-striped"> <thead> <tr> <td></td> <th>Chrome</th> <th>Firefox</th> <th>Internet Explorer</th> <th>Opera</th> <th>Safari</th> </tr> </thead> <tbody> <tr> <th scope=row>Mac</th> <td class=text-success><span class="glyphicon glyphicon-ok" aria-hidden=true></span> Supported</td> <td class=text-success><span class="glyphicon glyphicon-ok" aria-hidden=true></span> Supported</td> <td class=text-muted>N/A</td> <td class=text-success><span class="glyphicon glyphicon-ok" aria-hidden=true></span> Supported</td> <td class=text-success><span class="glyphicon glyphicon-ok" aria-hidden=true></span> Supported</td> </tr> <tr> <th scope=row>Windows</th> <td class=text-success><span class="glyphicon glyphicon-ok" aria-hidden=true></span> Supported</td> <td class=text-success><span class="glyphicon glyphicon-ok" aria-hidden=true></span> Supported</td> <td class=text-success><span class="glyphicon glyphicon-ok" aria-hidden=true></span> Supported</td> <td class=text-success><span class="glyphicon glyphicon-ok" aria-hidden=true></span> Supported</td> <td class=text-danger><span class="glyphicon glyphicon-remove" aria-hidden=true></span> Not supported</td> </tr> </tbody> </table> </div> <p>On Windows, <strong>we support Internet Explorer 8-11</strong>.</p> <p>For Firefox, in addition to the latest normal stable release, we also support the latest <a href=https://www.mozilla.org/en-US/firefox/organizations/faq/ >Extended Support Release (ESR)</a> version of Firefox.</p> <p>Unofficially, Bootstrap should look and behave well enough in Chromium and Chrome for Linux, Firefox for Linux, and Internet Explorer 7, as well as Microsoft Edge, though they are not officially supported.</p> <p>For a list of some of the browser bugs that Bootstrap has to grapple with, see our <a href=../browser-bugs/ >Wall of browser bugs</a>.</p> <h2 id=support-ie8-ie9>Internet Explorer 8 and 9</h2> <p>Internet Explorer 8 and 9 are also supported, however, please be aware that some CSS3 properties and HTML5 elements are not fully supported by these browsers. In addition, <strong>Internet Explorer 8 requires the use of <a href=https://github.com/scottjehl/Respond>Respond.js</a> to enable media query support.</strong></p> <div class=table-responsive> <table class="table table-bordered table-striped"> <thead> <tr> <th class=col-xs-4>Feature</th> <th class=col-xs-4>Internet Explorer 8</th> <th class=col-xs-4>Internet Explorer 9</th> </tr> </thead> <tbody> <tr> <th scope=row><code>border-radius</code></th> <td class=text-danger><span class="glyphicon glyphicon-remove" aria-hidden=true></span> Not supported</td> <td class=text-success><span class="glyphicon glyphicon-ok" aria-hidden=true></span> Supported</td> </tr> <tr> <th scope=row><code>box-shadow</code></th> <td class=text-danger><span class="glyphicon glyphicon-remove" aria-hidden=true></span> Not supported</td> <td class=text-success><span class="glyphicon glyphicon-ok" aria-hidden=true></span> Supported</td> </tr> <tr> <th scope=row><code>transform</code></th> <td class=text-danger><span class="glyphicon glyphicon-remove" aria-hidden=true></span> Not supported</td> <td class=text-success><span class="glyphicon glyphicon-ok" aria-hidden=true></span> Supported, with <code>-ms</code> prefix</td> </tr> <tr> <th scope=row><code>transition</code></th> <td colspan=2 class=text-danger><span class="glyphicon glyphicon-remove" aria-hidden=true></span> Not supported</td> </tr> <tr> <th scope=row><code>placeholder</code></th> <td colspan=2 class=text-danger><span class="glyphicon glyphicon-remove" aria-hidden=true></span> Not supported</td> </tr> </tbody> </table> </div> <p>Visit <a href=http://caniuse.com/ >Can I use...</a> for details on browser support of CSS3 and HTML5 features.</p> <h2 id=support-ie8-respondjs>Internet Explorer 8 and Respond.js</h2> <p>Beware of the following caveats when using Respond.js in your development and production environments for Internet Explorer 8.</p> <h3 id=respond-js-x-domain>Respond.js and cross-domain CSS</h3> <p>Using Respond.js with CSS hosted on a different (sub)domain (for example, on a CDN) requires some additional setup. <a href=https://github.com/scottjehl/Respond/blob/master/README.md#cdnx-domain-setup>See the Respond.js docs</a> for details.</p> <h3 id=respond-file-proto>Respond.js and <code>file://</code></h3> <p>Due to browser security rules, Respond.js doesn't work with pages viewed via the <code>file://</code> protocol (like when opening a local HTML file). To test responsive features in IE8, view your pages over HTTP(S). <a href=https://github.com/scottjehl/Respond/blob/master/README.md#support--caveats>See the Respond.js docs</a> for details.</p> <h3 id=respond-import>Respond.js and <code>@import</code></h3> <p>Respond.js doesn't work with CSS that's referenced via <code>@import</code>. In particular, some Drupal configurations are known to use <code>@import</code>. <a href=https://github.com/scottjehl/Respond/blob/master/README.md#support--caveats>See the Respond.js docs</a> for details.</p> <h2 id=support-ie8-box-sizing>Internet Explorer 8 and box-sizing</h2> <p>IE8 does not fully support <code>box-sizing: border-box;</code> when combined with <code>min-width</code>, <code>max-width</code>, <code>min-height</code>, or <code>max-height</code>. For that reason, as of v3.0.1, we no longer use <code>max-width</code> on <code>.container</code>s.</p> <h2 id=support-ie8-font-face>Internet Explorer 8 and @font-face</h2> <p>IE8 has some issues with <code>@font-face</code> when combined with <code>:before</code>. Bootstrap uses that combination with its Glyphicons. If a page is cached, and loaded without the mouse over the window (i.e. hit the refresh button or load something in an iframe) then the page gets rendered before the font loads. Hovering over the page (body) will show some of the icons and hovering over the remaining icons will show those as well. <a href=https://github.com/twbs/bootstrap/issues/13863>See issue #13863</a> for details.</p> <h2 id=support-ie-compatibility-modes>IE Compatibility modes</h2> <p>Bootstrap is not supported in the old Internet Explorer compatibility modes. To be sure you're using the latest rendering mode for IE, consider including the appropriate <code><meta></code> tag in your pages:</p> <figure class=highlight><pre><code class=language-html data-lang=html><span class=nt><meta</span> <span class=na>http-equiv=</span><span class=s>"X-UA-Compatible"</span> <span class=na>content=</span><span class=s>"IE=edge"</span><span class=nt>></span></code></pre></figure> <p>Confirm the document mode by opening the debugging tools: press <kbd>F12</kbd> and check the "Document Mode".</p> <p>This tag is included in all of Bootstrap's documentation and examples to ensure the best rendering possible in each supported version of Internet Explorer.</p> <p>See <a href=https://stackoverflow.com/questions/6771258/whats-the-difference-if-meta-http-equiv-x-ua-compatible-content-ie-edge>this StackOverflow question</a> for more information.</p> <h2 id=support-ie10-width>Internet Explorer 10 in Windows 8 and Windows Phone 8</h2> <p>Internet Explorer 10 doesn't differentiate <strong>device width</strong> from <strong>viewport width</strong>, and thus doesn't properly apply the media queries in Bootstrap's CSS. Normally you'd just add a quick snippet of CSS to fix this:</p> <figure class=highlight><pre><code class=language-scss data-lang=scss><span class=k>@-ms-viewport</span> <span class=p>{</span> <span class=nl>width</span><span class=p>:</span> <span class=n>device-width</span><span class=p>;</span> <span class=p>}</span></code></pre></figure> <p>However, this doesn't work for devices running Windows Phone 8 versions older than <a href=http://blogs.windows.com/windows_phone/b/wpdev/archive/2013/10/14/introducing-windows-phone-preview-for-developers.aspx>Update 3 (a.k.a. GDR3)</a>, as it causes such devices to show a mostly desktop view instead of narrow "phone" view. To address this, you'll need to <strong>include the following CSS and JavaScript to work around the bug</strong>.</p> <figure class=highlight><pre><code class=language-scss data-lang=scss><span class=k>@-ms-viewport</span> <span class=p>{</span> <span class=nl>width</span><span class=p>:</span> <span class=n>device-width</span><span class=p>;</span> <span class=p>}</span>
|
|
<span class=k>@-o-viewport</span> <span class=p>{</span> <span class=nl>width</span><span class=p>:</span> <span class=n>device-width</span><span class=p>;</span> <span class=p>}</span>
|
|
<span class=k>@viewport</span> <span class=p>{</span> <span class=nl>width</span><span class=p>:</span> <span class=n>device-width</span><span class=p>;</span> <span class=p>}</span></code></pre></figure> <figure class=highlight><pre><code class=language-js data-lang=js><span class=c1>// Copyright 2014-2015 Twitter, Inc.</span>
|
|
<span class=c1>// Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)</span>
|
|
<span class=k>if</span> <span class=p>(</span><span class=nx>navigator</span><span class=p>.</span><span class=nx>userAgent</span><span class=p>.</span><span class=nx>match</span><span class=p>(</span><span class=sr>/IEMobile</span><span class=se>\/</span><span class=sr>10</span><span class=se>\.</span><span class=sr>0/</span><span class=p>))</span> <span class=p>{</span>
|
|
<span class=kd>var</span> <span class=nx>msViewportStyle</span> <span class=o>=</span> <span class=nb>document</span><span class=p>.</span><span class=nx>createElement</span><span class=p>(</span><span class=s1>'style'</span><span class=p>)</span>
|
|
<span class=nx>msViewportStyle</span><span class=p>.</span><span class=nx>appendChild</span><span class=p>(</span>
|
|
<span class=nb>document</span><span class=p>.</span><span class=nx>createTextNode</span><span class=p>(</span>
|
|
<span class=s1>'@-ms-viewport{width:auto!important}'</span>
|
|
<span class=p>)</span>
|
|
<span class=p>)</span>
|
|
<span class=nb>document</span><span class=p>.</span><span class=nx>querySelector</span><span class=p>(</span><span class=s1>'head'</span><span class=p>).</span><span class=nx>appendChild</span><span class=p>(</span><span class=nx>msViewportStyle</span><span class=p>)</span>
|
|
<span class=p>}</span></code></pre></figure> <p>For more information and usage guidelines, read <a href=http://timkadlec.com/2013/01/windows-phone-8-and-device-width/ >Windows Phone 8 and Device-Width</a>.</p> <p>As a heads up, we include this in all of Bootstrap's documentation and examples as a demonstration.</p> <h2 id=support-safari-percentages>Safari percent rounding</h2> <p>The rendering engine of versions of Safari prior to v7.1 for OS X and Safari for iOS v8.0 had some trouble with the number of decimal places used in our <code>.col-*-1</code> grid classes. So if you had 12 individual grid columns, you'd notice that they came up short compared to other rows of columns. Besides upgrading Safari/iOS, you have some options for workarounds:</p> <ul> <li>Add <code>.pull-right</code> to your last grid column to get the hard-right alignment</li> <li>Tweak your percentages manually to get the perfect rounding for Safari (more difficult than the first option)</li> </ul> <h2 id=support-fixed-position-keyboards>Modals, navbars, and virtual keyboards</h2> <h3>Overflow and scrolling</h3> <p>Support for <code>overflow: hidden</code> on the <code><body></code> element is quite limited in iOS and Android. To that end, when you scroll past the top or bottom of a modal in either of those devices' browsers, the <code><body></code> content will begin to scroll. See <a href="https://bugs.chromium.org/p/chromium/issues/detail?id=175502">Chrome bug #175502</a> (fixed in Chrome v40) and <a href="https://bugs.webkit.org/show_bug.cgi?id=153852">WebKit bug #153852</a>.</p> <h3>iOS text fields and scrolling</h3> <p>As of iOS 9.3, while a modal is open, if the initial touch of a scroll gesture is within the boundary of a textual <code><input></code> or a <code><textarea></code>, the <code><body></code> content underneath the modal will be scrolled instead of the modal itself. See <a href="https://bugs.webkit.org/show_bug.cgi?id=153856">WebKit bug #153856</a>.</p> <h3>Virtual keyboards</h3> <p>Also, note that if you're using a fixed navbar or using inputs within a modal, iOS has a rendering bug that doesn't update the position of fixed elements when the virtual keyboard is triggered. A few workarounds for this include transforming your elements to <code>position: absolute</code> or invoking a timer on focus to try to correct the positioning manually. This is not handled by Bootstrap, so it is up to you to decide which solution is best for your application.</p> <h3>Navbar Dropdowns</h3> <p>The <code>.dropdown-backdrop</code> element isn't used on iOS in the nav because of the complexity of z-indexing. Thus, to close dropdowns in navbars, you must directly click the dropdown element (or <a href=https://developer.mozilla.org/en-US/docs/Web/Events/click#Safari_Mobile>any other element which will fire a click event in iOS</a>).</p> <h2 id=support-browser-zooming>Browser zooming</h2> <p>Page zooming inevitably presents rendering artifacts in some components, both in Bootstrap and the rest of the web. Depending on the issue, we may be able to fix it (search first and then open an issue if need be). However, we tend to ignore these as they often have no direct solution other than hacky workarounds.</p> <h2 id=support-sticky-hover-mobile>Sticky <code>:hover</code>/<code>:focus</code> on mobile</h2> <p>Even though real hovering isn't possible on most touchscreens, most mobile browsers emulate hovering support and make <code>:hover</code> "sticky". In other words, <code>:hover</code> styles start applying after tapping an element and only stop applying after the user taps some other element. This can cause Bootstrap's <code>:hover</code> states to become undesirably "stuck" on such browsers. Some mobile browsers also make <code>:focus</code> similarly sticky. There is currently no simple workaround for these issues other than removing such styles entirely.</p> <h2 id=support-printing>Printing</h2> <p>Even in some modern browsers, printing can be quirky.</p> <p>In particular, as of Chrome v32 and regardless of margin settings, Chrome uses a viewport width significantly narrower than the physical paper size when resolving media queries while printing a webpage. This can result in Bootstrap's extra-small grid being unexpectedly activated when printing. <a href=https://github.com/twbs/bootstrap/issues/12078>See issue #12078</a> and <a href="https://bugs.chromium.org/p/chromium/issues/detail?id=273306">Chrome bug #273306</a> for some details. Suggested workarounds:</p> <ul> <li>Embrace the extra-small grid and make sure your page looks acceptable under it.</li> <li>Customize the values of the <code>@screen-*</code> Less variables so that your printer paper is considered larger than extra-small.</li> <li>Add custom media queries to change the grid size breakpoints for print media only.</li> </ul> <p>Also, as of Safari v8.0, fixed-width <code>.container</code>s can cause Safari to use an unusually small font size when printing. See <a href=https://github.com/twbs/bootstrap/issues/14868>#14868</a> and <a href="https://bugs.webkit.org/show_bug.cgi?id=138192">WebKit bug #138192</a> for more details. One potential workaround for this is adding the following CSS:</p> <figure class=highlight><pre><code class=language-css data-lang=css><span class=k>@media</span> <span class=n>print</span> <span class=p>{</span>
|
|
<span class=nc>.container</span> <span class=p>{</span>
|
|
<span class=nl>width</span><span class=p>:</span> <span class=nb>auto</span><span class=p>;</span>
|
|
<span class=p>}</span>
|
|
<span class=p>}</span></code></pre></figure> <h2 id=support-android-stock-browser>Android stock browser</h2> <p>Out of the box, Android 4.1 (and even some newer releases apparently) ship with the Browser app as the default web browser of choice (as opposed to Chrome). Unfortunately, the Browser app has lots of bugs and inconsistencies with CSS in general.</p> <h3>Select menus</h3> <p>On <code><select></code> elements, the Android stock browser will not display the side controls if there is a <code>border-radius</code> and/or <code>border</code> applied. (See <a href=https://stackoverflow.com/questions/14744437/html-select-box-not-showing-drop-down-arrow-on-android-version-4-0-when-set-with>this StackOverflow question</a> for details.) Use the snippet of code below to remove the offending CSS and render the <code><select></code> as an unstyled element on the Android stock browser. The user agent sniffing avoids interference with Chrome, Safari, and Mozilla browsers.</p> <figure class=highlight><pre><code class=language-html data-lang=html><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=kd>var</span> <span class=nx>nua</span> <span class=o>=</span> <span class=nx>navigator</span><span class=p>.</span><span class=nx>userAgent</span>
|
|
<span class=kd>var</span> <span class=nx>isAndroid</span> <span class=o>=</span> <span class=p>(</span><span class=nx>nua</span><span class=p>.</span><span class=nx>indexOf</span><span class=p>(</span><span class=s1>'Mozilla/5.0'</span><span class=p>)</span> <span class=o>></span> <span class=o>-</span><span class=mi>1</span> <span class=o>&&</span> <span class=nx>nua</span><span class=p>.</span><span class=nx>indexOf</span><span class=p>(</span><span class=s1>'Android '</span><span class=p>)</span> <span class=o>></span> <span class=o>-</span><span class=mi>1</span> <span class=o>&&</span> <span class=nx>nua</span><span class=p>.</span><span class=nx>indexOf</span><span class=p>(</span><span class=s1>'AppleWebKit'</span><span class=p>)</span> <span class=o>></span> <span class=o>-</span><span class=mi>1</span> <span class=o>&&</span> <span class=nx>nua</span><span class=p>.</span><span class=nx>indexOf</span><span class=p>(</span><span class=s1>'Chrome'</span><span class=p>)</span> <span class=o>===</span> <span class=o>-</span><span class=mi>1</span><span class=p>)</span>
|
|
<span class=k>if</span> <span class=p>(</span><span class=nx>isAndroid</span><span class=p>)</span> <span class=p>{</span>
|
|
<span class=nx>$</span><span class=p>(</span><span class=s1>'select.form-control'</span><span class=p>).</span><span class=nx>removeClass</span><span class=p>(</span><span class=s1>'form-control'</span><span class=p>).</span><span class=nx>css</span><span class=p>(</span><span class=s1>'width'</span><span class=p>,</span> <span class=s1>'100%'</span><span class=p>)</span>
|
|
<span class=p>}</span>
|
|
<span class=p>})</span>
|
|
<span class=nt></script></span></code></pre></figure> <p>Want to see an example? <a href=http://jsbin.com/kuvoz/1>Check out this JS Bin demo.</a></p> <h2 id=support-validators>Validators</h2> <p>In order to provide the best possible experience to old and buggy browsers, Bootstrap uses <a href=http://browserhacks.com>CSS browser hacks</a> in several places to target special CSS to certain browser versions in order to work around bugs in the browsers themselves. These hacks understandably cause CSS validators to complain that they are invalid. In a couple places, we also use bleeding-edge CSS features that aren't yet fully standardized, but these are used purely for progressive enhancement.</p> <p>These validation warnings don't matter in practice since the non-hacky portion of our CSS does fully validate and the hacky portions don't interfere with the proper functioning of the non-hacky portion, hence why we deliberately ignore these particular warnings.</p> <p>Our HTML docs likewise have some trivial and inconsequential HTML validation warnings due to our inclusion of a workaround for <a href="https://bugzilla.mozilla.org/show_bug.cgi?id=654072">a certain Firefox bug</a>.</p> </div> <div class=bs-docs-section> <h1 class=page-header id=third-parties>Third party support</h1> <p class=lead>While we don't officially support any third party plugins or add-ons, we do offer some useful advice to help avoid potential issues in your projects.</p> <h2 id=third-box-sizing>Box-sizing</h2> <p>Some third party software, including Google Maps and Google Custom Search Engine, conflict with Bootstrap due to <code>* { box-sizing: border-box; }</code>, a rule which makes it so <code>padding</code> does not affect the final computed width of an element. Learn more about <a href=https://css-tricks.com/box-sizing/ >box model and sizing at CSS Tricks</a>.</p> <p>Depending on the context, you may override as-needed (Option 1) or reset the box-sizing for entire regions (Option 2).</p> <figure class=highlight><pre><code class=language-scss data-lang=scss><span class=cm>/* Box-sizing resets
|
|
*
|
|
* Reset individual elements or override regions to avoid conflicts due to
|
|
* global box model settings of Bootstrap. Two options, individual overrides and
|
|
* region resets, are available as plain CSS and uncompiled Less formats.
|
|
*/</span>
|
|
|
|
<span class=cm>/* Option 1A: Override a single element's box model via CSS */</span>
|
|
<span class=nc>.element</span> <span class=p>{</span>
|
|
<span class=na>-webkit-box-sizing</span><span class=p>:</span> <span class=n>content-box</span><span class=p>;</span>
|
|
<span class=na>-moz-box-sizing</span><span class=p>:</span> <span class=n>content-box</span><span class=p>;</span>
|
|
<span class=nl>box-sizing</span><span class=p>:</span> <span class=n>content-box</span><span class=p>;</span>
|
|
<span class=p>}</span>
|
|
|
|
<span class=cm>/* Option 1B: Override a single element's box model by using a Bootstrap Less mixin */</span>
|
|
<span class=nc>.element</span> <span class=p>{</span>
|
|
<span class=nc>.box-sizing</span><span class=o>(</span><span class=nt>content-box</span><span class=o>)</span><span class=p>;</span>
|
|
<span class=p>}</span>
|
|
|
|
<span class=cm>/* Option 2A: Reset an entire region via CSS */</span>
|
|
<span class=nc>.reset-box-sizing</span><span class=o>,</span>
|
|
<span class=nc>.reset-box-sizing</span> <span class=o>*,</span>
|
|
<span class=nc>.reset-box-sizing</span> <span class=o>*</span><span class=nd>:before</span><span class=o>,</span>
|
|
<span class=nc>.reset-box-sizing</span> <span class=o>*</span><span class=nd>:after</span> <span class=p>{</span>
|
|
<span class=na>-webkit-box-sizing</span><span class=p>:</span> <span class=n>content-box</span><span class=p>;</span>
|
|
<span class=na>-moz-box-sizing</span><span class=p>:</span> <span class=n>content-box</span><span class=p>;</span>
|
|
<span class=nl>box-sizing</span><span class=p>:</span> <span class=n>content-box</span><span class=p>;</span>
|
|
<span class=p>}</span>
|
|
|
|
<span class=cm>/* Option 2B: Reset an entire region with a custom Less mixin */</span>
|
|
<span class=nc>.reset-box-sizing</span> <span class=p>{</span>
|
|
<span class=k>&</span><span class=o>,</span>
|
|
<span class=o>*,</span>
|
|
<span class=o>*</span><span class=nd>:before</span><span class=o>,</span>
|
|
<span class=o>*</span><span class=nd>:after</span> <span class=p>{</span>
|
|
<span class=nc>.box-sizing</span><span class=o>(</span><span class=nt>content-box</span><span class=o>)</span><span class=p>;</span>
|
|
<span class=p>}</span>
|
|
<span class=p>}</span>
|
|
<span class=nc>.element</span> <span class=p>{</span>
|
|
<span class=nc>.reset-box-sizing</span><span class=o>()</span><span class=p>;</span>
|
|
<span class=p>}</span></code></pre></figure> </div> <div class=bs-docs-section> <h1 class=page-header id=accessibility>Accessibility</h1> <p class=lead>Bootstrap follows common web standards and—with minimal extra effort—can be used to create sites that are accessible to those using <abbr title="Assistive Technology" class=initialism>AT</abbr>.</p> <h2>Skip navigation</h2> <p>If your navigation contains many links and comes before the main content in the DOM, add a <code>Skip to main content</code> link before the navigation (for a simple explanation, see this <a href=http://a11yproject.com/posts/skip-nav-links>A11Y Project article on skip navigation links</a>). Using the <code>.sr-only</code> class will visually hide the skip link, and the <code>.sr-only-focusable</code> class will ensure that the link becomes visible once focused (for sighted keyboard users).</p> <div class="bs-callout bs-callout-danger" id=callout-skiplinks> <p>Due to long-standing shortcomings/bugs in Chrome (see <a href="https://code.google.com/p/chromium/issues/detail?id=262171" title="Chromium bug tracker - Issue 262171: Focus should cycle from named anchor">issue 262171 in the Chromium bug tracker</a>) and Internet Explorer (see this article on <a href=http://accessibleculture.org/articles/2010/05/in-page-links/ >in-page links and focus order</a>), you will need to make sure that the target of your skip link is at least programmatically focusable by adding <code>tabindex="-1"</code>.</p> <p>In addition, you may want to explicitly suppress a visible focus indication on the target (particularly as Chrome currently also sets focus on elements with <code>tabindex="-1"</code> when they are clicked with the mouse) with <code>#content:focus { outline: none; }</code>.</p> <p>Note that this bug will also affect any other in-page links your site may be using, rendering them useless for keyboard users. You may consider adding a similar stop-gap fix to all other named anchors / fragment identifiers that act as link targets.</p> </div> <figure class=highlight><pre><code class=language-html data-lang=html><span class=nt><body></span>
|
|
<span class=nt><a</span> <span class=na>href=</span><span class=s>"#content"</span> <span class=na>class=</span><span class=s>"sr-only sr-only-focusable"</span><span class=nt>></span>Skip to main content<span class=nt></a></span>
|
|
...
|
|
<span class=nt><div</span> <span class=na>class=</span><span class=s>"container"</span> <span class=na>id=</span><span class=s>"content"</span> <span class=na>tabindex=</span><span class=s>"-1"</span><span class=nt>></span>
|
|
<span class=c><!-- The main page content --></span>
|
|
<span class=nt></div></span>
|
|
<span class=nt></body></span></code></pre></figure> <h2>Nested headings</h2> <p>When nesting headings (<code><h1></code> - <code><h6></code>), your primary document header should be an <code><h1></code>. Subsequent headings should make logical use of <code><h2></code> - <code><h6></code> such that screen readers can construct a table of contents for your pages.</p> <p>Learn more at <a href=http://squizlabs.github.io/HTML_CodeSniffer/Standards/Section508/ >HTML CodeSniffer</a> and <a href=http://accessibility.psu.edu/headings>Penn State's AccessAbility</a>.</p> <h2>Color contrast</h2> <p>Currently, some of the default color combinations available in Bootstrap (such as the various <a href=../css/#buttons>styled button</a> classes, some of the code highlighting colors used for <a href=../css/#code-block>basic code blocks</a>, the <code>.bg-primary</code> <a href=../css/#helper-classes-backgrounds>contextual background</a> helper class, and the default link color when used on a white background) have a low contrast ratio (below the <a href=http://www.w3.org/TR/WCAG20/#visual-audio-contrast-contrast>recommended ratio of 4.5:1</a>). This can cause problems to users with low vision or who are color blind. These default colors may need to be modified to increase their contrast and legibility.</p> <h2>Additional resources</h2> <ul> <li><a href=https://github.com/squizlabs/HTML_CodeSniffer>"HTML Codesniffer" bookmarklet for identifying accessibility issues</a></li> <li><a href="https://chrome.google.com/webstore/detail/accessibility-developer-t/fpkknkljclfencbdbgkenhalefipecmb?hl=en">Chrome's Accessibility Developer Tools extension</a></li> <li><a href=http://www.paciellogroup.com/resources/contrastanalyser/ >Colour Contrast Analyser</a></li> <li><a href=http://a11yproject.com/ >The A11Y Project</a></li> <li><a href=https://developer.mozilla.org/en-US/docs/Accessibility>MDN accessibility documentation</a></li> </ul> </div> <div class=bs-docs-section> <h1 class=page-header id=license-faqs>License FAQs</h1> <p class=lead>Bootstrap is released under the MIT license and is copyright 2016 Twitter. Boiled down to smaller chunks, it can be described with the following conditions.</p> <h2>It requires you to:</h2> <ul> <li>Keep the license and copyright notice included in Bootstrap's CSS and JavaScript files when you use them in your works</li> </ul> <h2>It permits you to:</h2> <ul> <li>Freely download and use Bootstrap, in whole or in part, for personal, private, company internal, or commercial purposes</li> <li>Use Bootstrap in packages or distributions that you create</li> <li>Modify the source code</li> <li>Grant a sublicense to modify and distribute Bootstrap to third parties not included in the license</li> </ul> <h2>It forbids you to:</h2> <ul> <li>Hold the authors and license owners liable for damages as Bootstrap is provided without warranty</li> <li>Hold the creators or copyright holders of Bootstrap liable</li> <li>Redistribute any piece of Bootstrap without proper attribution</li> <li>Use any marks owned by Twitter in any way that might state or imply that Twitter endorses your distribution</li> <li>Use any marks owned by Twitter in any way that might state or imply that you created the Twitter software in question</li> </ul> <h2>It does not require you to:</h2> <ul> <li>Include the source of Bootstrap itself, or of any modifications you may have made to it, in any redistribution you may assemble that includes it</li> <li>Submit changes that you make to Bootstrap back to the Bootstrap project (though such feedback is encouraged)</li> </ul> <p>The full Bootstrap license is located <a href=https://github.com/twbs/bootstrap/blob/master/LICENSE>in the project repository</a> for more information.</p> </div> <div class=bs-docs-section> <h1 class=page-header id=translations>Translations</h1> <p class=lead>Community members have translated Bootstrap's documentation into various languages. None are officially supported and they may not always be up to date.</p> <ul> <li><a href=http://v3.bootcss.com/ hreflang=zh>Bootstrap 中文文档 (Chinese)</a></li> <li><a href=https://kkbruce.tw/bs3/ hreflang=zh-TW>Bootstrap 3 中文手冊 (Chinese (Traditional))</a></li> <li><a href=http://getbootstrap.dk/ hreflang=da>Bootstrap på Dansk (Danish)</a></li> <li><a href=http://www.oneskyapp.com/fr/docs/bootstrap/getting-started/ hreflang=fr>Bootstrap en Français (French)</a></li> <li><a href=http://holdirbootstrap.de/ hreflang=de>Bootstrap auf Deutsch (German)</a></li> <li><a href=http://www.hackerstribe.com/guide/IT-bootstrap-3.1.1/ hreflang=it>Bootstrap in Italiano (Italian)</a></li> <li><a href=http://bootstrapk.com/ hreflang=ko>Bootstrap 한국어 (Korean)</a></li> <li><a href=http://bootstrapbrasil.github.io/ hreflang=pt-BR>Bootstrap em Português do Brasil (Brazilian Portuguese)</a></li> <li><a href=http://www.oneskyapp.com/ru/docs/bootstrap/ hreflang=ru>Bootstrap по-русски (Russian)</a></li> <li><a href=http://www.oneskyapp.com/es/docs/bootstrap/ hreflang=es>Bootstrap en Español (Spanish)</a></li> <li><a href=http://www.trbootstrap.com hreflang=tr>Türkçe Bootstrap (Turkish)</a></li> <li><a href=http://twbs.docs.org.ua hreflang=uk>Bootstrap українською (Ukrainian)</a></li> <li><a href=http://getbootstrap.com.vn hreflang=vi>Bootstrap bằng tiếng Việt (Vietnamese)</a></li> </ul> <p><strong class=text-danger>We don't help organize or host translations, we just link to them.</strong></p> <p>Finished a new or better translation? Open a pull request to add it to our list.</p> </div> </div> <div class=col-md-3 role=complementary> <nav class="bs-docs-sidebar hidden-print hidden-sm hidden-xs"> <ul class="nav bs-docs-sidenav"> <li> <a href=#download>Download</a> </li> <li> <a href=#whats-included>What's included</a> <ul class=nav> <li><a href=#whats-included-precompiled>Precompiled</a></li> <li><a href=#whats-included-source>Source code</a></li> </ul> </li> <li> <a href=#grunt>Compiling CSS and JavaScript</a> <ul class=nav> <li><a href=#grunt-installing>Installing Grunt</a></li> <li><a href=#grunt-commands>Available Grunt commands</a></li> <li><a href=#grunt-troubleshooting>Troubleshooting</a></li> </ul> </li> <li> <a href=#template>Basic template</a> </li> <li> <a href=#examples>Examples</a> <ul class=nav> <li><a href=#examples-framework>Using the framework</a></li> <li><a href=#examples-navbars>Navbars in action</a></li> <li><a href=#examples-custom>Custom components</a></li> <li><a href=#examples-experiments>Experiments</a></li> </ul> </li> <li> <a href=#tools>Tools</a> <ul class=nav> <li><a href=#tools-bootlint>Bootlint</a></li> </ul> </li> <li> <a href=#community>Community</a> </li> <li> <a href=#disable-responsive>Disabling responsiveness</a> </li> <li> <a href=#migration>Migrating from 2.x to 3.0</a> </li> <li> <a href=#support>Browser and device support</a> <ul class=nav> <li><a href=#support-browsers>Supported browsers</a></li> <li><a href=#support-ie8-ie9>Internet Explorer 8-9</a></li> <li><a href=#support-ie8-respondjs>IE8 and Respond.js</a></li> <li><a href=#support-ie8-box-sizing>IE8 and box-sizing</a></li> <li><a href=#support-ie8-font-face>IE8 and @font-face</a></li> <li><a href=#support-ie-compatibility-modes>IE Compatibility modes</a></li> <li><a href=#support-ie10-width>IE10 and Windows (Phone) 8</a></li> <li><a href=#support-safari-percentages>Safari percent rounding</a></li> <li><a href=#support-fixed-position-keyboards>Modals, navbars, and virtual keyboards</a></li> <li><a href=#support-browser-zooming>Browser zooming</a></li> <li><a href=#support-sticky-hover-mobile>Sticky :hover/:focus on mobile</a></li> <li><a href=#support-printing>Printing</a></li> <li><a href=#support-android-stock-browser>Android stock browser</a></li> <li><a href=#support-validators>Validators</a></li> </ul> </li> <li> <a href=#third-parties>Third party support</a> </li> <li> <a href=#accessibility>Accessibility</a> </li> <li> <a href=#license-faqs>License FAQs</a> </li> <li> <a href=#translations>Translations</a> </li> </ul> <a href=#top class=back-to-top> Back to top </a> </nav> </div> </div> </div> <footer class=bs-docs-footer> <div class=container> <ul class=bs-docs-footer-links> <li><a href=https://github.com/twbs/bootstrap>GitHub</a></li> <li><a href=https://twitter.com/getbootstrap>Twitter</a></li> <li><a href=../getting-started/#examples>Examples</a></li> <li><a href=../about/ >About</a></li> </ul> <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>. 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 <a href=https://github.com/twbs/bootstrap/blob/master/LICENSE target=_blank rel=license>MIT</a>, docs <a href=https://creativecommons.org/licenses/by/3.0/ target=_blank rel=license>CC BY 3.0</a>.</p> </div> </footer> <script src=https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js></script> <script>window.jQuery||document.write('<script src="../assets/js/vendor/jquery.min.js"><\/script>')</script> <script src=../dist/js/bootstrap.min.js></script> <script src=../assets/js/docs.min.js></script> <script src=../assets/js/ie10-viewport-bug-workaround.js></script> <script>var _gauges=_gauges||[];!function(){var e=document.createElement("script");e.async=!0,e.id="gauges-tracker",e.setAttribute("data-site-id","4f0dc9fef5a1f55508000013"),e.src="//secure.gaug.es/track.js";var t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(e,t)}()</script> |