postcss-px-to-viewport
English | 中文
Based on the evrone/postcss-px-to-viewport project, refactored using Typescript and PostCss8
Note: Because PostCss 8 is refactored, it is not supported below v8. If you use PostCss versions below v8, please use evrone/postcss-px-to-viewport.
A plugin for PostCSS that generates viewport units (vw, vh, vmin, vmax) from pixel units.
Demo
If your project involves a fixed width, this script will help to convert pixels into viewport units.
Input
.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;
}
}
Output
.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;
}
}
Getting Started
Installation
Add via npm
$ npm install @jonny1994/postcss-px-to-viewport --save-dev
or yarn
$ yarn add -D @jonny1994/postcss-px-to-viewport
or pnpm
$ pnpm add -D @jonny1994/postcss-px-to-viewport
Usage
Default Options:
{
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) unit to convert, by default, it is px.viewportWidth(Number) The width of the viewport.unitPrecision(Number) The decimal numbers to allow the vw units to grow to.propList(Array) The properties that can change from px to vw.- Values need to be exact matches.
- Use wildcard _ to enable all properties. Example: ['_']
- Use * at the start or end of a word. (['*position*'] will match background-position-y)
- Use ! to not match a property. Example: ['*', '!letter-spacing']
- Combine the "not" prefix with the other prefixes. Example: ['', '!font']
viewportUnit(String) Expected units.fontViewportUnit(String) Expected units for font.selectorBlackList(Array) The selectors to ignore and leave as px.- If value is string, it checks to see if selector contains the string.
['body']will match.body-class
- If value is regexp, it checks to see if the selector matches the regexp.
[/^body$/]will matchbodybut not.body
- If value is string, it checks to see if selector contains the string.
minPixelValue(Number) Set the minimum pixel value to replace.mediaQuery(Boolean or Regexp or Array of Regexp) Allow px to be converted in media queries.- If value is regexp, the matches media queries params will be converted.
- If value is array, the elements of the array are regexp.
replace(Boolean) replaces rules containing vw instead of adding fallbacks.exclude(Regexp or Array of Regexp) Ignore some files like 'node_modules'- If value is regexp, will ignore the matches files.
- If value is array, the elements of the array are regexp.
include(Regexp or Array of Regexp) Ifincludeis set, only matching files will be converted, for example, only files undersrc/mobile/(include: /\/src\/mobile\//)- If the value is regexp, the matching file will be included, otherwise it will be excluded.
- If value is array, the elements of the array are regexp.
landscape(Boolean) Adds@media (orientation: landscape)with values converted vialandscapeWidth.landscapeUnit(String) Expected unit forlandscapeoptionlandscapeWidth(Number) Viewport width for landscape orientation.rules(Array) Custom path rules.
excludeandincludecan be set together, and the intersection of the two rules will be taken.
rules option
Customize rule overrides based on paths Example:
module.exports = {
plugins: {
// ...
'@jonny1994/postcss-px-to-viewport': {
// ...otherOptions
rules: [
[
/\/node_modules\/vant\//, // The regex or string of the path
(pixels, parsedVal, prop) => {
if (prop.includes('font')) {
return parsedval * 2 + 'vmin'
}
return parsedval * 2 + 'vw'
}
]
]
}
}
}
mediaQuery option
Translate only rules filtered by the mediaQuery option. Example:
module.exports = {
plugins: {
// ...
'@jonny1994/postcss-px-to-viewport': {
// ...otherOptions
mediaQuery: /min\-width/, // or
mediaQuery: [/min\-width/, /max\-width/]
}
}
}
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:
/* 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, rules.
Use with PostCss configuration file
add to your postcss.config.js
module.exports = {
plugins: {
// ...
'@jonny1994/postcss-px-to-viewport': {
// options
}
}
}
Use with gulp-postcss
add to your gulpfile.js:
var gulp = require('gulp')
var postcss = require('gulp-postcss')
var pxtoviewport = require('@jonny1994/postcss-px-to-viewport')
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'))
})
Running the tests
In order to run tests, you need to install dev-packages:
$ npm install
Then run the tests via npm script:
$ npm run test
Changelog
The changelog is here.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
License
This project is licensed under the MIT License.
6 Oct 27, 2022
10 Aug 21, 2022
302 Sep 26, 2022
29 Jun 22, 2022
3 Dec 14, 2022
24 Jan 2, 2023
407 Aug 15, 2022
13 Sep 15, 2022
3 May 18, 2022
4 May 3, 2022