From 2239ea6b5346cb9dbc53e0a31f18cd728d62c0a2 Mon Sep 17 00:00:00 2001 From: Mark Otto <markdotto@gmail.com> Date: Mon, 2 Jan 2017 11:46:06 -0800 Subject: [PATCH] document new utils and change organization to match css --- docs/_data/nav.yml | 3 ++- docs/utilities/position.md | 31 +++++++++++++++++++++++++++++++ docs/utilities/sizing.md | 21 +++------------------ 3 files changed, 36 insertions(+), 19 deletions(-) create mode 100644 docs/utilities/position.md diff --git a/docs/_data/nav.yml b/docs/_data/nav.yml index 256e1bb9d7..97e6b1b154 100644 --- a/docs/_data/nav.yml +++ b/docs/_data/nav.yml @@ -60,9 +60,10 @@ - title: Display property - title: Image replacement - title: Invisible content + - title: Position - title: Responsive helpers - title: Screenreaders - - title: Sizing and positioning + - title: Sizing - title: Spacing - title: Typography - title: Vertical align diff --git a/docs/utilities/position.md b/docs/utilities/position.md new file mode 100644 index 0000000000..6b8268c488 --- /dev/null +++ b/docs/utilities/position.md @@ -0,0 +1,31 @@ +--- +layout: docs +title: Position +group: utilities +--- + +Position utilities are helpful for quickly placing a component outside the normal document flow. Choose from a handful of fixed or sticky position classes as needed. + +### Fixed top + +Position an element at the top of the viewport, from edge to edge. Be sure you understand the ramifications of fixed position in your project; you may need to add aditional CSS. + +{% highlight html %} +<div class="fixed-top">...</div> +{% endhighlight %} + +### Fixed bottom + +Position an element at the bottom of the viewport, from edge to edge. Be sure you understand the ramifications of fixed position in your project; you may need to add aditional CSS. + +{% highlight html %} +<div class="fixed-bottom">...</div> +{% endhighlight %} + +### Sticky top + +Position an element at the top of the viewport, from edge to edge, but only after you scroll past it. The `.sticky-top` utility uses CSS's `position: sticky`, which isn't fully supported in all browsers. + +{% highlight html %} +<div class="sticky-top">...</div> +{% endhighlight %} diff --git a/docs/utilities/sizing.md b/docs/utilities/sizing.md index a6de778ca2..eabb4653ac 100644 --- a/docs/utilities/sizing.md +++ b/docs/utilities/sizing.md @@ -1,27 +1,12 @@ --- layout: docs -title: Sizing and positioning +title: Sizing group: utilities --- -## Fixed positioning +Easily make an element as wide or as tall (relative to its parent) with our width and height utilities. Includes support for `25%`, `50%`, `75%`, and `100%` by default. -The `.pos-f-t` class can be used to easily position elements at the top of the viewport and make them as wide as the viewport. **Be sure you understand the ramifications of fixed-position elements within your project.** Here's how the class is defined: - -{% highlight scss %} -.pos-f-t { - position: fixed; - top: 0; - right: 0; - left: 0; - z-index: $zindex-navbar-fixed; -} -{% endhighlight %} - - -## Width and height - -Easily make an element as wide or as tall (relative to its parent) with our width and height utilities. Includes support for `25%`, `50%`, `75%`, and `100%`. +Width and height utilities are generated from the `$sizes` Sass map in `_variables.scss`. Modify those values as you need to generate different utilities here. {% example html %} <div class="w-25 p-3" style="background-color: #eee;">Width 25%</div> -- GitLab