1.0.0 • Published 10 years ago

pxtorem v1.0.0

Weekly downloads
14
License
MIT
Repository
github
Last release
10 years ago

pxtorem NPM version

A plugin for PostCSS that generates rem units from pixel units.

Usage

Pixels are the easiest unit to use. The only issue with them is that they don't let browsers change the default font size of 16. This script converts every px value to a rem from the properties you choose to allow the browser to set the font size.

Example

var fs = require('fs');
var postcss = require('postcss');
var pxtorem = require('pxtorem');
var css = fs.readFileSync('main.css', 'utf8');
var options = {
    replace: false
};
var processedCss = postcss(pxtorem(options)).process(css).css;

fs.writeFile('main-rem.css', processedCss, function (err) {
  if (err) {
    throw err;
  }
  console.log('Rem file written.');
});

options

Type: Object | Null
Default:

{
    root_value: 16,
    unit_precision: 5,
    prop_white_list: ['font', 'font-size', 'line-height', 'letter-spacing'],
    replace: true,
    media_query: false
}
  • root_value (Number) The root element font size.
  • unit_precision (Number) The decimal numbers to allow the REM units to grow to.
  • prop_white_list (Array) The properties that can change from px to rem.
  • replace (Boolean) replaces rules containing rems instead of adding fallbacks.
  • media_query (Boolean) Allow px to be converted in media queries.

Tools

gulp-pxtorem