Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

postcss-unit-unit

Package Overview
Dependencies
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

postcss-unit-unit

A CSS post-processor that converts px to viewport units (vw, vh, rpx, rem, vmin, vmax).

  • 1.0.4
  • npm
  • Socket score

Version published
Weekly downloads
4
increased by33.33%
Maintainers
1
Weekly downloads
 
Created
Source

CSS 单位自动转换工具

该插件是基于 postcss-px-to-viewport 改造的 CSS 单位转换工具,由 Postcss8.x 版本接口实现,可支持任意单位转为任意单位。

注意:配置参数 fullViewportWidth 为目标单位总宽度,如目标单位为 rpx 时填写 750, 目标单位为 vw 时填写 100,其他情况根据比例计算。

安装

npm install postcss-unit-unit --save-dev

参数

{
  "unitToConvert": "px",
  "viewportWidth": 375,
  "unitPrecision": 5,
  "viewportUnit": "rpx",
  "fontViewportUnit": "rpx",
  "fullViewportWidth": 750,
  "selectorBlackList": [],
  "propList": ["*"],
  "minPixelValue": 1,
  "mediaQuery": false,
  "replace": true,
  "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) 横屏时使用的视口宽度

使用配置下

PostCSS
// postcss.config.js
module.exports = {
  plugins: {
    "postcss-unit-unit": {
      viewportWidth: 375,
    },
  },
};
vite
// vite.config.js
import PxToViewport from "postcss-unit-unit";

export default defineConfig({
  css: {
    postcss: {
      plugins: [
        PxToViewport({
          viewportWidth: 375,
        }),
      ],
    },
  },
});

Keywords

FAQs

Package last updated on 11 Apr 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc