From 3e76d6565603fafa2c85ad81d7b6345c4e279c72 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 28 May 2017 22:50:57 -0700 Subject: Rearrange all the docs to allow for a docs/major.minor/ setup --- docs/layout/grid.md | 742 ------------------------------------ docs/layout/media-object.md | 136 ------- docs/layout/overview.md | 175 --------- docs/layout/utilities-for-layout.md | 25 -- 4 files changed, 1078 deletions(-) delete mode 100644 docs/layout/grid.md delete mode 100644 docs/layout/media-object.md delete mode 100644 docs/layout/overview.md delete mode 100644 docs/layout/utilities-for-layout.md (limited to 'docs/layout') diff --git a/docs/layout/grid.md b/docs/layout/grid.md deleted file mode 100644 index d0bfe416a..000000000 --- a/docs/layout/grid.md +++ /dev/null @@ -1,742 +0,0 @@ ---- -layout: docs -title: Grid system -description: Use our powerful mobile-first flexbox grid to build layouts of all shapes and sizes thanks to a twelve column system, five default responsive tiers, Sass variables and mixins, and dozens of predefined classes. -group: layout -toc: true ---- - -## 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. - -
-
-
-
- One of three columns -
-
- One of three columns -
-
- One of three columns -
-
-
-
- -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Extra small
- <576px - 		- Small
- ≥576px - 		- Medium
- ≥768px - 		- Large
- ≥992px - 		- Extra large
- ≥1200px -
Grid behaviorHorizontal at all timesCollapsed to start, horizontal above breakpoints
Max container widthNone (auto)540px720px960px1140px
Class prefix.col-.col-sm-.col-md-.col-lg-.col-xl-
# of columns12
Gutter width30px (15px on each side of a column)
NestableYes
OffsetsYes
Column orderingYes
- -## Auto-layout columns - -Utilize breakpoint-specific column classes for easy column sizing without an explicit numbered class like `.col-sm-6`. - -### Equal-width - -For example, here are two grid layouts that apply to every device and viewport, from `xs` to `xl`. Add any number of unit-less classes for each breakpoint you need and every column will be the same width. - -
-{% example html %} -
-
-
- 1 of 2 -
-
- 2 of 2 -
-
-
-
- 1 of 3 -
-
- 2 of 3 -
-
- 3 of 3 -
-
-
-{% endexample %} -
- -Equal-width columns can be broken into multiple lines, but there is a [Safari flexbox bug](https://github.com/philipwalton/flexbugs#11-min-and-max-size-declarations-are-ignored-when-wrapping-flex-items) that prevents this from working without an explicit `flex-basis` or `border`. Our example works thanks to the `border` being set; you can do the same with `.col { border: 1px solid transparent; }`. Alternatively, you can set the flex-basis to the width of the column (e.g., `.col { flex: 1 0 50%; }`). - -Both these fixes have been documented in a [reduced test case outside Bootstrap](https://output.jsbin.com/micohor). - -
-{% example html %} -
-
-
Column
-
Column
-
-
Column
-
Column
-
-
-{% endexample %} -
- -### Setting one column width - -Auto-layout for flexbox grid columns also means you can set the width of one column and have the sibling columns 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. - -
-{% example html %} -
-
-
- 1 of 3 -
-
- 2 of 3 (wider) -
-
- 3 of 3 -
-
-
-
- 1 of 3 -
-
- 2 of 3 (wider) -
-
- 3 of 3 -
-
-
-{% endexample %} -
- -### Variable width content - -Use `col-{breakpoint}-auto` classes to size columns based on the natural width of their content. - -
-{% example html %} -
-
-
- 1 of 3 -
-
- Variable width content -
-
- 3 of 3 -
-
-
-
- 1 of 3 -
-
- Variable width content -
-
- 3 of 3 -
-
-
-{% endexample %} -
- -### 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/). - -
-{% example html %} -
-
col
-
col
-
-
col
-
col
-
-{% endexample %} -
- -## 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`. - -
-{% example html %} -
-
col
-
col
-
col
-
col
-
-
-
col-8
-
col-4
-
-{% endexample %} -
- -### 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. - -
-{% example html %} -
-
col-sm-8
-
col-sm-4
-
-
-
col-sm
-
col-sm
-
col-sm
-
-{% endexample %} -
- -### 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. - -
-{% example html %} - -
-
.col-12 .col-md-8
-
.col-6 .col-md-4
-
- - -
-
.col-6 .col-md-4
-
.col-6 .col-md-4
-
.col-6 .col-md-4
-
- - -
-
.col-6
-
.col-6
-
-{% endexample %} -
- -## Alignment - -Use flexbox alignment utilities to vertically and horizontally align columns. - -### Vertical alignment - -
-{% example html %} -
-
-
- One of three columns -
-
- One of three columns -
-
- One of three columns -
-
-
-
- One of three columns -
-
- One of three columns -
-
- One of three columns -
-
-
-
- One of three columns -
-
- One of three columns -
-
- One of three columns -
-
-
-{% endexample %} -
- -
-{% example html %} -
-
-
- One of three columns -
-
- One of three columns -
-
- One of three columns -
-
-
-{% endexample %} -
- -### Horizontal alignment - -
-{% example html %} -
-
-
- One of two columns -
-
- One of two columns -
-
-
-
- One of two columns -
-
- One of two columns -
-
-
-
- One of two columns -
-
- One of two columns -
-
-
-
- One of two columns -
-
- One of two columns -
-
-
-
- One of two columns -
-
- One of two columns -
-
-
-{% endexample %} -
- -### 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). - -
-{% example html %} -
-
.col-12 .col-sm-6 .col-md-8
-
.col-6 .col-md-4
-
-{% endexample %} -
- -### 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. - -
-{% example html %} -
-
.col-9
-
.col-4
Since 9 + 4 = 13 > 12, this 4-column-wide div gets wrapped onto a new line as one contiguous unit.
-
.col-6
Subsequent columns continue along the new line.
-
-{% endexample %} -
- -### 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 display utilities]({{ site.baseurl }}/utilities/display/). - -
-{% example html %} -
-
.col-6 .col-sm-3
-
.col-6 .col-sm-3
- - -
- -
.col-6 .col-sm-3
-
.col-6 .col-sm-3
-
-{% endexample %} -
- -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/). - -
-{% example html %} -
-
.col-sm-5 .col-md-6
-
.col-sm-5 .offset-sm-2 .col-md-6 .offset-md-0
-
- -
-
.col.col-sm-6.col-md-5.col-lg-6
-
.col-sm-6 .col-md-5 .offset-md-2 .col-lg-6 .offset-lg-0
-
-{% endexample %} -
- -## Reordering - -### Flex order - -Use flexbox utilities for controlling the **visual order** of your content. - -
-{% example html %} -
-
-
- First, but unordered -
-
- Second, but last -
-
- Third, but first -
-
-
-{% endexample %} -
- -### 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. - -
-{% example html %} -
-
.col-md-4
-
.col-md-4 .offset-md-4
-
-
-
.col-md-3 .offset-md-3
-
.col-md-3 .offset-md-3
-
-
-
.col-md-6 .offset-md-3
-
-{% endexample %} -
- -### Push and pull - -Easily change the order of our built-in grid columns with `.push-md-*` and `.pull-md-*` modifier classes. - -
-{% example html %} -
-
.col-md-9 .push-md-3
-
.col-md-3 .pull-md-9
-
-{% endexample %} -
- -## 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). - -
-{% example html %} -
-
- Level 1: .col-sm-9 -
-
- Level 2: .col-8 .col-sm-6 -
-
- Level 2: .col-4 .col-sm-6 -
-
-
-
-{% endexample %} -
- -## 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 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 -@include make-row($gutters: $grid-gutter-widths); - -// Make the element grid-ready (applying everything but the width) -@include make-col-ready($gutters: $grid-gutter-widths); -@include make-col($size, $columns: $grid-columns); - -// Get fancy by offsetting, or changing the sort order -@include make-col-offset($size, $columns: $grid-columns); -@include make-col-push($size, $columns: $grid-columns); -@include make-col-pull($size, $columns: $grid-columns); -{% 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. - -{% highlight scss %} -.example-container { - width: 800px; - @include make-container(); -} - -.example-row { - @include make-row(); -} - -.example-content-main { - @include make-col-ready(); - - @include media-breakpoint-up(sm) { - @include make-col(6); - } - @include media-breakpoint-up(lg) { - @include make-col(8); - } -} - -.example-content-secondary { - @include make-col-ready(); - - @include media-breakpoint-up(sm) { - @include make-col(6); - } - @include media-breakpoint-up(lg) { - @include make-col(4); - } -} -{% endhighlight %} - -{% example html %} -
-
-
Main content
-
Secondary content
-
-
-{% endexample %} - -## 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 four grid tiers, you'd update the `$grid-breakpoints` and `$container-max-widths` to something like this: - -{% highlight scss %} -$grid-breakpoints: ( - xs: 0, - 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 5023e4580..000000000 --- a/docs/layout/media-object.md +++ /dev/null @@ -1,136 +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 -toc: true ---- - -## Example - -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. - -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 %} -
- Generic placeholder image -
-
Media heading
- 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. -
-
-{% 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 %} -
- Generic placeholder image -
-
Media heading
- 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. - -
- - Generic placeholder image - -
-
Media heading
- 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. -
-
-
-
-{% 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 %} -
- Generic placeholder image -
-
Top-aligned media
-

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.

-

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.

-
-
-{% endexample %} - -{% example html %} -
- Generic placeholder image -
-
Center-aligned media
-

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.

-

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.

-
-
-{% endexample %} - -{% example html %} -
- Generic placeholder image -
-
Bottom-aligned media
-

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.

-

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.

-
-
-{% 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 %} -
-
-
Media object
- 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. -
- Generic placeholder image -
-{% endexample %} - -## Media list - -Because the media object has so few structural requirements, you can also use these classes on list HTML elements. On your `