"readme": "# postcss-px-to-viewport\r\n[](http://badge.fury.io/js/postcss-px-to-viewport)\r\n\r\nEnglish | [中文](README_CN.md) \r\n\r\nA plugin for [PostCSS](https://github.com/postcss/postcss) that generates viewport units (vw, vh, vmin, vmax) from pixel units.\r\n\r\n## Demo\r\n\r\nIf your project involves a fixed width, this script will help to convert pixels into viewport units.\r\n\r\n### Input\r\n\r\n```css\r\n.class {\r\n margin: -10px .5vh;\r\n padding: 5vmin 9.5px 1px;\r\n border: 3px solid black;\r\n border-bottom-width: 1px;\r\n font-size: 14px;\r\n line-height: 20px;\r\n}\r\n\r\n.class2 {\r\n padding-top: 10px; /* px-to-viewport-ignore */\r\n /* px-to-viewport-ignore-next */\r\n padding-bottom: 10px;\r\n /* Any other comment */\r\n border: 1px solid black;\r\n margin-bottom: 1px;\r\n font-size: 20px;\r\n line-height: 30px;\r\n}\r\n\r\n@media (min-width: 750px) {\r\n .class3 {\r\n font-size: 16px;\r\n line-height: 22px;\r\n }\r\n}\r\n```\r\n\r\n### Output\r\n```css\r\n.class {\r\n margin: -3.125vw .5vh;\r\n padding: 5vmin 2.96875vw 1px;\r\n border: 0.9375vw solid black;\r\n border-bottom-width: 1px;\r\n font-size: 4.375vw;\r\n line-height: 6.25vw;\r\n}\r\n\r\n.class2 {\r\n padding-top: 10px;\r\n padding-bottom: 10px;\r\n /* Any other comment */\r\n border: 1px solid black;\r\n margin-bottom: 1px;\r\n font-size: 6.25vw;\r\n line-height: 9.375vw;\r\n}\r\n\r\n@media (min-width: 750px) {\r\n .class3 {\r\n font-size: 16px;\r\n line-height: 22px;\r\n }\r\n}\r\n```\r\n\r\n## Getting Started\r\n\r\n### Installation\r\nAdd via npm\r\n```\r\n$ npm install @apimediaru/postcss-px-to-viewport --save-dev\r\n```\r\n\r\n\r\n### Usage\r\n\r\nDefault Options:\r\n```js\r\n{\r\n unitToConvert: 'px',\r\n viewportWidth: 320,\r\n unitPrecision: 5,\r\n propList: ['*'],\r\n viewportUnit: 'vw',\r\n fontViewportUnit: 'vw',\r\n selectorBlackList: [],\r\n minPixelValue: 1,\r\n mediaQuery: false,\r\n replace: true,\r\n exclude: undefined,\r\n include: undefined,\r\n landscape: false,\r\n landscapeUnit: 'vw',\r\n landscapeWidth: 568,\r\n \r\n api_multiplier: 1\r\n}\r\n```\r\n- `unitToConvert` (String) unit to convert, by default, it is px.\r\n- `viewportWidth` (Number) The width of the viewport.\r\n- `unitPrecision` (Number) The decimal numbers to allow the vw units to grow to.\r\n- `propList` (Array) The properties that can change from px to vw.\r\n - Values need to be exact matches.\r\n - Use wildcard * to enable all properties. Example: ['*']\r\n - Use * at the start or end of a word. (['*position*'] will match background-position-y)\r\n - Use ! to not match a property. Example: ['*', '!letter-spacing']\r\n - Combine the \"not\" prefix with the other prefixes. Example: ['*', '!font*']\r\n- `viewportUnit` (String) Expected units.\r\n- `fontViewportUnit` (String) Expected units for font.\r\n- `selectorBlackList` (Array) The selectors to ignore and leave as px.\r\n - If value is string, it checks to see if selector contains the string.\r\n - `['body']` will match `.body-class`\r\n - If value is regexp, it checks to see if the selector matches the regexp.\r\n - `[/^body$/]` will match `body` but not `.body`\r\n- `minPixelValue` (Number) Set the minimum pixel value to replace.\r\n- `mediaQuery` (Boolean) Allow px to be converted in media queries.\r\n- `replace` (Boolean) replaces rules containing vw instead of adding fallbacks.\r\n- `exclude` (Regexp or Array of Regexp) Ignore some files like 'node_modules'\r\n - If value is regexp, will ignore the matches files.\r\n - If value is array, the elements of the array are regexp.\r\n- `include` (Regexp or Array of Regexp) If `include` is set, only matching files will be converted,\r\n for example, only files under `src/mobile/` (`include: /\\/src\\/mobile\\//`)\r\n - If the value is regexp, the matching file will be included, otherwise it will be excluded.\r\n - If value is array, the elements of the array are regexp.\r\n- `landscape` (Boolean) Adds `@media (orientation: landscape)` with values converted via `landscapeWidth`.\r\n- `landscapeUnit` (String) Expected unit for `landscape` option\r\n- `landscapeWidth` (Number) Viewport width for landscape orientation.\r\n\r\n> `exclude` and `include` can be set together, and the intersection of the two rules will be taken.\r\n\r\n#### Ignoring\r\n\r\nYou can use special comments for ignore conversion of single lines:\r\n- `/* px-to-viewport-ignore-next */` — on a separate line, prevents conversion on the next line.\r\n- `/* px-to-viewport-ignore */` — after the property on the right, prevents conversion on the same line.\r\n\r\nExample:\r\n```css\r\n/* example input: */\r\n.class {\r\n /* px-to-viewport-ignore-next */\r\n width: 10px;\r\n padding: 10px;\r\n height: 10px; /* px-to-viewport-ignore */\r\n border: solid 2px #000; /* px-to-viewport-ignore */\r\n}\r\n\r\n/* example output: */\r\n.class {\r\n width: 10px;\r\n padding: 3.125vw;\r\n height: 10px;\r\n border: solid 2px #000;\r\n}\r\n```\r\n\r\nThere are several more reasons why your pixels may not convert, the following options may affect this:\r\n`propList`, `selectorBlackList`, `minPixelValue`, `mediaQuery`, `exclude`, `include`.\r\n\r\n#### Use with PostCss configuration file\r\n\r\nadd to your `postcss.config.js`\r\n```js\r\nmodule.exports = {\r\n plugins: {\r\n // ...\r\n 'postcss-px-to-viewport': {\r\n // options\r\n }\r\n }\r\n}\r\n```\r\n\r\n#### Use with gulp-postcss\r\n\r\nadd to your `gulpfile.js`:\r\n```js\r\nvar gulp = require('gulp');\r\nvar postcss = require('gulp-postcss');\r\nvar pxtoviewport = require('postcss-px-to-viewport');\r\n\r\ngulp.task('css', function () {\r\n\r\n var processors = [\r\n pxtoviewport({\r\n viewportWidth: 320,\r\n viewportUnit: 'vmin'\r\n })\r\n ];\r\n\r\n return gulp.src(['build/css/**/*.css'])\r\n .pipe(postcss(processors))\r\n .pipe(gulp.dest('build/css'));\r\n});\r\n```\r\n\r\n## Contributing\r\n\r\nPlease read [Code of Conduct](CODE-OF-CONDUCT.md)\r\nand [Contributing Guidelines](CONTRIBUTING.md) for submitting pull requests to us.\r\n\r\n## Running the tests\r\n\r\nIn order to run tests, you need to install dev-packages:\r\n```\r\n$ npm install\r\n```\r\nThen run the tests via npm script:\r\n```\r\n$ npm run test\r\n```\r\n\r\n## Changelog\r\n\r\nThe changelog is [here](CHANGELOG.md).\r\n\r\n## Versioning\r\n\r\nWe use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/evrone/postcss-px-to-viewport/tags). \r\n\r\n## Authors\r\n\r\n* [Dmitry Karpunin](https://github.com/KODerFunk) - *Initial work*\r\n* [Ivan Bunin](https://github.com/chernobelenkiy)\r\n\r\nSee also the list of [contributors](https://github.com/evrone/postcss-px-to-viewport/contributors) who participated in this project.\r\n\r\n## License\r\n\r\nThis project is licensed under the [MIT License](LICENSE).\r\n\r\n## Sponsors\r\n\r\nVisit [Evrone](https://evrone.com/) website to get more information about the [projects](https://evrone.com/cases) build.\r\n\r\n<a href=\"https://evrone.com/?utm_source=postcss-px-to-viewport\">\r\n <img src=\"https://user-images.githubusercontent.com/417688/34437029-dbfe4ee6-ecab-11e7-9d80-2b274b4149b3.png\"\r\n alt=\"Sponsored by Evrone\" width=\"231\" />\r\n</a>\r\n\r\n## Acknowledgments\r\n\r\n* Hat tip to https://github.com/cuth/postcss-pxtorem/ for inspiring us for this project.\r\n",
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments