Given HTML, juice will inline your CSS properties into the style attribute.
Juice has a number of functions based on whether you want to process a file, HTML string, or a cheerio document, and whether you want juice to automatically get remote stylesheets, scripts and image dataURIs to inline.
To inline HTML without getting remote resources, using default options:
var juice = require('juice');
var result = juice("<style>div{color:red;}</style><div/>");result will be:
<div style="color: red;"></div>- HTML emails. For a comprehensive list of supported selectors see here
- Embedding HTML in 3rd-party websites.
- node-email-templates - Node.js module for rendering beautiful emails with ejs templates and email-friendly inline CSS using juice.
- swig-email-templates - Uses swig, which gives you template inheritance, and can generate a dummy context from a template.
Juice is exposed as a standard module, and from CLI with a smaller set of options.
All juice methods take an options object that can contain any of these properties, though not every method uses all of these:
extraCss- extra css to apply to the file. Defaults to"".applyStyleTags- whether to inline styles in<style></style>Defaults totrue.removeStyleTags- whether to remove the original<style></style>tags after (possibly) inlining the css from them. Defaults totrue.preserveMediaQueries- preserves all media queries (and contained styles) within<style></style>tags as a refinement whenremoveStyleTagsistrue. Other styles are removed. Defaults tofalse.preserveFontFaces- preserves all@font-facewithin<style></style>tags as a refinement whenremoveStyleTagsistrue. Other styles are removed. Defaults tofalse.applyWidthAttributes- whether to use any CSS pixel widths to createwidthattributes on elements set injuice.widthElements. Defaults tofalse.applyAttributesTableElements- whether to create attributes for styles injuice.styleToAttributeon elements set injuice.tableElements. Defaults tofalse.webResources- An options object that will be passed to web-resource-inliner for juice functions that will get remote resources (juiceResourcesandjuiceFile). Defaults to{}.inlinePseudoElements- Whether to insert pseudo elements (::beforeand::after) as<span>into the DOM. Note: Inserting pseudo elements will modify the DOM and may conflict with CSS selectors elsewhere on the page (e.g.,:last-child).xmlMode- whether to output XML/XHTML with all tags closed. Note that the input must also be valid XML/XHTML or you will get undesirable results. Defaults tofalse.preserveImportant- preserves!importantin values. Defaults tofalse.
Returns string containing inlined HTML. Does not fetch remote resources.
html- html string, accepts complete documents as well as fragmentsoptions- optional, see Options above
Callback returns string containing inlined HTML. Fetches remote resources.
html- html stringoptions- see Options abovecallback(err, html)err-Errorobject ornullhtml- inlined HTML
Callback returns string containing inlined HTML. Fetches remote resources.
filePath- path to the html file to be juicedoptions- see Options abovecallback(err, html)err-Errorobject ornullhtml- inlined HTML
Returns string containing inlined HTML. Does not fetch remote resources.
$- a cheerio instance, be sure to use the same cheerio version that juice usesoptions- optional, see Options above`
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.
html- html stringcss- css stringoptions- optional, see Options above
Given a cheerio instance and css, this modifies the cheerio instance so that the provided css is inlined. It does not look at <style> or <link rel="stylesheet"> elements at all.
$- a cheerio instance, be sure to use the same cheerio version that juice usescss- css stringoptions- optional, see Options above
Array of ignored pseudo-selectors such as 'hover' and 'active'.
Array of HTML elements that can receive width attributes.
Object of style property names (key) to their respective attribute names (value).
Array of table HTML elements that can receive attributes defined in juice.styleToAttribute.
Array of elements that will not have styles inlined because they are not intended to render.
When a data-embed attribute is present on a stylesheet <link> that has been inlined into the document as a <style></style> tag by the web-resource-inliner juice will not inline the styles and will not remove the <style></style> tags.
This can be used to embed email client support hacks that rely on css selectors into your email templates.
To use Juice from CLI, run juice [options] input.html output.html
Current CLI options:
--css [filepath]will load and inject CSS intoextraCss.
(The MIT License)
Copyright (c) 2015 Guillermo Rauch <[email protected]>
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.
- Uses cheerio for the underlying DOM representation.
- Uses cssom to parse out CSS selectors and Slick to tokenize them.
- Icon by UnheardSounds