Introduction

If your style needs to adjust the width according to the viewport size, this script can convert the px unit in your CSS to vw, 1vw is equal to 1/100 viewport width.

Install

npm install

npm install postcss-px-to-viewport --save-dev

yarn installation

yarn add -D postcss-px-to-viewport

pnpm install

pnpm add -D postcss-px-to-viewport

configuration parameters

Default parameters:

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

neglect

You can ignore single-line conversions with a special comment:

/* px-to-viewport-ignore-next */ — on another line, prevent transition on next line
/* px-to-viewport-ignore */ — after the property on the right, preventing transitions on the same line

Tip: The current version v1.1.1has not been updated for a long time, and it does not take effect in the vue3 project

Using PostCss configuration files

Create a new postcss.config.js in the project root directory, and add the following configuration to postcss.config.js:

module.exports = {
    
    
  plugins: {
    
    
    // ...
    'postcss-px-to-viewport': {
    
    
      // 上面的配置参数
    }
  }
}

You need to restart the project after modifying the configuration

input Output

// 输入
section {
    
    
  width: 320px;
  height: 300px;
  display: flex;
  flex-direction: column;
  justify-content: center;
  align-items: center;
  margin: 0 auto;
  background-color: aqua;
}
// 输出
section {
    
    
  width: 100vw;
  height: 93.75vw;
  display: flex;
  flex-direction: column;
  justify-content: center;
  align-items: center;
  margin: 0 auto;
  background-color: aqua;
}

question

The current version v1.1.1has not been updated for a long time, resulting in the failure of functions such as and, currently only all conversions are 忽略possibleinclude

2022-05-26 update

Use the postcss-px-to-viewport console to report the following code:

postcss-px-to-viewport: postcss.plugin was deprecated. Migration guide: https://evilmartians.com/chronicles/postcss-8-plugin-migration

It can be solved by postcss-px-to-viewportreplacing postcss-px-to-viewport-8-pluginthe configuration file:

module.exports = {
    
    
  plugins: {
    
    
    // ...
    'postcss-px-to-viewport-8-plugin': {
    
    
      // 上面的配置参数
    }
  }
}

However, it still cannot solve the problem of function failure under the vue3 project 忽略and includeother functions

postcss-px-to-viewport installation and use