postcss-pxtorem-multi

This is a fork based on postcss-pxtorem. The difference is postcss-pxtorem-multi supports multiple rules.

Install

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

options

Type: Object | Null
Default:

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

• include (String|RegExp|Array<String|RegExp>) Files to include
• exclude (String|RegExp|Array<String|RegExp>) Files to exclude
• rootValue (Number) The root element font size.
• 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.
• rules: (Object) Supporting all the above parameters.

Use with gulp-postcss (Gulp)

1var gulp = require('gulp');
2var postcss = require('gulp-postcss');
3var pxtorem = require('postcss-pxtorem-multi');
4
5gulp.task('css', function () {
6
7    var processors = [
8        pxtorem({
9            rootValue: 16,
10            rules: [
11                {
12                    include: 'common.css',
13                    rootValue: 32,
14                }
15            ]
16        })
17    ];
18
19    return gulp.src(['build/css/**/*.css'])
20        .pipe(postcss(processors))
21        .pipe(gulp.dest('build/css'));
22});

Use with postcss-loader (Webpack)

postcss.config.js or .postcssrc.js

1module.exports = {
2    plugins: {
3        "postcss-pxtorem-multi": {
4            rootValue: 75,
5            propList: ['*'],
6            rules: [
7                {
8                    include: ['/node_modules/vant/'],
9                    rootValue: 37.5,
10                    propList: ['*'],
11                }
12            ]
13        }
14    }
15}

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-multi` but still accepted by browsers
7.ignore {
8    border: 1Px solid; // ignored
9    border-width: 2PX; // ignored
10}