accoutrement-scale
Advanced tools
Comparing version 3.2.0 to 4.0.0-alpha.1
Accoutrement-Scale Changelog | ||
============================ | ||
4.0.0-alpha.1 - 09/06/17 | ||
------------------------ | ||
- BREAKING: Remove overly-opinionated baseline type tools | ||
including `font-size` and `baseline` mixins. | ||
These settings are more clear when established explicitly in CSS | ||
- BREAKING: Rename `scale()` => `ratio()` to avoid conflicts with CSS | ||
- BREAKING: Remove stand-alone `browser-ems()` function… | ||
- NEW: Allow `browser-ems` as a `$to-unit` argument | ||
in the `contert-units()` function. | ||
- NEW: Add (private) `pow()` functions, | ||
so that MathSass is no longer a dependency for non-integer steps | ||
3.2.0 - 08/23/17 | ||
@@ -6,0 +19,0 @@ ---------------- |
{ | ||
"name": "accoutrement-scale", | ||
"version": "3.2.0", | ||
"version": "4.0.0-alpha.1", | ||
"description": "Size and scale helpers for typography and layout.", | ||
"homepage": "https://github.com/oddbird/accoutrement-scale", | ||
"homepage": "http://oddbird.net/accoutrement-scale/", | ||
"repository": { | ||
@@ -11,9 +11,9 @@ "type": "git", | ||
"devDependencies": { | ||
"chalk": "^1.1.1", | ||
"chalk": "^2.1.0", | ||
"gulp": "^3.9.1", | ||
"gulp-sass-lint": "^1.3.2", | ||
"gulp-util": "^3.0.7", | ||
"mathsass": "^0.9.5", | ||
"mocha": "^2.5.3", | ||
"sass-true": "^2.2.2", | ||
"gulp-sass-lint": "^1.3.3", | ||
"gulp-util": "^3.0.8", | ||
"mathsass": "^0.10.1", | ||
"mocha": "^3.5.0", | ||
"sass-true": "^3.0.0", | ||
"sassdoc": "^2.3.0", | ||
@@ -34,9 +34,10 @@ "sassdoc-theme-herman": "^1.0.0-alpha.9" | ||
"eyeglass": { | ||
"needs": "^0.8.2", | ||
"sassDir": "./_mq.scss", | ||
"exports": false | ||
"sassDir": "sass", | ||
"exports": false, | ||
"name": "accoutrement-color", | ||
"needs": "^1.0.0" | ||
}, | ||
"scripts": { | ||
"test": "node_modules/.bin/mocha", | ||
"release": "npm run test && gulp sasslint && gulp sassdoc" | ||
"commit": "npm run test && gulp sasslint && gulp sassdoc" | ||
}, | ||
@@ -43,0 +44,0 @@ "bugs": { |
@@ -5,4 +5,3 @@ accoutrement-scale | ||
Sass size & scale management tools | ||
by [OddBird][oddbird], | ||
part of our [Accoutrement][accoutrement] suite. | ||
by [OddBird][oddbird]. | ||
Gather all your sizes into a single map, | ||
@@ -13,3 +12,2 @@ generate new sizes based on [modular scales][ms] | ||
[accoutrement]: http://oddbird.net/accoutrement/ | ||
[oddbird]: http://oddbird.net/ | ||
@@ -19,7 +17,26 @@ [ms]: http://www.modularscale.com/ | ||
More Accoutrement Tools | ||
----------------------- | ||
- [Init](http://oddbird.net/accoutrement-init/) | ||
provides light-weight browser-normalization. | ||
- [Color](http://oddbird.net/accoutrement-color/) | ||
provides color-palette management and contrast-ratio utilities. | ||
- [Type](http://oddbird.net/accoutrement-type/) | ||
provides webfont management tools, | ||
and other typography helpers. | ||
- [Layout](http://oddbird.net/accoutrement-layout/) | ||
provides layout utilities such as | ||
box-sizing, intrinsic ratios, z-index management, | ||
named media-queries, and a clearfix. | ||
Quick Start | ||
----------- | ||
Install the package with npm or yarn: | ||
```bash | ||
npm install accoutrement-scale | ||
yarn add accoutrement-scale | ||
``` | ||
@@ -30,6 +47,6 @@ | ||
```scss | ||
@import 'path/to/accoutrement-scale/sass/scale' | ||
@import '<path-to>/accoutrement-scale/sass/scale'; | ||
``` | ||
Establish your palette of ratios and sizes: | ||
Establish your palette of ratios (modular scales) and sizes: | ||
@@ -42,3 +59,12 @@ ```scss | ||
$sizes: ( | ||
// define explicit values | ||
'root': 24px, | ||
'icons': 1em, | ||
'page': 8in, | ||
// reference existing sizes | ||
'text': 'root' | ||
// apply adjustments and conversions | ||
// using named-ratios or arbitrary functions | ||
'rhythm': 'root' ('fifth': 1, 'convert-units': 'rem'), | ||
@@ -50,13 +76,13 @@ | ||
'page': 8in, | ||
// define calc() output based on existing sizes | ||
'viewport-relative': calc(%s + %s) ('root', 2vw), | ||
); | ||
``` | ||
Results will be returned in the units they were defined, | ||
but can be converted in the map settings (as above), | ||
or on-the-fly using `size`: | ||
Access your named sizes using the `size()` function, | ||
and even convert-units on-the-fly: | ||
```scss | ||
.example { | ||
// size('page') would return `8in`... | ||
font-size('text'); | ||
width: size('page', 'px'); | ||
@@ -66,13 +92,3 @@ } | ||
Access your sizes from anywhere, | ||
with helpers for setting font-sizes and line-heights: | ||
```scss | ||
h1 { | ||
@include font-size('h1'); | ||
max-width: size('page'); | ||
} | ||
``` | ||
We can only calculate integer steps along an exponential scale, | ||
We can only calculate integer steps along an exponential modular scale, | ||
but if you want more power, | ||
@@ -79,0 +95,0 @@ install [MathSass][mathsass], |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
382497
38
160
98
1