Security News
Namecheap Takes Down Polyfill.io Service Following Supply Chain Attack
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
rework
Advanced tools
Readme
CSS manipulations built on css, allowing you to automate vendor prefixing, create your own properties, inline images, anything you can imagine! Also works in the browser as a component.
with node:
$ npm install rework
or in the browser with component:
$ component install visionmedia/rework
or in the browser with the stand-alone build ./rework.js referencing the rework
global.
Return a new Rework
instance for the given string of css
.
Define vendor prefixes
that plugins may utilize,
however most plugins do and should accept direct passing
of vendor prefixes as well.
Use the given plugin fn
. A rework "plugin" is simply
a function accepting the stylesheet object and Rework
instance,
view the definitions in ./lib/plugins
for examples.
Return the string representation of the manipulated css. Optionally
you may compress the output with .toString({ compress: true })
The following plugins are bundled with rework
:
extend: selector
supporturl()
s with a callback functionrgba(#fc0, .5)
height: @width
etcAdd support for extending existing rulesets:
button {
padding: 5px 10px;
border: 1px solid #eee;
border-bottom-color: #ddd;
}
.green {
background: green;
padding: 10px 15px
}
a.join {
extend: button;
extend: .green;
}
a.button
input[type='submit'],
input[type='button'] {
extend: button
}
yields:
button,
a.button,
input[type='submit'],
input[type='button'],
a.join {
padding: 5px 10px;
border: 1px solid #eee;
border-bottom-color: #ddd;
}
.green,
a.join {
background: green;
padding: 10px 15px
}
Optionally selectors may be prefixed with %
to create sass-style "placeholder"
selectors, which do not become part of the output. For example:
%dark-button {
background: black;
}
%dark-button:hover {
background: rgba(0,0,0,.5);
}
%dark-button:hover .icon {
color: rgba(255,255,255,.5);
}
button,
.actions a {
extend: %dark-button;
padding: 5px 10px;
}
yields:
button,
.actions a {
background: black
}
button:hover,
.actions a:hover {
background: rgba(0,0,0,.5)
}
button:hover .icon,
.actions a:hover .icon {
color: rgba(255,255,255,.5)
}
button,
.actions a {
padding: 5px 10px
}
Adds the following list of additional easing functions:
ease-in-out-back
-- cubic-bezier(0.680, -0.550, 0.265, 1.550)
ease-in-out-circ
-- cubic-bezier(0.785, 0.135, 0.150, 0.860)
ease-in-out-expo
-- cubic-bezier(1.000, 0.000, 0.000, 1.000)
ease-in-out-sine
-- cubic-bezier(0.445, 0.050, 0.550, 0.950)
ease-in-out-quint
-- cubic-bezier(0.860, 0.000, 0.070, 1.000)
ease-in-out-quart
-- cubic-bezier(0.770, 0.000, 0.175, 1.000)
ease-in-out-cubic
-- cubic-bezier(0.645, 0.045, 0.355, 1.000)
ease-in-out-quad
-- cubic-bezier(0.455, 0.030, 0.515, 0.955)
ease-out-back
-- cubic-bezier(0.175, 0.885, 0.320, 1.275)
ease-out-circ
-- cubic-bezier(0.075, 0.820, 0.165, 1.000)
ease-out-expo
-- cubic-bezier(0.190, 1.000, 0.220, 1.000)
ease-out-sine
-- cubic-bezier(0.390, 0.575, 0.565, 1.000)
ease-out-quint
-- cubic-bezier(0.230, 1.000, 0.320, 1.000)
ease-out-quart
-- cubic-bezier(0.165, 0.840, 0.440, 1.000)
ease-out-cubic
-- cubic-bezier(0.215, 0.610, 0.355, 1.000)
ease-out-quad
-- cubic-bezier(0.250, 0.460, 0.450, 0.940)
ease-in-back
-- cubic-bezier(0.600, -0.280, 0.735, 0.045)
ease-in-circ
-- cubic-bezier(0.600, 0.040, 0.980, 0.335)
ease-in-expo
-- cubic-bezier(0.950, 0.050, 0.795, 0.035)
ease-in-sine
-- cubic-bezier(0.470, 0.000, 0.745, 0.715)
ease-in-quint
-- cubic-bezier(0.755, 0.050, 0.855, 0.060)
ease-in-quart
-- cubic-bezier(0.895, 0.030, 0.685, 0.220)
ease-in-cubic
-- cubic-bezier(0.550, 0.055, 0.675, 0.190)
ease-in-quad
-- cubic-bezier(0.550, 0.085, 0.680, 0.530)
To view them online visit easings.net.
Add retina support for images, with optional vendor
prefixes,
defaulting to .vendors()
.
.logo {
background-image: url('component.png');
width: 289px;
height: 113px
}
yields:
.logo {
background-image: url('component.png');
width: 289px;
height: 113px
}
@media all and (-webkit-min-device-pixel-ratio: 1.5) {
.logo {
background-image: url("component@2x.png");
background-size: contain
}
}
Prefix property
or array of properties
with optional vendors
defaulting to .vendors()
.
.button {
border-radius: 5px;
}
yields:
.button {
-webkit-border-radius: 5px;
-moz-border-radius: 5px;
border-radius: 5px;
}
Prefix value
with optional vendors
defaulting to .vendors()
.
button {
transition: height, transform 2s, width 0.3s linear;
}
yields:
button {
-webkit-transition: height, -webkit-transform 2s, width 0.3s linear;
-moz-transition: height, -moz-transform 2s, width 0.3s linear;
transition: height, transform 2s, width 0.3s linear
}
This works with other values as well, such as gradients. For example:
.use(rework.prefixValue('linear-gradient'))
.use(rework.prefixValue('radial-gradient'))
button {
background: linear-gradient(#eee, #ddd);
}
button.round {
border-radius: 50%;
background-image: radial-gradient(#cde6f9, #81a8cb);
}
body {
background: -webkit-linear-gradient(#fff, #eee);
}
yields:
button {
background: -webkit-linear-gradient(#eee, #ddd);
background: -moz-linear-gradient(#eee, #ddd);
background: linear-gradient(#eee, #ddd)
}
button.round {
border-radius: 50%;
background-image: -webkit-radial-gradient(#cde6f9, #81a8cb);
background-image: -moz-radial-gradient(#cde6f9, #81a8cb);
background-image: radial-gradient(#cde6f9, #81a8cb)
}
body {
background: -webkit-linear-gradient(#fff, #eee)
}
Prefix selectors with the given string
.
h1 {
font-weight: bold;
}
a {
text-decoration: none;
color: #ddd;
}
yields:
#dialog h1 {
font-weight: bold;
}
#dialog a {
text-decoration: none;
color: #ddd;
}
Add user-defined mixins, functions that are invoked for a given property, and passed the value. Returning an object that represents one or more properties.
For example the following overflow
mixin allows the designer
to utilize overflow: ellipsis;
to automatically assign associated
properties preventing wrapping etc.
var css = rework(css)
.use(rework.mixin({ overflow: ellipsis }))
.toString()
function ellipsis(type) {
if ('ellipsis' == type) {
return {
'white-space': 'nowrap',
'overflow': 'hidden',
'text-overflow': 'ellipsis'
}
}
return type;
}
Mixins in use look just like regular CSS properties:
h1 {
overflow: ellipsis;
}
yields:
h1 {
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis
}
Add user-defined CSS functions.
For example create black(0.5)
shortcut, to replace
long rgba(0, 0, 0, 0.5)
.
var css = rework(css)
.use(rework.function({ black: black }))
.toString()
function black(opacity) {
return 'rgba(0, 0, 0, ' + opacity + ')';
}
User code will receive CSS arguments and replace user-defined function by returned code.
input {
box-shadow: 0 0 5px black(0.7);
}
yields:
input {
box-shadow: 0 0 5px rgba(0, 0, 0, 0.7);
}
You may also return array values to expand to several definitions of the property:
function display(type) {
if ('flex' == type) {
return {
display: [
'-webkit-flex',
'-moz-flex',
'-webkit-flexbox',
'flex'
]
}
}
return {
display: type
}
}
Would yield:
.myclass {
display: -webkit-flex;
display: -moz-flex;
display: -webkit-flexbox;
display: flex;
}
Add property reference support.
button {
width: 120px;
}
button.round {
width: 50px;
height: @width;
line-height: @height;
background-size: @width @height;
}
yields:
button {
width: 120px
}
button.round {
width: 50px;
height: 50px;
line-height: 50px;
background-size: 50px 50px
}
Add variable support. Note that this does not cascade like the CSS variable
spec does, thus this is not some sort of fallback mechanism, just a useful
feature. Optionally you may pass an object
of variables from js-land.
:root {
var-header-color: #06c;
var-main-color: #c06;
}
div {
var-accent-background: linear-gradient(to top, var(main-color), white);
}
h1 {
background-color: var(header-color);
}
.content {
background: var(accent-background) !important;
}
yields:
:root {
var-header-color: #06c;
var-main-color: #c06
}
div {
var-accent-background: linear-gradient(to top, #c06, white)
}
h1 {
background-color: #06c
}
.content {
background: linear-gradient(to top, #c06, white) !important
}
Add color manipulation helpers such as rgba(#fc0, .5)
.
button {
background: rgba(#ccc, .5);
}
yields:
button {
background: rgba(204, 204, 204, .5);
}
Prefix @keyframes with vendors
defaulting to .vendors()
.
Ordering with .keyframes()
is important, as other plugins
may traverse into the newly generated rules, for example the
following will allow .prefix()
to prefix keyframe border-radius
property, .prefix()
is also smart about which keyframes definition
it is within, and will not add extraneous vendor definitions.
var css = rework(read('examples/keyframes.css', 'utf8'))
.vendors(['-webkit-', '-moz-'])
.use(rework.keyframes())
.use(rework.prefix('border-radius'))
.toString()
@keyframes animation {
from {
opacity: 0;
}
to {
opacity: 1;
}
}
yields:
@keyframes animation {
from {
opacity: 0;
}
to {
opacity: 1;
}
}
@-webkit-keyframes animation {
from {
opacity: 0;
}
to {
opacity: 1;
}
}
Inline files from dir
directly to CSS. Replace inline(path)
to Data URI
with base64 encoding of file. It is useful for small images and fonts.
Of course, you can use inline only with node. It is not available in the browser with component.
var css = rework(read(css))
.use(rework.inline('images/', 'fonts/'))
.toString()
.logo {
background: inline(icons/logo.png);
}
yields:
.logo {
background: url("data:image/png;base64,iVBORw0…");
}
example.js:
var rework = require('rework')
, read = require('fs').readFileSync
, str = read('example.css', 'utf8');
var css = rework(str)
.vendors(['-webkit-', '-moz-'])
.use(rework.keyframes())
.use(rework.prefix('border-radius'))
.toString()
console.log(css);
example.css:
@keyframes animation {
from { opacity: 0; border-radius: 5px }
to { opacity: 1; border-radius: 5px }
}
stdout:
@keyframes animation {
from {
opacity: 0;
border-radius: 5px
}
to {
opacity: 1;
border-radius: 5px
}
}
@-webkit-keyframes animation {
from {
opacity: 0;
-webkit-border-radius: 5px;
border-radius: 5px
}
to {
opacity: 1;
-webkit-border-radius: 5px;
border-radius: 5px
}
}
@-moz-keyframes animation {
from {
opacity: 0;
-moz-border-radius: 5px;
border-radius: 5px
}
to {
opacity: 1;
-moz-border-radius: 5px;
border-radius: 5px
}
}
Suppose for example you wanted to create your own properties for positions, allowing you to write them as follows:
#logo {
absolute: top left;
}
#logo {
relative: top 5px left;
}
#logo {
fixed: top 5px left 10px;
}
yielding:
#logo {
position: absolute;
top: 0;
left: 0
}
#logo {
position: relative;
top: 5px;
left: 0
}
#logo {
position: fixed;
top: 5px;
left: 10px
}
This is how you could define the plugin:
var rework = require('rework')
, read = require('fs').readFileSync;
function positions() {
var positions = ['absolute', 'relative', 'fixed'];
return function(style){
style.rules.forEach(function(rule){
rule.declarations.forEach(function(decl, i){
if (!~positions.indexOf(decl.property)) return;
var args = decl.value.split(/\s+/);
var arg, n;
// remove original
rule.declarations.splice(i, 1);
// position prop
rule.declarations.push({
property: 'position',
value: decl.property
});
// position
while (args.length) {
arg = args.shift();
n = parseFloat(args[0]) ? args.shift() : 0;
rule.declarations.push({
property: arg,
value: n
});
}
});
});
}
}
var css = rework(read('positions.css', 'utf8'))
.use(positions())
.toString()
console.log(css);
MIT
FAQs
Plugin framework for CSS preprocessing
We found that rework demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 11 open source maintainers collaborating on the project.
Did you know?
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.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.
Security News
A JavaScript library maintainer is under fire after merging a controversial PR to support legacy versions of Node.js.