Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add overflow-auto and overflow-hidden utilities #27268

Merged
merged 1 commit into from
Oct 7, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions scss/_utilities.scss
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
@import "utilities/embed";
@import "utilities/flex";
@import "utilities/float";
@import "utilities/overflow";
@import "utilities/position";
@import "utilities/screenreaders";
@import "utilities/shadows";
Expand Down
6 changes: 6 additions & 0 deletions scss/_variables.scss
Original file line number Diff line number Diff line change
Expand Up @@ -991,6 +991,12 @@ $pre-color: $gray-900 !default;
$pre-scrollable-max-height: 340px !default;


// Utilities

$overflows: auto, hidden !default;
$positions: static, relative, absolute, fixed, sticky !default;


// Printing

$print-page-size: a3 !default;
Expand Down
5 changes: 5 additions & 0 deletions scss/utilities/_overflow.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// stylelint-disable declaration-no-important

@each $value in $overflows {
.overflow-#{$value} { overflow: $value !important; }
}
5 changes: 0 additions & 5 deletions scss/utilities/_position.scss
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
// stylelint-disable declaration-no-important

// Common values

// Sass list not in variables since it's not intended for customization.
// stylelint-disable-next-line scss/dollar-variable-default
$positions: static, relative, absolute, fixed, sticky;

@each $position in $positions {
.position-#{$position} { position: $position !important; }
}
Expand Down
1 change: 1 addition & 0 deletions site/_data/nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
- title: Flex
- title: Float
- title: Image replacement
- title: Overflow
- title: Position
- title: Screenreaders
- title: Shadows
Expand Down
25 changes: 25 additions & 0 deletions site/docs/4.1/utilities/overflow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
layout: docs
title: Overflow
description: Use these shorthand utilities for quickly configuring how content overflows an element.
group: utilities
toc: true
---

Barebones `overflow` functionality is provided for two values by default, and they are not responsive.

<div class="bd-example d-md-flex">
<div class="overflow-auto p-3 mb-3 mb-md-0 mr-md-3 bg-light" style="max-width: 260px; max-height: 100px;">
This is an example of using <code>.overflow-auto</code> on an element with set width and height dimensions. By design, this content will vertically scroll.
</div>
<div class="overflow-hidden p-3 bg-light" style="max-width: 260px; max-height: 100px;">
This is an example of using <code>.overflow-hidden</code> on an element with set width and height dimensions.
</div>
</div>

{% highlight html %}
<div class="overflow-auto">...</div>
<div class="overflow-hidden">...</div>
{% endhighlight %}

Using Sass variables, you may customize the overflow utilities by changing the `$overflows` variable in `_variables.scss`.