postcss-plugin-pr2rem

postcss-plugin-pr2rem

postcss plugin pr2rem.

Features

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

Installation

$ npm i --save postcss-plugin-pr2rem

Usage

input and output

// input
h1 {
  margin: 0 10px 0 20pr;
  font-size: 32pr;
  line-height: 1.2;
  letter-spacing: 1px;
}

// output
h1 {
  margin: 0 10px 0 0.2rem;
  font-size: 0.32rem;
  line-height: 1.2;
  letter-spacing: 0.01rem;
}

original

import { writeFile, readFileSync } from 'fs';
import postcss from 'postcss';
import pxtorem from 'postcss-plugin-px2rem';

const css = readFileSync('/path/to/test.css', 'utf8');
const options = {
  replace: false,
};
const processedCss = postcss(pxtorem(options)).process(css).css;

writeFile('/path/to/test.rem.css', processedCss, err => {
  if (err) throw err;
  console.log('Rem file written.');
});

postcss.config.js

const px2rem = require('postcss-plugin-px2rem');

const px2remConfig = {
    // 设计图为1242px
    rootValue: 62.1,
    unitPrecision: 5,
    propWhiteList: [],
    propBlackList: ['font-size'],
    selectorBlackList: [],
    ignoreIdentifier: '00',
    replace: true,
    mediaQuery: false,
    minPixelValue: 0
};


module.exports = {
    plugins: [
        px2rem(px2remConfig)
    ]
};

Configuration

Default:

{
  rootValue: 100,
  unitPrecision: 5,
  propWhiteList: [],
  propBlackList: [],
  selectorBlackList: [],
  ignoreIdentifier: false,
  replace: true,
  mediaQuery: false,
  minPixelValue: 0
}

• rootValue (Number|Object) The root element font size. Default is 100.
  • If rootValue is an object, for example { px: 50, rpx: 100 }, it will replace rpx to 1/100 rem , and px to 1/50 rem.
• unitPrecision (Number) The decimal numbers to allow the REM units to grow to.
• propWhiteList (Array) The properties that can change from px to rem.
  • Default is an empty array that means disable the white list and enable all properties.
  • Values need to be exact matches.
• propBlackList (Array) The properties that should not change from px to rem.
  • Values need to be exact matches.
• 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
• ignoreIdentifier (Boolean/String) a way to have a single property ignored, when ignoreIdentifier enabled, then replace would be set to true automatically.
• 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.

License

MIT

THANKS

ant-tool/postcss-plugin-px2rem