inline-css
Inline your CSS properties into the
style
attribute in an html file. Useful for emails.
Inspired by the juice library.
Why inline-css instead of Juice?
- 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
How It Works
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>
What is this useful for ?
- 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
Install with npm
npm install --save inline-css
Usage
var inlineCss = require('inline-css');
var html = "<style>div{color:red;}</style><div/>";
inlineCss(html, options)
.then(function(html) { console.log(html); });
API
inlineCss(html, options)
options.extraCss
Type: String
Default: ""
Extra css to apply to the file.
options.applyStyleTags
Type: Boolean
Default: true
Whether to inline styles in <style></style>
.
options.applyLinkTags
Type: Boolean
Default: true
Whether to resolve <link rel="stylesheet">
tags and inline the resulting styles.
options.removeStyleTags
Type: Boolean
Default: true
Whether to remove the original <style></style>
tags after (possibly) inlining the css from them.
options.removeLinkTags
Type: Boolean
Default: true
Whether to remove the original <link rel="stylesheet">
tags after (possibly) inlining the css from them.
options.url
Type: String
Default: filePath
How to resolve hrefs. Required.
options.preserveMediaQueries
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.
options.applyWidthAttributes
Type: Boolean
Default: false
Whether to use any CSS pixel widths to create width
attributes on elements.
options.applyTableAttributes
Type: Boolean
Default: false
Whether to apply the border
, cellpadding
and cellspacing
attributes to table
elements.
License
MIT © Jonathan Kemp