README.md

sass-enhance

Sass mixins that enable the implementaiton of a responsive design with a progressive enhancement approach. Originally written for use at Causes.

Installing

npm

To install sass-enhance using npm, simply run:

npm install sass-enhance

If you'd like to save sass-enhance as a dependency in your project's package.json file, run:

npm install --save sass-enhance

Bower

To install sass-enhance using Bower, simply run:

bower install sass-enhance

If you'd like to save sass-enhance as a dependency in your project's bower.json manifest file, run:

bower install --save sass-enhance

Manually

Simply download the _sass-enhance.scss file from this repo and place it somewhere useful.

curl

curl -O https://raw.githubusercontent.com/brigade/sass-enhance/master/_sass-enhance.scss

wget

wget https://raw.githubusercontent.com/brigade/sass-enhance/master/_sass-enhance.scss

Using

sass-enhance defines mixins for media queries, enhance and degrade.

These mixins each take a breakpoint as an argument, and a block of styles to apply when that breakpoint is activated. Optionally, you can specify ranged breakpoints using until.

Breakpoints can be named, as defined in the $breakpoint-max-widths variable (e.g. "small"), or arbitrary widths (e.g. "720px"). By default, the breakpoints in the Bootstrap grid are used.

enhance

The enhance mixin is used to apply styles to a selector as the viewport gets wider. It can be used to progressively enhance a page. We prefer using enhance over degrade because it is a mobile-first implementation that tends to be simpler in its execution.

To adjust the padding from 1em to 2em at the medium breakpoint and wider, you could use the following SCSS:

.my-selector {
  padding: 1em;

  @include enhance(medium) {
    padding: 2em;
  }
}

If you wanted to only apply a different amount of padding for only the small viewport width and nothing wider or narrower, you could use the following SCSS:

.my-selector {
  padding: 1em;

  @include enhance(small until medium) {
    padding: 2em;
  }
}

degrade

There are some cases where enhance does not work or make sense. In these cases, it is okay to use degrade to gracefully degrade the styles as the viewport gets narrower.

To adjust the padding from 2em to 1em at the small breakpoint and narrower, you could use the following SCSS:

.my-selector {
  padding: 2em;

  @include degrade(small) {
    padding: 1em;
  }
}

Note: this produces functionally equivalent styles as the first example.

Likewise, if you wanted to only apply a different amount of padding for only the small viewport width and nothing wider or narrower, you could use the following SCSS:

.my-selector {
  padding: 2em;

  @include degrade(small until medium) {
    padding: 1em;
  }
}

breakpoint-min-width

This mixin will return the min-width of a named breakpoint. The min-width is defined as the pixel value of the previous named breakpoint, plus one pixel.

.my-selector {
  min-width: breakpoint-min-width(small); // 768px with default settings
}

breakpoint-max-width

Returns the max-width of a named breakpoint. This is the raw pixel value associated with the named breakpoint in the $breakpoint-max-widths variable.

.my-selector {
  max-width: breakpoint-max-width(small); // 991px with default settings
}

Configuring breakpoints

To configure your breakpoints, set the $breakpoint-max-widths variable before importing sass-enhance.

This variable is a comma separated list of breakpoint names and max-width pairs. You can choose whatever names and widths you prefer. The default is something like:

$breakpoint-max-widths: extra-small      767px,
                        small            991px,
                        medium           1199px,
                        large            99999px !default;

Code of conduct

This project adheres to the Open Code of Conduct. By participating, you are expected to honor this code.

License

Released under the MIT License.