@ichong/px-to-viewport

    1.0.2 • Public • Published

    PostCSS px转viewport插件

    @ichong

    安装

    npm i -D @ichong/px-to-viewport

    配置参数

    默认参数:

    {
      unitToConvert: 'px',
      viewportWidth: 750,
      unitPrecision: 5,
      viewportUnit: 'vw',
      fontViewportUnit: 'vmin',
      selectorBlackList: [],
      propList: ['*'],
      minPixelValue: 1,
      mediaQuery: false,
      replace: true,
      landscape: false,
      landscapeUnit: 'vw',
      landscapeWidth: 568,
      exclude: /(\/|\\)(node_modules)(\/|\\)/
    }
    • 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' 下的文件
      • 如果值是一个正则表达式,那么匹配这个正则的文件会被忽略
      • 如果传入的值是一个数组,那么数组里的值必须为正则
    • landscape (Boolean) 是否添加根据 landscapeWidth 生成的媒体查询条件 @media (orientation: landscape)
    • landscapeUnit (String) 横屏时使用的单位
    • landscapeWidth (Number) 横屏时使用的视口宽度

    使用方法

    module.exports = {
      plugins: {
        ...
        'postcss-px-to-viewport': {
          // options
        }
      }
    }

    说明

    Install

    npm i @ichong/px-to-viewport

    DownloadsWeekly Downloads

    6

    Version

    1.0.2

    License

    ISC

    Unpacked Size

    13.3 kB

    Total Files

    5

    Last publish

    Collaborators

    • a289459798
    • rambos
    • daxiong123
    • jszh