From ebe405a01b721b667a37ae5c249077f4cdb3b8bd Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Fri, 3 Mar 2017 12:57:16 -0800 Subject: Start rearranging the docs for a utilities update MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit — Rename display docs page — Move print display utils to display utils page — Drop remaining of responsive utils page as it's being replaced with display utils — Update nav to reflect changes --- docs/layout/responsive-utilities.md | 243 ------------------------------------ docs/layout/utilities-for-layout.md | 21 ++++ 2 files changed, 21 insertions(+), 243 deletions(-) delete mode 100644 docs/layout/responsive-utilities.md create mode 100644 docs/layout/utilities-for-layout.md (limited to 'docs/layout') diff --git a/docs/layout/responsive-utilities.md b/docs/layout/responsive-utilities.md deleted file mode 100644 index d1522e558..000000000 --- a/docs/layout/responsive-utilities.md +++ /dev/null @@ -1,243 +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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Extra small devices - Portrait phones (<576px) - - Small devices - Landscape phones (≥576px - <768px) - - Medium devices - Tablets (≥768px - <992px) - - Large devices - Desktops (≥992px - <1200px) - - Extra large devices - Desktops (≥1200px) -
.hidden-xs-downVisibleVisibleVisibleVisible
.hidden-sm-downVisibleVisibleVisible
.hidden-md-downVisibleVisible
.hidden-lg-downVisible
.hidden-xl-down
.hidden-xs-up
.hidden-sm-upVisible
.hidden-md-upVisibleVisible
.hidden-lg-upVisibleVisibleVisible
.hidden-xl-upVisibleVisibleVisibleVisible
- -## Print classes - -Similar to the regular responsive classes, use these for toggling content for print. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ClassBrowserPrint
.visible-print-blockVisible
(as display: block)
.visible-print-inlineVisible
(as display: inline)
.visible-print-inline-blockVisible
(as display: inline-block)
.hidden-printVisible
- -## 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. - -
-
- ✔ Visible on extra small - Extra small -
-
- ✔ Visible on small or narrower - Small or narrower -
-
- ✔ Visible on medium or narrower - Medium or narrower -
-
- ✔ Visible on large or narrower - Large or narrower -
-
- -
- -
-
- ✔ Visible on small or wider - Small or wider -
-
- ✔ Visible on medium or wider - Medium or wider -
-
- ✔ Visible on large or wider - Large or wider -
-
- ✔ Visible on extra large - Extra large -
-
- -
- -
-
- ✔ Your viewport is exactly extra small - Your viewport is NOT exactly extra small -
-
- ✔ Your viewport is exactly small - Your viewport is NOT exactly small -
-
- ✔ Your viewport is exactly medium - Your viewport is NOT exactly medium -
-
- -
-
- ✔ Your viewport is exactly large - Your viewport is NOT exactly large -
-
- ✔ Your viewport is exactly extra large - Your viewport is NOT exactly extra large -
-
diff --git a/docs/layout/utilities-for-layout.md b/docs/layout/utilities-for-layout.md new file mode 100644 index 000000000..50f4ce395 --- /dev/null +++ b/docs/layout/utilities-for-layout.md @@ -0,0 +1,21 @@ +--- +layout: docs +title: Utilities for layout +description: Use any of our dozens of responsive utility classes for showing, hiding, aligning, and spacing content. +group: layout +--- + +For faster mobile-friendly and responsive development, Bootstrap includes dozens of utility classes for showing, hiding, aligning, and spacing content. Below is a primer on what's included in Bootstrap and how these utilities can help you with layout. + +## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + +## Changing `display` + +## Flexbox options + +## Margin and padding + +## Toggle `visibility` -- cgit v1.2.3 From c6fdac94154c4493d422e1441a5e52219b976219 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Fri, 3 Mar 2017 12:59:14 -0800 Subject: update instances of old classes in the docs --- docs/layout/grid.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/layout') diff --git a/docs/layout/grid.md b/docs/layout/grid.md index 31d1f9a81..738eafe62 100644 --- a/docs/layout/grid.md +++ b/docs/layout/grid.md @@ -471,7 +471,7 @@ If more than 12 columns are placed within a single row, each group of extra colu ### 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/). +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 %} @@ -480,7 +480,7 @@ With the handful of grid tiers available, you're bound to run into issues where,
.col-6 .col-sm-3
-
+
.col-6 .col-sm-3
.col-6 .col-sm-3
-- cgit v1.2.3 From a607ead34c62007842f8825068367ab95812e04c Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 5 Mar 2017 13:03:35 -0600 Subject: fill in docs for layout utils page --- docs/layout/utilities-for-layout.md | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'docs/layout') diff --git a/docs/layout/utilities-for-layout.md b/docs/layout/utilities-for-layout.md index 50f4ce395..881f3326d 100644 --- a/docs/layout/utilities-for-layout.md +++ b/docs/layout/utilities-for-layout.md @@ -14,8 +14,18 @@ For faster mobile-friendly and responsive development, Bootstrap includes dozens ## Changing `display` +Use our `display` utilities for responsively toggling common values of the `display` property. Mix it with our grid system, content, or components to show or hide them across specific viewports. + ## Flexbox options +Bootstrap 4 is built with flexbox, but not every element's `display` has been changed to `display: flex` as this would add many unnecessary overrides and unexpectedly change key browser behaviors. Most of [our components](/components/) are built with flexbox enabled. + +Should you need to add `display: flex` to an element, do so with `.d-flex` or one of the responsive variants (e.g., `.d-sm-flex`). You'll need this class or `display` value to allow the use of our extra [flexbox utilities](/utilities/flexbox/) for sizing, alignment, spacing, and more. + ## Margin and padding +Use the `margin` and `padding` [spacing utilities](/utilities/spacing/) to control how elements and components are spaced and sized. Bootstrap 4 includes a five-level scale for spacing utilities, based on a `1rem` value default `$spacer` variable. Choose values for all viewports (e.g., `.mr-3` for `margin-right: 1rem`), or pick responsive variants to target specific viewports (e.g., `.mr-md-3` for `margin-right: 1rem` starting at the `md` breakpoint). + ## Toggle `visibility` + +When toggling `display` isn't needed, you can toggle the `visibility` of an element with our [visibility utilities](/utilities/visibility/). -- cgit v1.2.3 From ac3a2fe9bf5bbfb2d0948da260d5353a03cc5b03 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 5 Mar 2017 13:04:48 -0600 Subject: add more --- docs/layout/utilities-for-layout.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/layout') diff --git a/docs/layout/utilities-for-layout.md b/docs/layout/utilities-for-layout.md index 881f3326d..12ba7006c 100644 --- a/docs/layout/utilities-for-layout.md +++ b/docs/layout/utilities-for-layout.md @@ -28,4 +28,4 @@ Use the `margin` and `padding` [spacing utilities](/utilities/spacing/) to contr ## Toggle `visibility` -When toggling `display` isn't needed, you can toggle the `visibility` of an element with our [visibility utilities](/utilities/visibility/). +When toggling `display` isn't needed, you can toggle the `visibility` of an element with our [visibility utilities](/utilities/visibility/). Invisible elements will still affect the layout of the page, but are visually hidden from visitors. -- cgit v1.2.3 From 2d243086c93e83192668bff431bf44e2c42b467e Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sat, 25 Mar 2017 12:00:34 -0700 Subject: clean up mixin docs --- docs/layout/grid.md | 54 ++++++----------------------------------------------- 1 file changed, 6 insertions(+), 48 deletions(-) (limited to 'docs/layout') diff --git a/docs/layout/grid.md b/docs/layout/grid.md index 738eafe62..ab056a8d3 100644 --- a/docs/layout/grid.md +++ b/docs/layout/grid.md @@ -630,58 +630,16 @@ Mixins are used in conjunction with the grid variables to generate semantic CSS {% 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); - } - } -} +@include make-row($gutters: $grid-gutter-widths); // 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); -} +@include make-col-ready($gutters: $grid-gutter-widths); +@include make-col($size, $columns: $grid-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); -} +@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 -- cgit v1.2.3 From 1a264be8b373419865f55f1c5f92890fd6bcbd03 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sat, 25 Mar 2017 12:12:02 -0700 Subject: Redo semantic grid example and make it real in the docs --- docs/layout/grid.md | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) (limited to 'docs/layout') diff --git a/docs/layout/grid.md b/docs/layout/grid.md index ab056a8d3..67a7289f6 100644 --- a/docs/layout/grid.md +++ b/docs/layout/grid.md @@ -646,46 +646,47 @@ Mixins are used in conjunction with the grid variables to generate semantic CSS 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 this rendered example. - {% highlight scss %} -.container { - max-width: 60em; +.example-container { + width: 800px; @include make-container(); } -.row { + +.example-row { @include make-row(); } -.content-main { + +.example-content-main { @include make-col-ready(); - @media (max-width: 32em) { + @include media-breakpoint-up(sm) { @include make-col(6); } - @media (min-width: 32.1em) { + @include media-breakpoint-up(lg) { @include make-col(8); } } -.content-secondary { + +.example-content-secondary { @include make-col-ready(); - @media (max-width: 32em) { + @include media-breakpoint-up(sm) { @include make-col(6); } - @media (min-width: 32.1em) { + @include media-breakpoint-up(lg) { @include make-col(4); } } {% endhighlight %} -{% highlight html %} -
-
-
...
-
...
+{% example html %} +
+
+
Main content
+
Secondary content
-{% endhighlight %} +{% endexample %} ## Customizing the grid -- cgit v1.2.3 From 9596cb5087d591094cdbd9c4936059e99562e8d3 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sat, 25 Mar 2017 16:00:51 -0700 Subject: clarify docs a bit more and remove some words; closes #21683 --- docs/layout/grid.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/layout') diff --git a/docs/layout/grid.md b/docs/layout/grid.md index 67a7289f6..73c84f8ce 100644 --- a/docs/layout/grid.md +++ b/docs/layout/grid.md @@ -130,11 +130,11 @@ See how aspects of the Bootstrap grid system work across multiple devices with a ## 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. +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`. +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 %} @@ -164,7 +164,7 @@ For example, here are two grid layouts that apply to every device and viewport, ### 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. +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 %} @@ -197,7 +197,7 @@ Auto-layout for flexbox grid columns also means you can set the width of one col ### 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. +Use `col-{breakpoint}-auto` classes to size columns based on the natural width of their content. Use these classes in conjunction with [horizontal alignment](#horizontal-alignment) classes for centering layouts with uneven column sizes as viewport width changes.
{% example html %} -- cgit v1.2.3 From 2b3a2b65a97eff40608538946aeba3b4ad3d8aea Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sat, 25 Mar 2017 16:01:56 -0700 Subject: doh forgot to save --- docs/layout/grid.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/layout') diff --git a/docs/layout/grid.md b/docs/layout/grid.md index 73c84f8ce..95fd999f3 100644 --- a/docs/layout/grid.md +++ b/docs/layout/grid.md @@ -197,7 +197,7 @@ Auto-layout for flexbox grid columns also means you can set the width of one col ### Variable width content -Use `col-{breakpoint}-auto` classes to size columns based on the natural width of their content. Use these classes in conjunction with [horizontal alignment](#horizontal-alignment) classes for centering layouts with uneven column sizes as viewport width changes. +Use `col-{breakpoint}-auto` classes to size columns based on the natural width of their content.
{% example html %} -- cgit v1.2.3 From 1e6902d21f7e3fc226a96351539160433edf3ebf Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sat, 25 Mar 2017 22:27:24 -0700 Subject: fixes #22133 --- docs/layout/grid.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/layout') diff --git a/docs/layout/grid.md b/docs/layout/grid.md index 95fd999f3..ca3537e84 100644 --- a/docs/layout/grid.md +++ b/docs/layout/grid.md @@ -710,10 +710,11 @@ $grid-gutter-widths: ( ### 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: +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 -- cgit v1.2.3 From 9010978c1a1b397a9622e9e9aafeab8de8951a04 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 26 Mar 2017 12:37:28 -0700 Subject: add example and document bug behavior to fix #21967 --- docs/layout/grid.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'docs/layout') diff --git a/docs/layout/grid.md b/docs/layout/grid.md index ca3537e84..2eb704550 100644 --- a/docs/layout/grid.md +++ b/docs/layout/grid.md @@ -162,6 +162,22 @@ For example, here are two grid layouts that apply to every device and viewport, {% 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%; }`). + +
+{% 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. -- cgit v1.2.3 From 1d481519750d3ad5018206408bd583d94a11b54d Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 26 Mar 2017 12:38:13 -0700 Subject: git that a link too for now --- docs/layout/grid.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/layout') diff --git a/docs/layout/grid.md b/docs/layout/grid.md index 2eb704550..01fbfe493 100644 --- a/docs/layout/grid.md +++ b/docs/layout/grid.md @@ -164,6 +164,8 @@ For example, here are two grid layouts that apply to every device and viewport, 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 %}
-- cgit v1.2.3 From 7ca078da815320c75862b6cf25f46ce706570279 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 26 Mar 2017 12:53:50 -0700 Subject: fixes #22111 - add .col-*-auto to the extend in our grid framework mixins so it gets padding - this means we can avoid the col-12 classes in our docs for the responsive variants --- docs/layout/grid.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/layout') diff --git a/docs/layout/grid.md b/docs/layout/grid.md index 01fbfe493..7a16c52a7 100644 --- a/docs/layout/grid.md +++ b/docs/layout/grid.md @@ -224,7 +224,7 @@ Use `col-{breakpoint}-auto` classes to size columns based on the natural width o
1 of 3
-
+
Variable width content
@@ -235,7 +235,7 @@ Use `col-{breakpoint}-auto` classes to size columns based on the natural width o
1 of 3
-
+
Variable width content
-- cgit v1.2.3