Skip to content

justinskolnick/unitize

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

unitize

The Sass functions in _unitize.scss provide all the benefits of relative units like em and rem without the hassle of having to run calculations. Whole numbers are nice.

Unitize processes numerical values as well as those declarations that Sass identifies as lists. Lists include shorthand CSS declarations like 2px 4px 5px 3px and inset 2px 2px 4px black. Strings, colors, and values already assigned a unit (e.g., inset, #000, 20%) pass undisturbed through the function.

How it works

Configuration

First, install _unitize.scss and @import 'unitize'.

The default $root-font-size is 12; to override this value, assign a new (and unitless) $root-font-size in a separate config file or at the top of your SCSS.

$root-font-size: 10;

If using rems, set the document's root font size on the HTML element as pixels or a percentage. Given a $root-font-size of 10, the rulesets below yield font-sizes of 12px and 62.5%, respectively.

html {
  font-size: $root-font-size + px;
  font-size: percentage($root-font-size/16);
}

Usage

Send values through one of em(), rem(), or unitize(). The following examples assume the default $root-font-size of 12.

unitize() returns px values:

// $root-font-size: 12;

margin: unitize(4 6% 2 9px);
// => margin: 4px 6% 2px 9px;

box-shadow: unitize(inset 5 2 #cfc);
// => box-shadow: inset 5px 2px #ccffcc;

rem() returns values in rems, relative to the $root-font-size:

// $root-font-size: 12;

padding: rem(4 6 2 9);
// => padding: 0.33333rem 0.5rem 0.16667rem 0.75rem;

text-shadow: rem(3 3 6 rgba(0, 0, 0, 0.5));
// => text-shadow: 0.25rem 0.25rem 0.5rem rgba(0, 0, 0, 0.5);

em() yields values relative to the $root-font-size or a font-size supplied in the optional second argument.

// $root-font-size: 12;

font-size: em(12);
// => font-size: 1em;

line-height: em(18, 12);
// => line-height: 1.5em;

For examples and recommended uses, see test.scss, along with the compiled CSS in test.css.

TODO

Cleanup

License

Copyright © 2012-2013 Justin Skolnick

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

SCSS acetaminophen for relative units.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published