@minko-fe/postcss-pxtoviewport
v1.5.0
Published
✨ A CSS post-processor that converts px to viewport units (vw, vh, vmin, vmax).
Downloads
935
Maintainers
Readme
postcss-pxtoviewport
中文 | English
PostCSS插件,可以从像素单位生成 viewport 单位(vw, vh, vmin, vmax)
如果你不需要以下新特性,可以使用官方库:postcss-px-to-viewport
✨ 新特性
- 在样式文件中重写任意
postcss-pxtoviewport
支持的选项 - 在样式文件动态禁用转化viewport
- 兼容vite,解决了打包后样式混乱的问题
🔧 安装
pnpm install postcss @minko-fe/postcss-pxtoviewport -D
✍️ 使用
postcss.config.js
example
// postcss.config.js
import pxtoviewport from '@minko-fe/postcss-pxtoviewport'
export default {
plugins: [
pxtoviewport({
viewportWidth: 375,
selectorBlackList: ['some-class'],
propList: ['*'],
atRules: ['media'],
// ...
}),
],
}
options
| Name | Type | Default | Description |
| ----------------- | ------------------------------------------------------------------- | --------------- | ---------------------------------------------------------------------------------------------- |
| unitToConvert | string
| px
| 需要转化的单位,默认 px
|
| viewportWidth | number
| ((input: Input) => number)
| 375 | 视图窗口宽度 |
| unitPrecision | number
| 5 | 小数点后精度 |
| propList | string[]
| ['*']
| 可以从 px 改变为 vw 的属性,参考:propList |
| viewportUnit | string
| vw
| 转化后的单位 |
| fontViewportUnit | string
| vw
| font 转化后的单位 |
| selectorBlackList | (string \| RegExp)[]
| [] | 忽略的选择器,保留为 px。参考:selectorBlackList |
| replace | boolean
| true | 直接在 css 规则上替换值而不是添加备用 |
| atRules | boolean
| string[]
| false | 允许at-rules
中转换。参考 At-rule |
| minPixelValue | number
| 0 | 最小的 px 转化值(小于这个值的不转化) |
| include | string
| RegExp
| ((filePath: string) => boolean)
| null
| null | 包括的文件(与 exclude 相反)。优先级比 exclude 高。规则同 exclude
|
| exclude | string
| RegExp
| ((filePath: string) => boolean)
| null
| /node_modules/i | 忽略的文件路径。参考:exclude |
| disable | boolean
| false | 关闭插件 |
| convertUnit | ConvertUnit
| ConvertUnit[]
| false | null | null | 插件处理的最后阶段转换单位 |
propList
- 值需要完全匹配
- 使用通配符
*
来启用所有属性. Example:['*']
- 在一个词的开头或结尾使用
*
. (['*position*']
will matchbackground-position-y
) - 使用
!
不匹配一个属性. Example:['*', '!letter-spacing']
- 组合
!
与*
. Example:['*', '!font*']
selectorBlackList
- 如果值是字符串,它会检查选择器是否包含字符串.
['body']
will match.body-class
- 如果值是正则,它会检查选择器是否与正则相匹配.
[/^body$/]
will matchbody
but not.body
exclude
- 如果值是字符串,它检查文件路径是否包含字符串
'exclude'
will match\project\postcss-pxtoviewport\exclude\path
- 如果值是正则,它将检查文件路径是否与正则相匹配
/exclude/i
will match\project\postcss-pxtoviewport\exclude\path
- 如果值是函数,你可以使用排除函数返回 true,文件将被忽略
- 回调将传递文件路径作为一个参数,它应该返回一个 boolean
function (file) { return file.includes('exclude') }
✨ 关于新特性
⚙️ 在 css 中,动态设置插件选项
当前文件禁用插件
/* pxtoviewport?disable=true */
.rule {
font-size: 15px; // 15px
}
设置 viewportWidth
/* pxtoviewport?viewportWidth=750 */
.rule {
font-size: 30px; // 4vw
}
🌰 以上只是简单的栗子,你可以在 css 文件中设置任意 postcss-pxtoviewport
支持的选项
聪明的你,或许已经看出来了,/* pxtoviewport?disable=true */
很像浏览器 url?😼
没错。关于规范,只需参考:query-string
例子
/* pxtoviewport?disable=false&viewportWidth=750&propList[]=*&replace=false&selectorBlackList[]=/some-class/i */
在 css 中,忽略某一行
.rule {
/* pxtoviewport-disable-next-line */
font-size: 15px; // 15px
}
如果你写 15PX
(只要不是 px
),插件也会忽略,因为 unitToConvert
默认是 px
如果你希望使用 PX
忽略并且希望最后得到的单位是 px
,你可以这样
// postcss.config.js
import pxtoviewport from '@minko-fe/postcss-pxtoviewport'
export default {
plugins: [
pxtoviewport({
convertUnit: {
source: /px$/i,
target: 'px',
},
}),
],
}
❤️ 感谢
@tcstory/postcss-px-to-viewport
👀 相关
A CSS post-processor that converts px to rem: postcss-pxtorem
💕 支持
如果这个仓库帮了你的忙,请不吝给个 star,谢谢!😎