Inlines css into html source
npm install @ctxhou/juice
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:
``js`
var juice = require('juice');
var result = juice("");
result will be:
`html`
Try out the web client version
- HTML emails. For a comprehensive list of supported selectors see here
- Embedding HTML in 3rd-party websites.
* [node-email-templates][1] - Node.js module for rendering beautiful emails with [ejs][2] templates and email-friendly inline CSS using [juice][3].
* [swig-email-templates][4] - Uses [swig][5], which gives you [template inheritance][6], and can generate a [dummy context][7] from a template.
* [nodejs-api-starter][8] - A project template for building web APIs with Node.js and GraphQL (see [src/emails][9]).emails
* [notifme-template][10] - A Node.js library to easily handle all your notification ( | SMS | pushes | webpushes) templates. (can be used in combination with [notifme-sdk][11]).
* [mosaico][13] - The first opensource email template editor. Helps you build responsive and appealing email templates in few clicks.
* [mjml][12] - A markup language designed for painless responsive email coding. The markup gets transpiled to HTML that works in any email client.
[1]: https://github.com/niftylettuce/node-email-templates
[2]: https://github.com/tj/ejs
[3]: https://github.com/Automattic/juice
[4]: https://github.com/andrewrk/swig-email-templates
[5]: https://github.com/paularmstrong/swig
[6]: https://docs.djangoproject.com/en/dev/topics/templates/#template-inheritance
[7]: https://github.com/andrewrk/swig-dummy-context
[8]: https://github.com/kriasoft/nodejs-api-starter
[9]: https://github.com/kriasoft/nodejs-api-starter/tree/master/src/emails
[10]: https://github.com/notifme/notifme-template
[11]: https://github.com/notifme/notifme-sdk
[12]: https://github.com/mjmlio/mjml
[13]: https://github.com/voidlabs/mosaico
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:
* applyAttributesTableElements - whether to create attributes for styles in juice.styleToAttribute on elements set in juice.tableElements. Defaults to true.
* applyHeightAttributes - whether to use any CSS pixel heights to create height attributes on elements set in juice.heightElements. Defaults to true.
* applyStyleTags - whether to inline styles in Defaults to true.
* applyWidthAttributes - whether to use any CSS pixel widths to create width attributes on elements set in juice.widthElements. Defaults to true.
* extraCss - extra css to apply to the file. Defaults to "".
* insertPreservedExtraCss - whether to insert into the document any preserved @media or @font-face content from extraCss when using preserveMediaQueries, preserveFontFaces or preserveKeyFrames. When true order of preference to append the tags as a refinement when removeStyleTags is true. Other styles are removed. Defaults to true.
* preserveImportant - preserves !important in values. Defaults to false.
* preserveMediaQueries - preserves all media queries (and contained styles) within tags as a refinement when removeStyleTags is true. Other styles are removed. Defaults to true.
* preserveKeyFrames - preserves all key frames within tags as a refinement when removeStyleTags is true. Other styles are removed. Defaults to true.
* removeStyleTags - whether to remove the original tags after (possibly) inlining the css from them. Defaults to true.
* webResources - An options object that will be passed to web-resource-inliner for juice functions that will get remote resources (juiceResources and juiceFile). Defaults to {}.
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 to false.
#### juice(html [, options])
Returns string containing inlined HTML. Does not fetch remote resources.
* html - html string, accepts complete documents as well as fragmentsoptions
* - optional, see Options above
#### juice.juiceResources(html, options, callback)
Callback returns string containing inlined HTML. Fetches remote resources.
* html - html stringoptions
* - see Options abovecallback(err, html)
*
- - Error object or null
- - inlined HTML
#### juice.juiceFile(filePath, options, callback)
Callback returns string containing inlined HTML. Fetches remote resources.
* filePath - path to the html file to be juicedoptions
* - see Options abovecallback(err, html)
*
- - Error object or null
- - inlined HTML
#### juice.juiceDocument($ [, options])
This takes a cheerio instance and performs inlining in-place. Returns the
same cheerio instance. Does not fetch remote resources.
* $ - a cheerio instance, be sure to use the same cheerio version that juice usesoptions
* - optional, see Options above
#### juice.inlineContent(html, css [, options])
This takes html and css and returns new html with the provided css inlined.
It does not look at tag by the web-resource-inliner juice will not inline the styles and will not remove the 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
For a listing of all available options, just type juice -h.
> Note that if you want to just type juice from the command line, you should npm install juice -g so it is globally available.
CLI Options:
The CLI should have all the above options with the names changed from camel case to hyphen-delimited, so for example extraCss becomes extra-css and webResources.scripts becomes web-resources-scripts.
These are additional options not included in the standard juice options listed above:
- --css [filepath] will load and inject CSS into extraCss.
- --options-file [filepath] will load and inject options from a JSON file. Options from the CLI will be given priority over options in the file when there is a conflict.
Attempting to Browserify require('juice') fails because portions of Juice and its dependencies interact with the file system using the standard require('fs'). However, you can require('juice/client') via Browserify which has support for juiceDocument, inlineDocument, and inlineContent, but not juiceFile, juiceResources, or inlineExternal. Note that automated tests are not running in the browser yet.
(The MIT License)
Copyright (c) 2015 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.
- Uses cheerio for the underlying DOM
representation.
- Uses mensch to parse out CSS and
Slick to tokenize them.
- Icon by UnheardSounds