gulp-px3rem
v0.3.0
Published
A gulp plugin for px2rem
Downloads
12
Readme
gulp-px3rem
This is a gulp plugin for px2rem
CLI tool provided in px2rem
Usage
The raw stylesheet only contains @2x style, and if you
- don't intend to transform the original value, eg: 1px border, add
/*no*/
after the declaration - intend to use px by force,eg: font-size, add
/*px*/
after the declaration
Attention: Dealing with SASS or LESS, only /*...*/
comment can be used, in order to have the comments persisted
Gulpfile.js:
var gulp = require('gulp');
var px2rem = require('gulp-px3rem');
gulp.task('px2rem', function() {
gulp.src('./*.css')
.pipe(px2rem())
.pipe(gulp.dest('./dest'))
});
Options
px2rem({
baseDpr: 2, // base device pixel ratio (default: 2)
threeVersion: false, // whether to generate @1x, @2x and @3x version (default: false)
remVersion: true, // whether to generate rem version (default: true)
remUnit: 75, // rem unit value (default: 75)
remPrecision: 6 // rem precision (default: 6)
})
Example
Pre processing:
One raw stylesheet: test.css
.selector {
width: 150px;
height: 64px; /*px*/
font-size: 28px; /*px*/
border: 1px solid #ddd; /*no*/
}
After processing:
Rem version: test.debug.css
.selector {
width: 2rem;
border: 1px solid #ddd;
}
[data-dpr="1"] .selector {
height: 32px;
font-size: 14px;
}
[data-dpr="2"] .selector {
height: 64px;
font-size: 28px;
}
[data-dpr="3"] .selector {
height: 96px;
font-size: 42px;
}
@1x version: test1x.debug.css
.selector {
width: 75px;
height: 32px;
font-size: 14px;
border: 1px solid #ddd;
}
@2x version: test2x.debug.css
.selector {
width: 150px;
height: 64px;
font-size: 28px;
border: 1px solid #ddd;
}
@3x version: test3x.debug.css
.selector {
width: 225px;
height: 96px;
font-size: 42px;
border: 1px solid #ddd;
}
Change Log
0.3.0
- Deps: px2rem@~0.5.0
- Support Animation keyframes (no
/*px*/
comment).
- Support Animation keyframes (no
0.2.2
- Deps: px2rem@~0.4.0
- The generated [data-dpr] rules follow the origin rule, no longer placed at the end of the whole style sheet.
- Optimize 0px, do not generate 3 [data-dpr] rules.
0.2.1
- Remove deps to vinyl, use gulp-util.
- Enhance test case.
0.2.0
- Deps: px2rem@~0.3.0
- Change default remUnit to 75.
- Delete comment config.
- Don't generate @1x, @2x and @3x version stylesheet by default.
0.1.9
- Deps: px2rem@^0.2.0
- Support media query.
0.1.8
- Deps: px2rem@~0.1.8
- Fix regular expression bug and common comments bug which affects rem transformation.
License
MIT