1.0.1 • Published 2 years ago
@nikonee/postcss-pxtovpt v1.0.1
postcss-pxtovpt
基于 evrone/postcss-px-to-viewport 项目编写,使用 Typescript 和 PostCss8 重构。
注意:因为使用 PostCss 8 重构,所以不支持 v8 以下,如使用 v8 以下的 PostCss 版本,请使用evrone/postcss-px-to-viewport。
将 px 单位转换为视口单位的 (vw, vh, vmin, vmax) 的 PostCSS 插件.
简介
如果你的样式需要做根据视口大小来调整宽度,这个脚本可以将你 CSS 中的 px 单位转化为 vw,1vw 等于 1/100 视口宽度。
输入
.class {
margin: -10px 0.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;
}
}
输出
.class {
margin: -3.125vw 0.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;
}
}
上手
安装
使用 npm 安装
$ npm install @nikonee/postcss-pxtovpt --save-dev
使用 yarn 进行安装
$ yarn add -D @nikonee/postcss-pxtovpt
配置参数
默认参数:
{
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,
rules: []
}
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 or Regexp or Array of Regexp) 媒体查询里的单位是否需要转换单位- 如果值是一个正则表达式,那么匹配的媒体查询参数将被转换
- 如果传入的值是一个数组,那么数组里的值必须为正则
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) 横屏时使用的视口宽度rules
(Array) 自定义路径规则
exclude
和include
是可以一起设置的,将取两者规则的交集。
rules
option
根据路径来自定义规则进行覆盖 Example:
module.exports = {
plugins: {
// ...
'@nikonee/postcss-pxtovpt': {
// ...otherOptions
rules: [
[
/\/node_modules\/vant\//, // 路径的正则或者字符串
(pixels, parsedVal, prop) => {
if (prop.includes('font')) {
return parsedval * 2 + 'vmin'
}
return parsedval * 2 + 'vw'
}
]
]
}
}
}
mediaQuery
option
仅转换由 mediaQuery
参数过滤的规则
Example:
module.exports = {
plugins: {
// ...
'@nikonee/postcss-pxtovpt': {
// ...otherOptions
mediaQuery: /min\-width/, // 或者
mediaQuery: [/min\-width/, /max\-width/]
}
}
}
Ignoring
可以使用特殊注释来忽略单行的转换:
/* 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;
}
如果你写的像素单位不能转换, 以下配置项可能有影响:
propList
,selectorBlackList
,minPixelValue
,mediaQuery
,exclude
,include
.
使用 PostCss 配置文件时
在postcss.config.js
添加如下配置
module.exports = {
plugins: {
// ...
'@nikonee/postcss-pxtovpt': {
// options
}
}
}
直接在 gulp 中使用,添加 gulp-postcss
在 gulpfile.js
添加如下配置:
var gulp = require('gulp')
var postcss = require('gulp-postcss')
var pxtoviewport = require('@nikonee/postcss-pxtovpt')
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'))
})
测试
为了跑测试案例,您需要安装开发套件:
$ yarn install
然后输入下面的命令:
$ yarn test
许可
本项目使用 MIT License.