diff options
Diffstat (limited to 'docs/layout')
| -rw-r--r-- | docs/layout/grid.md | 770 | ||||
| -rw-r--r-- | docs/layout/media-object.md | 140 | ||||
| -rw-r--r-- | docs/layout/overview.md | 182 | ||||
| -rw-r--r-- | docs/layout/responsive-utilities.md | 241 |
4 files changed, 0 insertions, 1333 deletions
diff --git a/docs/layout/grid.md b/docs/layout/grid.md deleted file mode 100644 index 03deb2f55..000000000 --- a/docs/layout/grid.md +++ /dev/null @@ -1,770 +0,0 @@ ---- -layout: docs -title: Grid system -description: Documentation and examples for using Bootstrap's responsive flexbox grid system. -group: layout ---- - -Bootstrap includes a powerful mobile-first flexbox grid system for building layouts of all shapes and sizes. It's based on a 12 column layout and has multiple tiers, one for each [media query range]({{ site.baseurl }}/layout/overview/#responsive-breakpoints). You can use it with Sass mixins or our predefined classes. - -## Contents - -* Will be replaced with the ToC, excluding the "Contents" header -{:toc} - -## How it works - -Bootstrap's grid system uses a series of containers, rows, and columns to layout and align content. It's built with flexbox and is fully responsive. Below is an example and an in-depth look at how the grid comes together. - -<div class="bd-example bd-example-row"> -<div class="container"> - <div class="row"> - <div class="col-sm"> - One of three columns - </div> - <div class="col-sm"> - One of three columns - </div> - <div class="col-sm"> - One of three columns - </div> - </div> -</div> -</div> - -The above example creates three equal-width columns on small, medium, large, and extra large devices using our predefined grid classes. Those columns are centered in the page with the parent `.container`. - -Breaking it down, here's how it works: - -- Containers provide a means to center your site's contents. Use `.container` for fixed width or `.container-fluid` for full width. -- Rows are horizontal groups of columns that ensure your columns are lined up properly. We use the negative margin method on `.row` to ensure all your content is aligned properly down the left side. -- Content should be placed within columns, and only columns may be immediate children of rows. -- Thanks to flexbox, grid columns without a set width will automatically layout with equal widths. For example, four instances of `.col-sm` will each automatically be 25% wide for small breakpoints. -- Column classes indicate the number of columns you'd like to use out of the possible 12 per row. So, if you want three equal-width columns, you can use `.col-sm-4`. -- Column `width`s are set in percentages, so they're always fluid and sized relative to their parent element. -- Columns have horizontal `padding` to create the gutters between individual columns, however, you can remove the `margin` from rows and `padding` from columns with `.no-gutters` on the `.row`. -- There are five grid tiers, one for each [responsive breakpoint]({{ site.baseurl }}/layout/overview/#responsive-breakpoints): all breakpoints (extra small), small, medium, large, and extra large. -- Grid tiers are based on minimum widths, meaning they apply to that one tier and all those above it (e.g., `.col-sm-4` applies to small, medium, large, and extra large devices). -- You can use predefined grid classes or Sass mixins for more semantic markup. - -Be aware of the limitations and [bugs around flexbox](https://github.com/philipwalton/flexbugs), like the [inability to use some HTML elements as flex containers](https://github.com/philipwalton/flexbugs#9-some-html-elements-cant-be-flex-containers). - -Sounds good? Great, let's move on to seeing all that in an example. - -## Grid options - -While Bootstrap uses `em`s or `rem`s for defining most sizes, `px`s are used for grid breakpoints and container widths. This is because the viewport width is in pixels and does not change with the [font size](https://drafts.csswg.org/mediaqueries-3/#units). - -See how aspects of the Bootstrap grid system work across multiple devices with a handy table. - -<table class="table table-bordered table-striped table-responsive"> - <thead> - <tr> - <th></th> - <th class="text-center"> - Extra small<br> - <small><576px</small> - </th> - <th class="text-center"> - Small<br> - <small>≥576px</small> - </th> - <th class="text-center"> - Medium<br> - <small>≥768px</small> - </th> - <th class="text-center"> - Large<br> - <small>≥992px</small> - </th> - <th class="text-center"> - Extra large<br> - <small>≥1200px</small> - </th> - </tr> - </thead> - <tbody> - <tr> - <th class="text-nowrap" scope="row">Grid behavior</th> - <td>Horizontal at all times</td> - <td colspan="4">Collapsed to start, horizontal above breakpoints</td> - </tr> - <tr> - <th class="text-nowrap" scope="row">Max container width</th> - <td>None (auto)</td> - <td>540px</td> - <td>720px</td> - <td>960px</td> - <td>1140px</td> - </tr> - <tr> - <th class="text-nowrap" scope="row">Class prefix</th> - <td><code>.col-</code></td> - <td><code>.col-sm-</code></td> - <td><code>.col-md-</code></td> - <td><code>.col-lg-</code></td> - <td><code>.col-xl-</code></td> - </tr> - <tr> - <th class="text-nowrap" scope="row"># of columns</th> - <td colspan="5">12</td> - </tr> - <tr> - <th class="text-nowrap" scope="row">Gutter width</th> - <td colspan="5">30px (15px on each side of a column)</td> - </tr> - <tr> - <th class="text-nowrap" scope="row">Nestable</th> - <td colspan="5">Yes</td> - </tr> - <tr> - <th class="text-nowrap" scope="row">Offsets</th> - <td colspan="5">Yes</td> - </tr> - <tr> - <th class="text-nowrap" scope="row">Column ordering</th> - <td colspan="5">Yes</td> - </tr> - </tbody> -</table> - -## Auto-layout columns - -Utilize breakpoint-specific column classes for equal-width columns. Add any number of unit-less classes for each breakpoint you need and every column will be the same width. - -### Equal-width - -For example, here are two grid layouts that apply to every device and viewport, from `xs` to `xl`. - -<div class="bd-example-row"> -{% example html %} -<div class="container"> - <div class="row"> - <div class="col"> - 1 of 2 - </div> - <div class="col"> - 1 of 2 - </div> - </div> - <div class="row"> - <div class="col"> - 1 of 3 - </div> - <div class="col"> - 1 of 3 - </div> - <div class="col"> - 1 of 3 - </div> - </div> -</div> -{% endexample %} -</div> - -### Setting one column width - -Auto-layout for flexbox grid columns also means you can set the width of one column and the others will automatically resize around it. You may use predefined grid classes (as shown below), grid mixins, or inline widths. Note that the other columns will resize no matter the width of the center column. - -<div class="bd-example-row"> -{% example html %} -<div class="container"> - <div class="row"> - <div class="col"> - 1 of 3 - </div> - <div class="col-6"> - 2 of 3 (wider) - </div> - <div class="col"> - 3 of 3 - </div> - </div> - <div class="row"> - <div class="col"> - 1 of 3 - </div> - <div class="col-5"> - 2 of 3 (wider) - </div> - <div class="col"> - 3 of 3 - </div> - </div> -</div> -{% endexample %} -</div> - -### Variable width content - -Using the `col-{breakpoint}-auto` classes, columns can size itself based on the natural width of its content. This is super handy with single line content like inputs, numbers, etc. This, in conjunction with [horizontal alignment](#horizontal-alignment) classes, is very useful for centering layouts with uneven column sizes as viewport width changes. - -<div class="bd-example-row"> -{% example html %} -<div class="container"> - <div class="row justify-content-md-center"> - <div class="col col-lg-2"> - 1 of 3 - </div> - <div class="col-12 col-md-auto"> - Variable width content - </div> - <div class="col col-lg-2"> - 3 of 3 - </div> - </div> - <div class="row"> - <div class="col"> - 1 of 3 - </div> - <div class="col-12 col-md-auto"> - Variable width content - </div> - <div class="col col-lg-2"> - 3 of 3 - </div> - </div> -</div> -{% endexample %} -</div> - -### Equal-width multi-row - -Create equal-width columns that span multiple rows by inserting a `.w-100` where you want the columns to break to a new line. Make the breaks responsive by mixing the `.w-100` with some [responsive display utilities]({{ site.baseurl }}/utilities/display-property/). - -<div class="bd-example-row"> -{% example html %} -<div class="row"> - <div class="col">col</div> - <div class="col">col</div> - <div class="w-100"></div> - <div class="col">col</div> - <div class="col">col</div> -</div> -{% endexample %} -</div> - -## Responsive classes - -Bootstrap's grid includes five tiers of predefined classes for building complex responsive layouts. Customize the size of your columns on extra small, small, medium, large, or extra large devices however you see fit. - -### All breakpoints - -For grids that are the same from the smallest of devices to the largest, use the `.col` and `.col-*` classes. Specify a numbered class when you need a particularly sized column; otherwise, feel free to stick to `.col`. - -<div class="bd-example-row"> -{% example html %} -<div class="row"> - <div class="col">col</div> - <div class="col">col</div> - <div class="col">col</div> - <div class="col">col</div> -</div> -<div class="row"> - <div class="col-8">col-8</div> - <div class="col-4">col-4</div> -</div> -{% endexample %} -</div> - -### Stacked to horizontal - -Using a single set of `.col-sm-*` classes, you can create a basic grid system that starts out stacked on extra small devices before becoming horizontal on desktop (medium) devices. - -<div class="bd-example-row"> -{% example html %} -<div class="row"> - <div class="col-sm-8">col-sm-8</div> - <div class="col-sm-4">col-sm-4</div> -</div> -<div class="row"> - <div class="col-sm">col-sm</div> - <div class="col-sm">col-sm</div> - <div class="col-sm">col-sm</div> -</div> -{% endexample %} -</div> - -### Mix and match - -Don't want your columns to simply stack in some grid tiers? Use a combination of different classes for each tier as needed. See the example below for a better idea of how it all works. - -<div class="bd-example-row"> -{% example html %} -<!-- Stack the columns on mobile by making one full-width and the other half-width --> -<div class="row"> - <div class="col col-md-8">.col .col-md-8</div> - <div class="col-6 col-md-4">.col-6 .col-md-4</div> -</div> - -<!-- Columns start at 50% wide on mobile and bump up to 33.3% wide on desktop --> -<div class="row"> - <div class="col-6 col-md-4">.col-6 .col-md-4</div> - <div class="col-6 col-md-4">.col-6 .col-md-4</div> - <div class="col-6 col-md-4">.col-6 .col-md-4</div> -</div> - -<!-- Columns are always 50% wide, on mobile and desktop --> -<div class="row"> - <div class="col-6">.col-6</div> - <div class="col-6">.col-6</div> -</div> -{% endexample %} -</div> - -## Alignment - -Use flexbox alignment utilities to vertically and horizontally align columns. - -### Vertical alignment - -<div class="bd-example-row bd-example-row-flex-cols"> -{% example html %} -<div class="container"> - <div class="row align-items-start"> - <div class="col"> - One of three columns - </div> - <div class="col"> - One of three columns - </div> - <div class="col"> - One of three columns - </div> - </div> - <div class="row align-items-center"> - <div class="col"> - One of three columns - </div> - <div class="col"> - One of three columns - </div> - <div class="col"> - One of three columns - </div> - </div> - <div class="row align-items-end"> - <div class="col"> - One of three columns - </div> - <div class="col"> - One of three columns - </div> - <div class="col"> - One of three columns - </div> - </div> -</div> -{% endexample %} -</div> - -<div class="bd-example-row bd-example-row-flex-cols"> -{% example html %} -<div class="container"> - <div class="row"> - <div class="col align-self-start"> - One of three columns - </div> - <div class="col align-self-center"> - One of three columns - </div> - <div class="col align-self-end"> - One of three columns - </div> - </div> -</div> -{% endexample %} -</div> - -### Horizontal alignment - -<div class="bd-example-row"> -{% example html %} -<div class="container"> - <div class="row justify-content-start"> - <div class="col-4"> - One of two columns - </div> - <div class="col-4"> - One of two columns - </div> - </div> - <div class="row justify-content-center"> - <div class="col-4"> - One of two columns - </div> - <div class="col-4"> - One of two columns - </div> - </div> - <div class="row justify-content-end"> - <div class="col-4"> - One of two columns - </div> - <div class="col-4"> - One of two columns - </div> - </div> - <div class="row justify-content-around"> - <div class="col-4"> - One of two columns - </div> - <div class="col-4"> - One of two columns - </div> - </div> - <div class="row justify-content-between"> - <div class="col-4"> - One of two columns - </div> - <div class="col-4"> - One of two columns - </div> - </div> -</div> -{% endexample %} -</div> - -### No gutters - -The gutters between columns in our predefined grid classes can be removed with `.no-gutters`. This removes the negative `margin`s from `.row` and the horizontal `padding` from all immediate children columns. - -Here's the source code for creating these styles. Note that column overrides are scoped to only the first children columns and are targeted via [attribute selector](https://developer.mozilla.org/en-US/docs/Web/CSS/Attribute_selectors). While this generates a more specific selector, column padding can still be further customized with [spacing utilities]({{ site.baseurl }}/utilities/spacing/). - -{% highlight sass %} -.no-gutters { - margin-right: 0; - margin-left: 0; - - > .col, - > [class*="col-"] { - padding-right: 0; - padding-left: 0; - } -} -{% endhighlight %} - -In practice, here's how it looks. Note you can continue to use this with all other predefined grid classes (including column widths, responsive tiers, reorders, and more). - -<div class="bd-example-row"> -{% example html %} -<div class="row no-gutters"> - <div class="col-12 col-sm-6 col-md-8">.col-12 .col-sm-6 .col-md-8</div> - <div class="col-6 col-md-4">.col-6 .col-md-4</div> -</div> -{% endexample %} -</div> - -### Column wrapping - -If more than 12 columns are placed within a single row, each group of extra columns will, as one unit, wrap onto a new line. - -<div class="bd-example-row"> -{% example html %} -<div class="row"> - <div class="col-9">.col-9</div> - <div class="col-4">.col-4<br>Since 9 + 4 = 13 > 12, this 4-column-wide div gets wrapped onto a new line as one contiguous unit.</div> - <div class="col-6">.col-6<br>Subsequent columns continue along the new line.</div> -</div> -{% endexample %} -</div> - -### Column resets - -With the handful of grid tiers available, you're bound to run into issues where, at certain breakpoints, your columns don't clear quite right as one is taller than the other. To fix that, use a combination of a `.clearfix` and our [responsive utility classes]({{ site.baseurl }}/layout/responsive-utilities/). - -<div class="bd-example-row"> -{% example html %} -<div class="row"> - <div class="col-6 col-sm-3">.col-6 .col-sm-3</div> - <div class="col-6 col-sm-3">.col-6 .col-sm-3</div> - - <!-- Add the extra clearfix for only the required viewport --> - <div class="clearfix hidden-sm-up"></div> - - <div class="col-6 col-sm-3">.col-6 .col-sm-3</div> - <div class="col-6 col-sm-3">.col-6 .col-sm-3</div> -</div> -{% endexample %} -</div> - -In addition to column clearing at responsive breakpoints, you may need to **reset offsets, pushes, or pulls**. See this in action in [the grid example]({{ site.baseurl }}/examples/grid/). - -<div class="bd-example-row"> -{% example html %} -<div class="row"> - <div class="col-sm-5 col-md-6">.col-sm-5 .col-md-6</div> - <div class="col-sm-5 offset-sm-2 col-md-6 offset-md-0">.col-sm-5 .offset-sm-2 .col-md-6 .offset-md-0</div> -</div> - -<div class="row"> - <div class="col-sm-6 col-md-5 col-lg-6">.col.col-sm-6.col-md-5.col-lg-6</div> - <div class="col-sm-6 col-md-5 offset-md-2 col-lg-6 offset-lg-0">.col-sm-6 .col-md-5 .offset-md-2 .col-lg-6 .offset-lg-0</div> -</div> -{% endexample %} -</div> - -## Reordering - -### Flex order - -Use flexbox utilities for controlling the **visual order** of your content. - -<div class="bd-example-row"> -{% example html %} -<div class="container"> - <div class="row"> - <div class="col flex-unordered"> - First, but unordered - </div> - <div class="col flex-last"> - Second, but last - </div> - <div class="col flex-first"> - Third, but first - </div> - </div> -</div> -{% endexample %} -</div> - -### Offsetting columns - -Move columns to the right using `.offset-md-*` classes. These classes increase the left margin of a column by `*` columns. For example, `.offset-md-4` moves `.col-md-4` over four columns. - -<div class="bd-example-row"> -{% example html %} -<div class="row"> - <div class="col-md-4">.col-md-4</div> - <div class="col-md-4 offset-md-4">.col-md-4 .offset-md-4</div> -</div> -<div class="row"> - <div class="col-md-3 offset-md-3">.col-md-3 .offset-md-3</div> - <div class="col-md-3 offset-md-3">.col-md-3 .offset-md-3</div> -</div> -<div class="row"> - <div class="col-md-6 offset-md-3">.col-md-6 .offset-md-3</div> -</div> -{% endexample %} -</div> - -### Push and pull - -Easily change the order of our built-in grid columns with `.push-md-*` and `.pull-md-*` modifier classes. - -<div class="bd-example-row"> -{% example html %} -<div class="row"> - <div class="col-md-9 push-md-3">.col-md-9 .push-md-3</div> - <div class="col-md-3 pull-md-9">.col-md-3 .pull-md-9</div> -</div> -{% endexample %} -</div> - -## Nesting - -To nest your content with the default grid, add a new `.row` and set of `.col-sm-*` columns within an existing `.col-sm-*` column. Nested rows should include a set of columns that add up to 12 or fewer (it is not required that you use all 12 available columns). - -<div class="bd-example-row"> -{% example html %} -<div class="row"> - <div class="col-sm-9"> - Level 1: .col-sm-9 - <div class="row"> - <div class="col-8 col-sm-6"> - Level 2: .col-8 .col-sm-6 - </div> - <div class="col-4 col-sm-6"> - Level 2: .col-4 .col-sm-6 - </div> - </div> - </div> -</div> -{% endexample %} -</div> - -## Sass mixins - -When using Bootstrap's source Sass files, you have the option of using Sass variables and mixins to create custom, semantic, and responsive page layouts. Our [predefined grid classes](#predefined-classes) use these same variables and mixins to provide a whole suite of ready-to-use classes for fast responsive layouts. - -### Variables - -Variables and maps determine the number of columns, the gutter width, and the media query point at which to begin floating columns. We use these to generate the predefined grid classes documented above, as well as for the custom mixins listed below. - -{% highlight scss %} -$grid-columns: 12; -$grid-gutter-width-base: 30px; - -$grid-gutter-widths: ( - xs: $grid-gutter-width-base, // 30px - sm: $grid-gutter-width-base, // 30px - md: $grid-gutter-width-base, // 30px - lg: $grid-gutter-width-base, // 30px - xl: $grid-gutter-width-base // 30px -) - -$grid-breakpoints: ( - // Extra small screen / phone - xs: 0, - // Small screen / phone - sm: 576px, - // Medium screen / tablet - md: 768px, - // Large screen / desktop - lg: 992px, - // Extra large screen / wide desktop - xl: 1200px -); - -$container-max-widths: ( - sm: 540px, - md: 720px, - lg: 960px, - xl: 1140px -); -{% endhighlight %} - -### Mixins - -Mixins are used in conjunction with the grid variables to generate semantic CSS for individual grid columns. - -{% highlight scss %} -// Creates a wrapper for a series of columns -@mixin make-row($gutters: $grid-gutter-widths) { - display: flex; - flex-wrap: wrap; - - @each $breakpoint in map-keys($gutters) { - @include media-breakpoint-up($breakpoint) { - $gutter: map-get($gutters, $breakpoint); - margin-right: ($gutter / -2); - margin-left: ($gutter / -2); - } - } -} - -// Make the element grid-ready (applying everything but the width) -@mixin make-col-ready($gutters: $grid-gutter-widths) { - position: relative; - // Prevent columns from becoming too narrow when at smaller grid tiers by - // always setting `width: 100%;`. This works because we use `flex` values - // later on to override this initial width. - width: 100%; - min-height: 1px; // Prevent collapsing - - @each $breakpoint in map-keys($gutters) { - @include media-breakpoint-up($breakpoint) { - $gutter: map-get($gutters, $breakpoint); - padding-right: ($gutter / 2); - padding-left: ($gutter / 2); - } - } -} - -@mixin make-col($size, $columns: $grid-columns) { - flex: 0 0 percentage($size / $columns); - width: percentage($size / $columns); - // Add a `max-width` to ensure content within each column does not blow out - // the width of the column. Applies to IE10+ and Firefox. Chrome and Safari - // do not appear to require this. - max-width: percentage($size / $columns); -} - -// Get fancy by offsetting, or changing the sort order -@mixin make-col-offset($size, $columns: $grid-columns) { - margin-left: percentage($size / $columns); -} - -@mixin make-col-push($size, $columns: $grid-columns) { - left: if($size > 0, percentage($size / $columns), auto); -} - -@mixin make-col-pull($size, $columns: $grid-columns) { - right: if($size > 0, percentage($size / $columns), auto); -} -{% endhighlight %} - -### Example usage - -You can modify the variables to your own custom values, or just use the mixins with their default values. Here's an example of using the default settings to create a two-column layout with a gap between. - -See it in action in <a href="https://jsbin.com/ruxona/edit?html,output">this rendered example</a>. - -{% highlight scss %} -.container { - max-width: 60em; - @include make-container(); -} -.row { - @include make-row(); -} -.content-main { - @include make-col-ready(); - - @media (max-width: 32em) { - @include make-col(6); - } - @media (min-width: 32.1em) { - @include make-col(8); - } -} -.content-secondary { - @include make-col-ready(); - - @media (max-width: 32em) { - @include make-col(6); - } - @media (min-width: 32.1em) { - @include make-col(4); - } -} -{% endhighlight %} - -{% highlight html %} -<div class="container"> - <div class="row"> - <div class="content-main">...</div> - <div class="content-secondary">...</div> - </div> -</div> -{% endhighlight %} - -## Customizing the grid - -Using our built-in grid Sass variables and maps, it's possible to completely customize the predefined grid classes. Change the number of tiers, the media query dimensions, and the container widths—then recompile. - -### Columns and gutters - -The number of grid columns and their horizontal padding (aka, gutters) can be modified via Sass variables. `$grid-columns` is used to generate the widths (in percent) of each individual column while `$grid-gutter-widths` allows breakpoint-specific widths that are divided evenly across `padding-left` and `padding-right` for the column gutters. - -{% highlight scss %} -$grid-columns: 12 !default; -$grid-gutter-width-base: 30px !default; -$grid-gutter-widths: ( - xs: $grid-gutter-width-base, - sm: $grid-gutter-width-base, - md: $grid-gutter-width-base, - lg: $grid-gutter-width-base, - xl: $grid-gutter-width-base -) !default; -{% endhighlight %} - -### Grid tiers - -Moving beyond the columns themselves, you may also customize the number of grid tiers. If you wanted just three grid tiers, you'd update the `$grid-breakpoints` and `$container-max-widths` to something like this: - -{% highlight scss %} -$grid-breakpoints: ( - sm: 480px, - md: 768px, - lg: 1024px -); - -$container-max-widths: ( - sm: 420px, - md: 720px, - lg: 960px -); -{% endhighlight %} - -When making any changes to the Sass variables or maps, you'll need to save your changes and recompile. Doing so will out a brand new set of predefined grid classes for column widths, offsets, pushes, and pulls. Responsive visibility utilities will also be updated to use the custom breakpoints. diff --git a/docs/layout/media-object.md b/docs/layout/media-object.md deleted file mode 100644 index 662f72c25..000000000 --- a/docs/layout/media-object.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -layout: docs -title: Media object -description: Documentation and examples for Bootstrap's media object to construct highly repetitive components like blog comments, tweets, and the like. -group: layout ---- - -The [media object](http://www.stubbornella.org/content/2010/06/25/the-media-object-saves-hundreds-of-lines-of-code/) helps build complex and repetitive components where some media is positioned alongside content that doesn't wrap around said media. Plus, it does this with only two required classes thanks to flexbox. - -## Contents - -* Will be replaced with the ToC, excluding the "Contents" header -{:toc} - -## Example - -Below is an example of a single media object. Only two classes are required—the wrapping `.media` and the `.media-body` around your content. Optional padding and margin can be controlled through [spacing utilities]({{ site.baseurl }}/utilities/spacing/). - -{% example html %} -<div class="media"> - <img class="d-flex mr-3" data-src="holder.js/64x64" alt="Generic placeholder image"> - <div class="media-body"> - <h5 class="mt-0">Media heading</h5> - Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. Fusce condimentum nunc ac nisi vulputate fringilla. Donec lacinia congue felis in faucibus. - </div> -</div> -{% endexample %} - -{% callout warning %} -##### Flexbug #12: Inline elements aren't treated as flex items - -Internet Explorer 10-11 do not render inline elements like links or images (or `::before` and `::after` pseudo-elements) as flex items. The only workaround is to set a non-inline `display` value (e.g., `block`, `inline-block`, or `flex`). We suggest using `.d-flex`, one of our [display utilities]({{ site.baseurl }}/utilities/display-property/), as an easy fix. - -**Source:** [Flexbugs on GitHub](https://github.com/philipwalton/flexbugs#12-inline-elements-are-not-treated-as-flex-items) -{% endcallout %} - -## Nesting - -Media objects can be infinitely nested, though we suggest you stop at some point. Place nested `.media` within the `.media-body` of a parent media object. - -{% example html %} -<div class="media"> - <img class="d-flex mr-3" data-src="holder.js/64x64" alt="Generic placeholder image"> - <div class="media-body"> - <h5 class="mt-0">Media heading</h5> - Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. Fusce condimentum nunc ac nisi vulputate fringilla. Donec lacinia congue felis in faucibus. - - <div class="media mt-3"> - <a class="d-flex pr-3" href="#"> - <img data-src="holder.js/64x64" alt="Generic placeholder image"> - </a> - <div class="media-body"> - <h5 class="mt-0">Media heading</h5> - Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. Fusce condimentum nunc ac nisi vulputate fringilla. Donec lacinia congue felis in faucibus. - </div> - </div> - </div> -</div> -{% endexample %} - -## Alignment - -Media in a media object can be aligned with flexbox utilities to the top (default), middle, or end of your `.media-body` content. - -{% example html %} -<div class="media"> - <img class="d-flex mr-3" data-src="holder.js/64x64" alt="Generic placeholder image"> - <div class="media-body"> - <h5 class="mt-0">Top-aligned media</h5> - <p>Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. Fusce condimentum nunc ac nisi vulputate fringilla. Donec lacinia congue felis in faucibus.</p> - <p>Donec sed odio dui. Nullam quis risus eget urna mollis ornare vel eu leo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.</p> - </div> -</div> -{% endexample %} - -{% example html %} -<div class="media"> - <img class="d-flex mr-3" data-src="holder.js/64x64" alt="Generic placeholder image"> - <div class="media-body"> - <h5 class="mt-0">Center-aligned media</h5> - <p>Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. Fusce condimentum nunc ac nisi vulputate fringilla. Donec lacinia congue felis in faucibus.</p> - <p class="mb-0">Donec sed odio dui. Nullam quis risus eget urna mollis ornare vel eu leo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.</p> - </div> -</div> -{% endexample %} - -{% example html %} -<div class="media"> - <img class="d-flex mr-3" data-src="holder.js/64x64" alt="Generic placeholder image"> - <div class="media-body"> - <h5 class="mt-0">Bottom-aligned media</h5> - <p>Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. Fusce condimentum nunc ac nisi vulputate fringilla. Donec lacinia congue felis in faucibus.</p> - <p class="mb-0">Donec sed odio dui. Nullam quis risus eget urna mollis ornare vel eu leo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.</p> - </div> -</div> -{% endexample %} - -## Order - -Change the order of content in media objects by modifying the HTML itself, or by adding some custom flexbox CSS to set the `order` property (to an integer of your choosing). - -{% example html %} -<div class="media"> - <div class="media-body"> - <h5 class="mt-0 mb-1">Media object</h5> - Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. Fusce condimentum nunc ac nisi vulputate fringilla. Donec lacinia congue felis in faucibus. - </div> - <img class="d-flex ml-3" data-src="holder.js/64x64" alt="Generic placeholder image"> -</div> -{% endexample %} - -## Media list - -Because the media object has so few structural requirements, you can also use these classes on list HTML elements. On your `<ul>` or `<ol>`, add the `.list-unstyled` to remove any browser default list styles, and then apply `.media` to your `<li>`s. As always, use spacing utilities wherever needed to fine tune. - -{% example html %} -<ul class="list-unstyled"> - <li class="media"> - <img class="d-flex mr-3" data-src="holder.js/64x64" alt="Generic placeholder image"> - <div class="media-body"> - <h5 class="mt-0 mb-1">List-based media object</h5> - Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. Fusce condimentum nunc ac nisi vulputate fringilla. Donec lacinia congue felis in faucibus. - </div> - </li> - <li class="media my-4"> - <img class="d-flex mr-3" data-src="holder.js/64x64" alt="Generic placeholder image"> - <div class="media-body"> - <h5 class="mt-0 mb-1">List-based media object</h5> - Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. Fusce condimentum nunc ac nisi vulputate fringilla. Donec lacinia congue felis in faucibus. - </div> - </li> - <li class="media"> - <img class="d-flex mr-3" data-src="holder.js/64x64" alt="Generic placeholder image"> - <div class="media-body"> - <h5 class="mt-0 mb-1">List-based media object</h5> - Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. Fusce condimentum nunc ac nisi vulputate fringilla. Donec lacinia congue felis in faucibus. - </div> - </li> -</ul> -{% endexample %} diff --git a/docs/layout/overview.md b/docs/layout/overview.md deleted file mode 100644 index 736b9ed12..000000000 --- a/docs/layout/overview.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -layout: docs -title: Overview -description: Components and options for laying out your Bootstrap project, including wrapping containers, a powerful grid system, a flexible media object, and responsive utility classes. -group: layout -redirect_from: "/layout/" ---- - -Bootstrap includes several components and options for laying out your project, including wrapping containers, a powerful flexbox grid system, a flexible media object, and responsive utility classes. - -## Contents - -* Will be replaced with the ToC, excluding the "Contents" header -{:toc} - -## Containers - -Containers are the most basic layout element in Bootstrap and are **required when using our default grid system**. Choose from a responsive, fixed-width container (meaning its `max-width` changes at each breakpoint) or fluid-width (meaning it's `100%` wide all the time). - -While containers *can* be nested, most layouts do not require a nested container. - -<div class="bd-example"> - <div class="bd-example-container"> - <div class="bd-example-container-header"></div> - <div class="bd-example-container-sidebar"></div> - <div class="bd-example-container-body"></div> - </div> -</div> - -{% highlight html %} -<div class="container"> - <!-- Content here --> -</div> -{% endhighlight %} - -Use `.container-fluid` for a full width container, spanning the entire width of the viewport. - -<div class="bd-example"> - <div class="bd-example-container bd-example-container-fluid"> - <div class="bd-example-container-header"></div> - <div class="bd-example-container-sidebar"></div> - <div class="bd-example-container-body"></div> - </div> -</div> - -{% highlight html %} -<div class="container-fluid"> - ... -</div> -{% endhighlight %} - - -## Responsive breakpoints - -Since Bootstrap is developed to be mobile first, we use a handful of [media queries](https://developer.mozilla.org/en-US/docs/Web/CSS/Media_Queries/Using_media_queries) to create sensible breakpoints for our layouts and interfaces. These breakpoints are mostly based on minimum viewport widths and allow us to scale up elements as the viewport changes. - -Bootstrap primarily uses the following media query ranges—or breakpoints—in our source Sass files for our layout, grid system, and components. - -{% highlight scss %} -// Extra small devices (portrait phones, less than 576px) -// No media query since this is the default in Bootstrap - -// Small devices (landscape phones, 576px and up) -@media (min-width: 576px) { ... } - -// Medium devices (tablets, 768px and up) -@media (min-width: 768px) { ... } - -// Large devices (desktops, 992px and up) -@media (min-width: 992px) { ... } - -// Extra large devices (large desktops, 1200px and up) -@media (min-width: 1200px) { ... } -{% endhighlight %} - -Since we write our source CSS in Sass, all our media queries are available via Sass mixins: - -{% highlight scss %} -@include media-breakpoint-up(xs) { ... } -@include media-breakpoint-up(sm) { ... } -@include media-breakpoint-up(md) { ... } -@include media-breakpoint-up(lg) { ... } -@include media-breakpoint-up(xl) { ... } - -// Example usage: -@include media-breakpoint-up(sm) { - .some-class { - display: block; - } -} -{% endhighlight %} - -We occasionally use media queries that go in the other direction (the given screen size *or smaller*): - -{% highlight scss %} -// Extra small devices (portrait phones, less than 576px) -@media (max-width: 575px) { ... } - -// Small devices (landscape phones, less than 768px) -@media (max-width: 767px) { ... } - -// Medium devices (tablets, less than 992px) -@media (max-width: 991px) { ... } - -// Large devices (desktops, less than 1200px) -@media (max-width: 1199px) { ... } - -// Extra large devices (large desktops) -// No media query since the extra-large breakpoint has no upper bound on its width -{% endhighlight %} - -Once again, these media queries are also available via Sass mixins: - -{% highlight scss %} -@include media-breakpoint-down(xs) { ... } -@include media-breakpoint-down(sm) { ... } -@include media-breakpoint-down(md) { ... } -@include media-breakpoint-down(lg) { ... } -{% endhighlight %} - -There are also media queries and mixins for targeting a single segment of screen sizes using the minimum and maximum breakpoint widths. - -{% highlight scss %} -// Extra small devices (portrait phones, less than 576px) -@media (max-width: 575px) { ... } - -// Small devices (landscape phones, 576px and up) -@media (min-width: 576px) and (max-width: 767px) { ... } - -// Medium devices (tablets, 768px and up) -@media (min-width: 768px) and (max-width: 991px) { ... } - -// Large devices (desktops, 992px and up) -@media (min-width: 992px) and (max-width: 1199px) { ... } - -// Extra large devices (large desktops, 1200px and up) -@media (min-width: 1200px) { ... } -{% endhighlight %} - -These media queries are also available via Sass mixins: - -{% highlight scss %} -@include media-breakpoint-only(xs) { ... } -@include media-breakpoint-only(sm) { ... } -@include media-breakpoint-only(md) { ... } -@include media-breakpoint-only(lg) { ... } -@include media-breakpoint-only(xl) { ... } -{% endhighlight %} - -Similarly, media queries may span multiple breakpoint widths: - -{% highlight scss %} -// Example -// Apply styles starting from medium devices and up to extra large devices -@media (min-width: 768px) and (max-width: 1199px) { ... } -{% endhighlight %} - -The Sass mixin for targeting the same screen size range would be: - -{% highlight scss %} -@include media-breakpoint-between(md, xl) { ... } -{% endhighlight %} - -## Z-index - -Several Bootstrap components utilize `z-index`, the CSS property that helps control layout by providing a third axis to arrange content. We utilize a default z-index scale in Bootstrap that's been designed to properly layer navigation, tooltips and popovers, modals, and more. - -We don't encourage customization of these values; should you change one, you likely need to change them all. - -```scss -$zindex-dropdown-backdrop: 990 !default; -$zindex-navbar: 1000 !default; -$zindex-dropdown: 1000 !default; -$zindex-fixed: 1030 !default; -$zindex-sticky: 1030 !default; -$zindex-modal-backdrop: 1040 !default; -$zindex-modal: 1050 !default; -$zindex-popover: 1060 !default; -$zindex-tooltip: 1070 !default; -``` - -Background elements—like the backdrops that allow click-dismissing—tend to reside on a lower `z-index`s, while navigation and popovers utilize higher `z-index`s to ensure they overlay surrounding content. diff --git a/docs/layout/responsive-utilities.md b/docs/layout/responsive-utilities.md deleted file mode 100644 index e207737d1..000000000 --- a/docs/layout/responsive-utilities.md +++ /dev/null @@ -1,241 +0,0 @@ ---- -layout: docs -title: Responsive utilities -description: Use responsive display utility classes for showing and hiding content by device, via media query. -group: layout ---- - -For faster mobile-friendly development, use these utility classes for showing and hiding content by device via media query. Also included are utility classes for toggling content when printed. - -Try to use these on a limited basis and avoid creating entirely different versions of the same site. Instead, use them to complement each device's presentation. - -## Contents - -* Will be replaced with the ToC, excluding the "Contents" header -{:toc} - -## Available classes - -* The `.hidden-*-up` classes hide the element when the viewport is at the given breakpoint or wider. For example, `.hidden-md-up` hides an element on medium, large, and extra-large viewports. -* The `.hidden-*-down` classes hide the element when the viewport is at the given breakpoint or smaller. For example, `.hidden-md-down` hides an element on extra-small, small, and medium viewports. -* There are no explicit "visible"/"show" responsive utility classes; you make an element visible by simply not hiding it at that breakpoint size. -* You can combine one `.hidden-*-up` class with one `.hidden-*-down` class to show an element only on a given interval of screen sizes. For example, `.hidden-sm-down.hidden-xl-up` shows the element only on medium and large viewports. Using multiple `.hidden-*-up` classes or multiple `.hidden-*-down` classes is redundant and pointless. -* These classes don't attempt to accommodate less common cases where an element's visibility can't be expressed as a single contiguous range of viewport breakpoint sizes; you will instead need to use custom CSS in such cases. - -<table class="table table-bordered table-striped responsive-utilities table-responsive"> - <thead> - <tr> - <th></th> - <th> - Extra small devices - <small>Portrait phones (<544px)</small> - </th> - <th> - Small devices - <small>Landscape phones (≥544px - <768px)</small> - </th> - <th> - Medium devices - <small>Tablets (≥768px - <992px)</small> - </th> - <th> - Large devices - <small>Desktops (≥992px - <1200px)</small> - </th> - <th> - Extra large devices - <small>Desktops (≥1200px)</small> - </th> - </tr> - </thead> - <tbody> - <tr> - <th scope="row"><code>.hidden-xs-down</code></th> - <td class="is-hidden">Hidden</td> - <td class="is-visible">Visible</td> - <td class="is-visible">Visible</td> - <td class="is-visible">Visible</td> - <td class="is-visible">Visible</td> - </tr> - <tr> - <th scope="row"><code>.hidden-sm-down</code></th> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - <td class="is-visible">Visible</td> - <td class="is-visible">Visible</td> - <td class="is-visible">Visible</td> - </tr> - <tr> - <th scope="row"><code>.hidden-md-down</code></th> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - <td class="is-visible">Visible</td> - <td class="is-visible">Visible</td> - </tr> - <tr> - <th scope="row"><code>.hidden-lg-down</code></th> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - <td class="is-visible">Visible</td> - </tr> - <tr> - <th scope="row"><code>.hidden-xl-down</code></th> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - </tr> - <tr> - <th scope="row"><code>.hidden-xs-up</code></th> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - </tr> - <tr> - <th scope="row"><code>.hidden-sm-up</code></th> - <td class="is-visible">Visible</td> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - </tr> - <tr> - <th scope="row"><code>.hidden-md-up</code></th> - <td class="is-visible">Visible</td> - <td class="is-visible">Visible</td> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - </tr> - <tr> - <th scope="row"><code>.hidden-lg-up</code></th> - <td class="is-visible">Visible</td> - <td class="is-visible">Visible</td> - <td class="is-visible">Visible</td> - <td class="is-hidden">Hidden</td> - <td class="is-hidden">Hidden</td> - </tr> - <tr> - <th scope="row"><code>.hidden-xl-up</code></th> - <td class="is-visible">Visible</td> - <td class="is-visible">Visible</td> - <td class="is-visible">Visible</td> - <td class="is-visible">Visible</td> - <td class="is-hidden">Hidden</td> - </tr> - </tbody> -</table> - -<h2 id="responsive-utilities-print">Print classes</h2> -<p>Similar to the regular responsive classes, use these for toggling content for print.</p> -<table class="table table-bordered table-striped responsive-utilities table-responsive"> - <thead> - <tr> - <th>Class</th> - <th>Browser</th> - <th>Print</th> - </tr> - </thead> - <tbody> - <tr> - <th><code>.visible-print-block</code></th> - <td class="is-hidden">Hidden</td> - <td class="is-visible">Visible<br>(as <code>display: block</code>)</td> - </tr> - <tr> - <th><code>.visible-print-inline</code></th> - <td class="is-hidden">Hidden</td> - <td class="is-visible">Visible<br>(as <code>display: inline</code>)</td> - </tr> - <tr> - <th><code>.visible-print-inline-block</code></th> - <td class="is-hidden">Hidden</td> - <td class="is-visible">Visible<br>(as <code>display: inline-block</code>)</td> - </tr> - <tr> - <th><code>.hidden-print</code></th> - <td class="is-visible">Visible</td> - <td class="is-hidden">Hidden</td> - </tr> - </tbody> -</table> - -## Test cases - -Resize your browser or load on different devices to test the responsive utility classes. - -Green checkmarks indicate the element **is visible** in your current viewport. - -<div class="row responsive-utilities-test visible-on"> - <div class="col-6 col-sm-3"> - <span class="hidden-sm-up visible">✔ Visible on extra small</span> - <span class="hidden-xs-down not-visible">Extra small</span> - </div> - <div class="col-6 col-sm-3"> - <span class="hidden-md-up visible">✔ Visible on small or narrower</span> - <span class="hidden-sm-down not-visible">Small or narrower</span> - </div> - <div class="col-6 col-sm-3"> - <span class="hidden-lg-up visible">✔ Visible on medium or narrower</span> - <span class="hidden-md-down not-visible">Medium or narrower</span> - </div> - <div class="col-6 col-sm-3"> - <span class="hidden-xl-up visible">✔ Visible on large or narrower</span> - <span class="hidden-lg-down not-visible">Large or narrower</span> - </div> -</div> - -<hr> - -<div class="row responsive-utilities-test visible-on"> - <div class="col-6 col-sm-3"> - <span class="hidden-xs-down visible">✔ Visible on small or wider</span> - <span class="hidden-sm-up not-visible">Small or wider</span> - </div> - <div class="col-6 col-sm-3"> - <span class="hidden-sm-down visible">✔ Visible on medium or wider</span> - <span class="hidden-md-up not-visible">Medium or wider</span> - </div> - <div class="col-6 col-sm-3"> - <span class="hidden-md-down visible">✔ Visible on large or wider</span> - <span class="hidden-lg-up not-visible">Large or wider</span> - </div> - <div class="col-6 col-sm-3"> - <span class="hidden-lg-down visible">✔ Visible on extra large</span> - <span class="hidden-xl-up not-visible">Extra large</span> - </div> -</div> - -<hr> - -<div class="row responsive-utilities-test visible-on"> - <div class="col-6 col-sm-4"> - <span class="hidden-sm-up visible">✔ Your viewport is exactly extra small</span> - <span class="hidden-xs-down not-visible">Your viewport is NOT exactly extra small</span> - </div> - <div class="col-6 col-sm-4"> - <span class="hidden-xs-down hidden-md-up visible">✔ Your viewport is exactly small</span> - <span class="hidden-sm-only not-visible">Your viewport is NOT exactly small</span> - </div> - <div class="col-6 col-sm-4"> - <span class="hidden-sm-down hidden-lg-up visible">✔ Your viewport is exactly medium</span> - <span class="hidden-md-only not-visible">Your viewport is NOT exactly medium</span> - </div> - </div> - -<div class="row responsive-utilities-test visible-on"> - <div class="col-6 col-sm-4"> - <span class="hidden-md-down hidden-xl-up visible">✔ Your viewport is exactly large</span> - <span class="hidden-lg-only not-visible">Your viewport is NOT exactly large</span> - </div> - <div class="col-6 col-sm-4"> - <span class="hidden-lg-down visible">✔ Your viewport is exactly extra large</span> - <span class="hidden-xl-only not-visible">Your viewport is NOT exactly extra large</span> - </div> -</div> |