The 'juice' npm package is primarily used for inlining CSS into HTML. This is particularly useful for sending HTML emails where inline styles are often required for consistent rendering across different email clients.
Inline CSS into HTML
This feature allows you to take an HTML string with embedded CSS and inline the CSS styles directly into the HTML elements. This is useful for ensuring that styles are applied correctly in environments that do not support embedded or external stylesheets, such as many email clients.
const juice = require('juice');
const html = '<html><head><style>h1 { color: red; }</style></head><body><h1>Hello, world!</h1></body></html>';
const inlinedHtml = juice(html);
console.log(inlinedHtml);Inline CSS from external stylesheets
This feature allows you to inline CSS from external stylesheets referenced in the HTML. The 'url' option is used to resolve the paths of the external stylesheets.
const juice = require('juice');
const html = '<html><head><link rel="stylesheet" href="styles.css"></head><body><h1>Hello, world!</h1></body></html>';
const inlinedHtml = juice(html, { url: 'http://example.com' });
console.log(inlinedHtml);Custom CSS inlining options
Juice provides various options to customize the inlining process. For example, you can choose whether to apply style tags, remove style tags after inlining, and more.
const juice = require('juice');
const html = '<html><head><style>h1 { color: red; }</style></head><body><h1>Hello, world!</h1></body></html>';
const options = { applyStyleTags: true, removeStyleTags: false };
const inlinedHtml = juice(html, options);
console.log(inlinedHtml);The 'inline-css' package is another tool for inlining CSS into HTML. It offers similar functionality to 'juice' but with a simpler API. It is useful for basic inlining tasks but may lack some of the advanced options available in 'juice'.
The 'premailer' package is a more comprehensive tool that not only inlines CSS but also rewrites URLs, adds missing HTML attributes, and more. It is a good alternative to 'juice' for more complex email preparation tasks.
The 'email-comb' package is designed to clean and optimize HTML emails by inlining CSS and removing unused styles. It is similar to 'juice' but focuses more on optimization and cleaning up the HTML.
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>
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 to true.removeStyleTags - whether to remove the original <style></style> tags after (possibly) inlining the css from them. Defaults to true.preserveMediaQueries - preserves all media queries (and contained styles) within <style></style> tags as a refinement when removeStyleTags is true. Other styles are removed. Defaults to false.applyWidthAttributes - whether to use any CSS pixel widths to create width attributes on elements set in juice.widthElements. Defaults to false.webResources - An options object that will be passed through to web-resource-inliner for juice functions that will get remote resources (juiceResources and juiceFile). Defaults to {}.Returns string containing inlined HTML. Does not fetch remote resources.
html - html string, accepts complete documents as well as fragmentsoptions - optional, see Options aboveCallback returns string containing inlined HTML. Fetches remote resources.
html - html stringoptions - see Options abovecallback(err, html)
err - Error object or nullhtml - inlined HTMLCallback returns string containing inlined HTML. Fetches remote resources.
filePath - path to the html file to be juicedoptions - see Options abovecallback(err, html)
err - Error object or nullhtml - inlined HTMLReturns 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 aboveGiven 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 aboveArray of ignored pseudo-selectors such as 'hover' and 'active'.
Array of HTML elements that can receive width attributes.
(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.
1.0.0 / 2015-02-12
juiceContent to juiceResourceswidth attribute with applyWidthAttributespreserveMediaQueriesapplyLinkTags and removeLinkTagsFAQs
Inlines css into html source
The npm package juice receives a total of 751,847 weekly downloads. As such, juice popularity was classified as popular.
We found that juice demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.
Security News
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.