postcss-px2vwpro


English | 中文

将px单位转换为视口单位的 (vw, vh, vmin, vmax) 的 PostCSS 插件.

简介

如果你的样式需要做根据视口大小来调整宽度，这个脚本可以将你CSS中的px单位转化为vw，1vw等于1/100视口宽度。

$3

``css
.class {
margin: -10px .5vh;
padding: 5vmin 9.5px 1px;
border: 3px solid black;
border-bottom-width: 1px;
font-size: 14px;
line-height: 20px;
}

.class2 {
padding-top: 10px; / px-to-viewport-ignore /
/ px-to-viewport-ignore-next /
padding-bottom: 10px;
/ Any other comment /
border: 1px solid black;
margin-bottom: 1px;
font-size: 20px;
line-height: 30px;
}

@media (min-width: 750px) {
.class3 {
font-size: 16px;
line-height: 22px;
}
}
`

$3


`css
.class {
margin: -3.125vw .5vh;
padding: 5vmin 2.96875vw 1px;
border: 0.9375vw solid black;
border-bottom-width: 1px;
font-size: 4.375vw;
line-height: 6.25vw;
}

.class2 {
padding-top: 10px;
padding-bottom: 10px;
/ Any other comment /
border: 1px solid black;
margin-bottom: 1px;
font-size: 6.25vw;
line-height: 9.375vw;
}

@media (min-width: 750px) {
.class3 {
font-size: 16px;
line-height: 22px;
}
}
`

上手

$3


使用npm安装
`
$ npm install postcss-px2vwpro --save-dev
`
或者使用yarn进行安装
`
$ yarn add -D postcss-px2vwpro
`

$3

默认参数:
`js
{
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) 横屏时使用的视口宽度

> exclude和include是可以一起设置的，将取两者规则的交集。

#### Ignoring (需要翻译帮助。)

You can use special comments for ignore conversion of single lines:
- / px-to-viewport-ignore-next / — on a separate line, prevents conversion on the next line.
- / px-to-viewport-ignore / — after the property on the right, prevents conversion on the same line.

Example:
`css
/ 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;
}
`

There are several more reasons why your pixels may not convert, the following options may affect this:
propList, selectorBlackList, minPixelValue, mediaQuery, exclude, include.

#### 使用PostCss配置文件时

在postcss.config.js添加如下配置
`js
module.exports = {
plugins: {
// ...
'postcss-px2vwpro': {
// options
}
}
}
`

viewportWidth as function
`js
module.exports = {
plugins: {
// ...
'postcss-px2vwpro': {
// options
viewportWidth({ file }) {
return file.indexOf('vant') !== -1 ? 375 : 750
},
}
}
}
`

#### 直接在gulp中使用，添加gulp-postcss

在 gulpfile.js 添加如下配置:
`js
var gulp = require('gulp');
var postcss = require('gulp-postcss');
var pxtoviewport = require('postcss-px2vwpro');

gulp.task('css', function () {

var processors = [
pxtoviewport({
viewportWidth: 320,
viewportUnit: 'vmin'
})
];

return gulp.src(['build/css/*/.css'])
.pipe(postcss(processors))
.pipe(gulp.dest('build/css'));
});
`

参与贡献

在提PR之前，请先阅读 代码指南
和 贡献指南

测试

为了跑测试案例，您需要安装开发套件:
`
$ npm install
`
然后输入下面的命令:
`
$ npm run test
``

Changelog

变更日志在 这.

版本跟踪

使用 SemVer 做版本跟踪， 可用版本可在这看到

作者

Dmitry Karpunin - Initial work*
* Ivan Bunin

在 contributors 里可以看到谁参与了本项目.

许可

本项目使用 MIT License.

赞助商

访问 Evrone网站以获取有关项目构建的更多信息。

alt="Sponsored by Evrone" width="231" />

借鉴自

* 受 https://github.com/cuth/postcss-pxtorem/ 启发有了这个项目