postcss-pxtorem

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

Install

1$ npm install postcss postcss-pxtorem --save-dev

Usage

Pixels are the easiest unit to use (opinion). 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.

Input/Output

With the default settings, only font related properties are targeted.

1// input
2h1 {
3    margin: 0 0 20px;
4    font-size: 32px;
5    line-height: 1.2;
6    letter-spacing: 1px;
7}
8
9// output
10h1 {
11    margin: 0 0 20px;
12    font-size: 2rem;
13    line-height: 1.2;
14    letter-spacing: 0.0625rem;
15}

Example

1var fs = require('fs');
2var postcss = require('postcss');
3var pxtorem = require('postcss-pxtorem');
4var css = fs.readFileSync('main.css', 'utf8');
5var options = {
6    replace: false
7};
8var processedCss = postcss(pxtorem(options)).process(css).css;
9
10fs.writeFile('main-rem.css', processedCss, function (err) {
11  if (err) {
12    throw err;
13  }
14  console.log('Rem file written.');
15});

options

Type: Object | Null
Default:

1{
2    rootValue: 16,
3    unitPrecision: 5,
4    propList: ['font', 'font-size', 'line-height', 'letter-spacing'],
5    selectorBlackList: [],
6    replace: true,
7    mediaQuery: false,
8    minPixelValue: 0,
9    exclude: /node_modules/i
10}

• rootValue (Number | Function) Represents the root element font size or returns the root element font size based on the input parameter
• unitPrecision (Number) The decimal numbers to allow the REM units to grow to.
• propList (Array) The properties that can change from px to rem.
  • Values need to be exact matches.
  • Use wildcard * to enable all properties. Example: ['*']
  • Use * at the start or end of a word. (['*position*'] will match background-position-y)
  • Use ! to not match a property. Example: ['*', '!letter-spacing']
  • Combine the "not" prefix with the other prefixes. Example: ['*', '!font*']
• selectorBlackList (Array) The selectors to ignore and leave as px.
  • If value is string, it checks to see if selector contains the string.
    • ['body'] will match .body-class
  • If value is regexp, it checks to see if the selector matches the regexp.
    • [/^body$/] will match body but not .body
• replace (Boolean) Replaces rules containing rems instead of adding fallbacks.
• mediaQuery (Boolean) Allow px to be converted in media queries.
• minPixelValue (Number) Set the minimum pixel value to replace.
• exclude (String, Regexp, Function) The file path to ignore and leave as px.
  • If value is string, it checks to see if file path contains the string.
    • 'exclude' will match \project\postcss-pxtorem\exclude\path
  • If value is regexp, it checks to see if file path matches the regexp.
    • /exclude/i will match \project\postcss-pxtorem\exclude\path
  • If value is function, you can use exclude function to return a true and the file will be ignored.
    • the callback will pass the file path as a parameter, it should returns a Boolean result.
    • function (file) { return file.indexOf('exclude') !== -1; }
• unit (String) Set the default unit to convert, default is px.

Use with gulp-postcss and autoprefixer

1var gulp = require('gulp');
2var postcss = require('gulp-postcss');
3var autoprefixer = require('autoprefixer');
4var pxtorem = require('postcss-pxtorem');
5
6gulp.task('css', function () {
7
8    var processors = [
9        autoprefixer({
10            browsers: 'last 1 version'
11        }),
12        pxtorem({
13            replace: false
14        })
15    ];
16
17    return gulp.src(['build/css/**/*.css'])
18        .pipe(postcss(processors))
19        .pipe(gulp.dest('build/css'));
20});

A message about ignoring properties

Currently, the easiest way to have a single property ignored is to use a capital in the pixel unit declaration.

1// `px` is converted to `rem`
2.convert {
3    font-size: 16px; // converted to 1rem
4}
5
6// `Px` or `PX` is ignored by `postcss-pxtorem` but still accepted by browsers
7.ignore {
8    border: 1Px solid; // ignored
9    border-width: 2PX; // ignored
10}