aboutsummaryrefslogtreecommitdiff
path: root/docs/4.1/utilities/float.md
diff options
context:
space:
mode:
authorMark Otto <[email protected]>2018-04-09 09:00:23 -0700
committerGitHub <[email protected]>2018-04-09 09:00:23 -0700
commit8f7bd419935adfcd53c471a0202083464800619e (patch)
treed0e6ab018a0f41b59a1206cf72ffc79a474e69b9 /docs/4.1/utilities/float.md
parent91730a644f107ca80a747a6f7f0c173eca5708fa (diff)
downloadbootstrap-4.1.0.tar.xz
bootstrap-4.1.0.zip
Ship v4.1.0 (#26218)v4.1.0
* update docs path from docs/4.0/ to docs/4.1/ * bump version to 4.1.0 * Update redirects to work for 4.1 docs move * Update docs version switcher to include latest and link to 4.0 docs * re-run dist * Update package-lock.json * Update docs-navbar.html
Diffstat (limited to 'docs/4.1/utilities/float.md')
-rw-r--r--docs/4.1/utilities/float.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/docs/4.1/utilities/float.md b/docs/4.1/utilities/float.md
new file mode 100644
index 000000000..ec05d3ec7
--- /dev/null
+++ b/docs/4.1/utilities/float.md
@@ -0,0 +1,57 @@
+---
+layout: docs
+title: Float
+description: Toggle floats on any element, across any breakpoint, using our responsive float utilities.
+group: utilities
+toc: true
+---
+
+## Overview
+
+These utility classes float an element to the left or right, or disable floating, based on the current viewport size using the [CSS `float` property](https://developer.mozilla.org/en-US/docs/Web/CSS/float). `!important` is included to avoid specificity issues. These use the same viewport breakpoints as our grid system. Please be aware float utilities have no affect on flex items.
+
+## Classes
+
+Toggle a float with a class:
+
+{% capture example %}
+<div class="float-left">Float left on all viewport sizes</div><br>
+<div class="float-right">Float right on all viewport sizes</div><br>
+<div class="float-none">Don't float on all viewport sizes</div>
+{% endcapture %}
+{% include example.html content=example %}
+
+## Mixins
+
+Or by Sass mixin:
+
+{% highlight scss %}
+.element {
+ @include float-left;
+}
+.another-element {
+ @include float-right;
+}
+.one-more {
+ @include float-none;
+}
+{% endhighlight %}
+
+## Responsive
+
+Responsive variations also exist for each `float` value.
+
+{% capture example %}
+<div class="float-sm-left">Float left on viewports sized SM (small) or wider</div><br>
+<div class="float-md-left">Float left on viewports sized MD (medium) or wider</div><br>
+<div class="float-lg-left">Float left on viewports sized LG (large) or wider</div><br>
+<div class="float-xl-left">Float left on viewports sized XL (extra-large) or wider</div><br>
+{% endcapture %}
+{% include example.html content=example %}
+
+Here are all the support classes;
+
+{% for bp in site.data.breakpoints %}
+- `.float{{ bp.abbr }}-left`
+- `.float{{ bp.abbr }}-right`
+- `.float{{ bp.abbr }}-none`{% endfor %}