# 移动端适配之postcss-px-to-viewport

# 安装

  • 使用npm安装
npm install postcss-px-to-viewport --save-dev
  • 或者使用yarn安装
yarn add -D postcss-px-to-viewport

# 默认配置

{
    unitToConvert: 'px',
    viewportWidth: 320,
    unitPrecision: 5,
    propList: ['*'],
    viewportUnit: 'vw',
    fontViewportUnit: 'vw',
    selectorBlackList: [],
    minPixelValue: 1,
    mediaQuery: false,
    replace: true,
    exclude: undefined,
    include: undefined,
    landscape: false,
    landscapeUnit: 'vw',
    landscapeWidth: 568
}
  • unitToConvert (String) 需要转换的单位,默认为"px"
  • viewportWidth (Number) 设计稿的视口宽度
  • unitPrecision (Number) 单位转换后保留的精度
  • propList (Array) 能转化为vw的属性列表
    • 传入特定的CSS属性;
    • 可以传入通配符"*"去匹配所有属性,例如:[""]
    • 在属性的前或后添加"*",可以匹配特定的属性. (例如['*position*']会匹配background-position-y)
    • 在特定属性前加"!",将不转换该属性的单位. 例如:['*', '!letter-spacing'],将不转换letter-spacing
    • "!" 和 "*"可以组合使用, 例如: ['*', '!font*'],将不转换font-size以及font-weight等属性
  • viewportUnit (String) 希望使用的视口单位
  • fontViewportUnit (String) 字体使用的视口单位
  • selectorBlackList (Array) 需要忽略的CSS选择器,不会转为视口单位,使用原有的px等单位。
    • 如果传入的值为字符串的话,只要选择器中含有传入值就会被匹配
      • 例如selectorBlackList为 ['body'] 的话, 那么.body-class就会被忽略
    • 如果传入的值为正则表达式的话,那么就会依据CSS选择器是否匹配该正则
      • 例如selectorBlackList为 [/^body$/] , 那么 body 会被忽略,而.body不会
  • minPixelValue (Number) 设置最小的转换数值,如果为1的话,只有大于1的值会被转换
  • mediaQuery (Boolean) 媒体查询里的单位是否需要转换单位
  • replace (Boolean) 是否直接更换属性值,而不添加备用属性
  • exclude (Array or Regexp) 忽略某些文件夹下的文件或特定文件,例如'node_modules'下的文件
    • 如果值是一个正则表达式,那么匹配这个正则的文件会被忽略
    • 如果传入的值是一个数组,那么数组里的值必须为正则
  • include (Array or Regexp) 如果设置了include,那将只有匹配到的文件才会被转换,例如只转换'src/mobile'下的文件 (include: /\/src\/mobile\//)
    • 如果值是一个正则表达式,将包含匹配的文件,否则将排除该文件
    • 如果传入的值是一个数组,那么数组里的值必须为正则
  • landscape (Boolean) 是否添加根据 landscapeWidth 生成的媒体查询条件 @media (orientation: landscape)
  • landscapeUnit (String) 横屏时使用的单位
  • landscapeWidth (Number) 横屏时使用的视口宽度

# 项目中如何配置

  • 方法一.在 package.json文件下配置
// package.json
{
    "dependencies": {
        "postcss-px-to-viewport": "^1.1.1"
    },
    "postcss": {
        "plugins": {
            "autoprefixer": {},
            "postcss-px-to-viewport": {
                "viewportWidth": 375,
                "unitPrecision": 3,
                "minPixelValue": 1,
                "fontViewportUnit": "vw",
                "selectorBlackList": [
                ]
            }
        }
    }
}
  • 方法二.在根目录下新建文件 postcss.config.js文件
// postcss.config.js
module.exports = {
    plugins: {
        autoprefixer: {}
    },
    "postcss-px-to-viewport": {
        "viewportWidth": 375,
        "unitPrecision": 3,
        "minPixelValue": 1,
        "fontViewportUnit": "vw",
        "selectorBlackList": []
    }
}

# 忽略某些行的转换

可以使用特殊注释来忽略单行的转换

  • /* px-to-viewport-ignore-next */ 在某一行行上面,防止在下一行进行转换。
  • /* px-to-viewport-ignore */ 在属性的后面,防止在当前行一行上进行转换。 example:
/* example input: */
.class {
  /* px-to-viewport-ignore-next */ // 阻止转换下一行
  width: 10px;
  padding: 10px;
  height: 10px; /* px-to-viewport-ignore */ // 阻止转换当前行
  border: solid 2px #000; /* px-to-viewport-ignore */
}

/* example output: */
.class {
  width: 10px;
  padding: 3.125vw;
  height: 10px;
  border: solid 2px #000;
}

# 参考

postcss-px-to-viewport (opens new window)

最后一次修改时间: 8/17/2020, 9:52:49 PM