Juice
Given HTML, juice will inline your CSS properties into the style
attribute.
How to use
var juice = require('juice2');
juice("/path/to/file.html", function(err, html) {
console.log(html);
});
/path/to/file.html
:
<html>
<head>
<style>
p { color: red; }
</style>
<link rel="stylesheet" href="style.css">
</head>
<body>
<p>Test</p>
</body>
</html>
style.css
p {
text-decoration: underline;
}
Output:
<html>
<head>
</head>
<body>
<p style="color: red; text-decoration: underline;">Test</p>
</body>
</html>
What is this useful for ?
- HTML emails. For a comprehensive list of supported selectors see
here
- Embedding HTML in 3rd-party websites.
Projects using juice
Documentation
juice(filePath, [options], callback)
filePath
- html fileoptions
- (optional) object containing these properties:
extraCss
- extra css to apply to the file. Defaults to ""
.applyStyleTags
- whether to inline styles in <style></style>
Defaults to true
.applyLinkTags
- whether to resolve <link rel="stylesheet">
tags
and inline the resulting styles. Defaults to true
.removeStyleTags
- whether to remove the original <style></style>
tags after (possibly) inlining the css from them. Defaults to true
.removeLinkTags
- whether to remove the original <link rel="stylesheet">
tags after (possibly) inlining the css from them. Defaults to true
.url
- how to resolve hrefs. Defaults to using filePath
. If you want
to override, be sure your url
has the protocol at the beginning, e.g.
http://
or file://
.
callback(err, html)
err
- Error
object or null
.html
- contains the html from filePath
, with potentially <style>
and
<link rel="stylesheet">
tags removed, and css inlined.
juice.juiceContent(html, options, callback)
html
- raw html contentoptions
- same options as calling juice
, except now url
is required.callback(err, html)
- same as calling juice
juice.juiceDocument(document, options, callback)
Operates on a jsdom instance. Be sure to use the same jsdom version that juice
uses. Also be sure to clean up after you are done. You may have to
call document.parentWindow.close()
to free up memory.
document
- a jsdom instanceoptions
- see juice.juiceContent
callback(err)
juice.inlineContent(html, css)
This takes html and css and returns new html with the provided css inlined.
It does not look at <style>
or <link rel="stylesheet">
elements at all.
juice.inlineDocument(document, css)
Given a jsdom instance and css, this modifies the jsdom instance so that the
provided css is inlined. It does not look at <style>
or
<link rel="stylesheet">
elements at all.
juice.ignoredPseudos
Array of ignored pseudo-selectors such as 'hover' and 'active'.
Credits
(The MIT License)
Copyright (c) 2011 Guillermo Rauch <guillermo@learnboost.com>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
3rd-party
- Uses the excellent JSDom for the underlying DOM
representation.
- Uses cssom to parse out CSS selectors and
Slick to tokenize them.
- Icon by UnheardSounds