PostCSS Pxtransform

PostCSS 单位转换插件，目前已支持小程序端（px 转rpx），H5 端（px 转 rem）及 RN 端。

基于 postcss-pxtorem。

基于Taro postcss-pxtransform二次开发, 新增了exclude配置

注意: 这只是临时解决方案; 关注Taro官方是否已支持exclude属性

Install

1$ npm install @we125182/postcss-px-transform --save-dev

Usage

小程序

1options = {
2    platform: 'weapp',
3    designWidth: 750,
4}

H5

1options = {
2    platform: 'h5',
3    designWidth: 750,
4}

RN

1options = {
2    platform: 'rn',
3    designWidth: 750,
4}

输入/输出

默认配置下，所有的 px 都会被转换。

1/* input */
2h1 {
3    margin: 0 0 20px;
4    font-size: 32px;
5    line-height: 1.2;
6    letter-spacing: 1px;
7}
8
9/* weapp output */
10h1 {
11    margin: 0 0 20rpx;
12    font-size: 32rpx;
13    line-height: 1.2;
14    letter-spacing: 1rpx;
15}
16
17/* h5 output */
18h1 {
19    margin: 0 0 0.5rem;
20    font-size: 1rem;
21    line-height: 1.2;
22    letter-spacing: 0.025rem;
23}
24
25/* rn output */
26h1 {
27    margin: 0 0 10px;
28    font-size: 16px;
29    line-height: 1.2;
30    letter-spacing: 0.5px;
31}
32

example

1var fs = require('fs');
2var postcss = require('postcss');
3var pxtorem = require('postcss-pxtransform');
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

参数默认值如下：

1{
2    unitPrecision: 5,
3    propList: ['*'],
4    selectorBlackList: [],
5    replace: true,
6    mediaQuery: false,
7    minPixelValue: 0
8}

Type: Object | Null

platform （String）（必填）

weapp 或 h5 或 rn

designWidth（Number）（必填）

640 或 750 或 828

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 (Function | String | RegExp) -- 新增属性

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; }

忽略

属性

当前忽略单个属性的最简单的方法，就是 px 单位使用大写字母。

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}

文件

对于头部包含注释/*postcss-pxtransform disable*/ 的文件，插件不予处理。

剔除

/*postcss-pxtransform rn eject enable*/ 与 /*postcss-pxtransform rn eject disable*/ 中间的代码， 在编译成 RN 端的样式的时候，会被删除。建议将 RN 不支持的但 H5 端又必不可少的样式放到这里面。如：样式重制相关的代码。

1/*postcss-pxtransform rn eject enable*/
2
3.test {
4  color: black;
5}
6
7/*postcss-pxtransform rn eject disable*/