Inline your CSS properties into the
styleattribute in an html file. Useful for emails.
Inspired by the juice library.
- Uses cheerio instead of jsdom
- Works on Windows
- Preserves Doctype
- Modular
- Gets your CSS automatically through style and link tags
- Functions return A+ compliant Promises
This module takes html and inlines the CSS properties into the style attribute.
/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>- HTML emails. For a comprehensive list of supported selectors see here
- Embedding HTML in 3rd-party websites.
- Performance. Downloading external stylesheets delays the rendering of the page in the browser. Inlining CSS speeds up this process because the browser doesn't have to wait to download an external stylesheet to start rendering the page.
Install with npm
npm install --save inline-css
var inlineCss = require('inline-css');
var html = "<style>div{color:red;}</style><div/>";
inlineCss(html, options)
.then(function(html) { console.log(html); });Type: String
Default: ""
Extra css to apply to the file.
Type: Boolean
Default: true
Whether to inline styles in <style></style>.
Type: Boolean
Default: true
Whether to resolve <link rel="stylesheet"> tags and inline the resulting styles.
Type: Boolean
Default: true
Whether to remove the original <style></style> tags after (possibly) inlining the css from them.
Type: Boolean
Default: true
Whether to remove the original <link rel="stylesheet"> tags after (possibly) inlining the css from them.
Type: String
Default: filePath
How to resolve hrefs. Must be a string of one character or more. Required.
Relative urls in links will have this value prepended to them. So these links:
<a href="page-relative">Page</a><a href="/root-relative">Root</a><- note leading /
With this option:
inlineCss(html, { url: 'http://example.com/mushroom'})
.then(function(html) { console.log(html); });Will result in
<a href="http://example.com/mushroom/page-relative">Page</a><a href="http://example.com/root-relative">Root</a>
If you don't need this feature, simply set the property to a short string eg {url: ' '} (one space) and everything will work.
Type: Boolean
Default: false
Preserves all media queries (and contained styles) within <style></style> tags as a refinement when removeStyleTags is true. Other styles are removed.
Type: Boolean
Default: false
Whether to use any CSS pixel widths to create width attributes on elements.
Type: Boolean
Default: false
Whether to apply the border, cellpadding and cellspacing attributes to table elements.
Type: Boolean
Default: false
Whether to remove the class and id attributes from the markup.
Options to passed to cheerio.
See the CONTRIBUTING Guidelines
MIT © Jonathan Kemp