Marcell Mars c832f9bfdb | ||
---|---|---|
.. | ||
dist | ||
node_modules/postcss | ||
CHANGELOG.md | ||
LICENSE | ||
README.md | ||
package.json |
README.md
postcss-functions
PostCSS plugin for exposing JavaScript functions.
Installation
npm install postcss-functions
Usage
var fs = require('fs');
var postcss = require('postcss');
var functions = require('postcss-functions');
var options = {
//options
};
var css = fs.readFileSync('input.css', 'utf8');
postcss()
.use(functions(options))
.process(css)
.then(function (result) {
var output = result.css;
});
Example of a function call:
body {
prop: foobar();
}
Options
functions
Type: Object
An object containing functions. The function name will correspond with the object key.
Example:
var color = require('css-color-converter');
require('postcss-functions')({
functions: {
darken: function (value, frac) {
var darken = 1 - parseFloat(frac);
var rgba = color(value).toRgbaArray();
var r = rgba[0] * darken;
var g = rgba[1] * darken;
var b = rgba[2] * darken;
return color([r,g,b]).toHexString();
}
}
});
.foo {
/* make 10% darker */
color: darken(blue, 0.1);
}
glob
Type: string|string[]
Loads files as functions based on one or more glob patterns. The function name will correspond with the file name.
Example:
require('postcss-functions')({
glob: path.join(__dirname, 'functions', '*.js')
});