Inline css into an html file.
npm install inline-css
> Inline your CSS properties into the style attribute in an html file. Useful for emails.
Inspired by the juice library.
This module takes html and inlines the CSS properties into the style attribute.
Test/path/to/file.html:
``html`
style.csscss`
p {
text-decoration: underline;
}
Output: Test
`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
`js
var inlineCss = require('inline-css');
var html = "";
inlineCss(html, options)
.then(function(html) { console.log(html); });
`
#### options.extraCss
Type: String ""
Default:
Extra css to apply to the file.
#### options.applyStyleTags
Type: Boolean true
Default:
Whether to inline styles in .
#### options.applyLinkTags
Type: Boolean true
Default:
Whether to resolve tags and inline the resulting styles.
#### options.removeStyleTags
Type: Boolean true
Default:
Whether to remove the original tags after (possibly) inlining the css from them.
#### options.removeLinkTags
Type: Boolean true
Default:
Whether to remove the original tags after (possibly) inlining the css from them.
#### options.url
Type: String filePath
Default:
How to resolve hrefs. Required.
#### options.preserveMediaQueries
Type: Boolean false
Default:
Preserves all media queries (and contained styles) within tags as a refinement when removeStyleTags is true. Other styles are removed.
#### options.applyWidthAttributes
Type: Boolean false
Default:
Whether to use any CSS pixel widths to create width attributes on elements.
#### options.applyTableAttributes
Type: Boolean false
Default:
Whether to apply the border, cellpadding and cellspacing attributes to table elements.
#### options.removeHtmlSelectors
Type: Boolean false
Default:
Whether to remove the class and id attributes from the markup.
#### options.codeBlocks
Type: Object { EJS: { start: '<%', end: '%>' }, HBS: { start: '{{', end: '}}' } }
Default:
An object where each value has a start and end to specify fenced code blocks that should be ignored during parsing and inlining. For example, Handlebars (hbs) templates are HBS: {start: '{{', end: '}}'}. codeBlocks can fix problems where otherwise inline-css might interpret code like <= as HTML, when it is meant to be template language code. Note that codeBlocks is a dictionary which can contain many different code blocks, so don't do codeBlocks: {...} do codeBlocks.myBlock = {...}`.
#### data-embed
When a data-embed attribute is present on a tag, inline-css 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.
Options to passed to cheerio.
See the CONTRIBUTING Guidelines
MIT © Jonathan Kemp