postcss-discard-font-face
v3.0.0
Published
Discard font faces by type, with PostCSS.
Downloads
8,194
Readme
postcss-discard-font-face
Discard font faces by type, with PostCSS.
Install
With npm do:
npm install postcss-discard-font-face --save
Example
When discarding TTF fonts:
Input
@font-face {
src: url("webfont.ttf") format("truetype"),
url("webfont.svg#svgFontName") format("svg");
}
Output
@font-face {
src: url("webfont.svg#svgFontName") format("svg");
}
API
discardFonts([filter|options])
filter
Type: function|array
Return: boolean|string
Arguments: The function is passed the URL of the font as the first argument,
and the format as the second.
For each font, return false to remove, or a new string if you would like to transform the URL.
// Remove fonts of an unknown type
discardFonts(function (url, format) {
if (~url.indexOf('.exe')) {
return false;
}
});
Alternately, you can whitelist an array of types:
discardFonts(['ttf', 'svg']);
With this setting, all extensions that do not match will be removed.
options
font
Type: object
Each key in this object should correspond to a font name, which will then be
discarded if its properties do not correspond to the whitelisted properties.
For example, to only allow a font weight of 400
& a font style of normal
,
it would be configured like so:
discardFonts({
font: {
'Open Sans': {
weight: [400],
style: ['normal']
}
}
});
Usage
See the PostCSS documentation for examples for your environment.
Contributing
Pull requests are welcome. If you add functionality, then please add unit tests to cover it.
License
MIT © Ben Briggs