inline-css
Version:
Inline css into an html file.
121 lines (77 loc) • 2.34 kB
Markdown
# inline-css
> Inline your CSS properties into the `style` attribute in an html file. Useful for emails.
Inspired by the [juice](https://github.com/Automattic/juice) library.
## How It Works
This gulp plugin takes an html file and inlines the CSS properties into the style attribute.
`/path/to/file.html`:
```html
<html>
<head>
<style>
p { color: red; }
</style>
<link rel="stylesheet" href="style.css">
</head>
<body>
<p>Test</p>
</body>
</html>
```
`style.css`
```css
p {
text-decoration: underline;
}
```
Output:
```html
<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](http://www.campaignmonitor.com/css/)
- 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](https://npmjs.org/package/inline-css)
```
npm install --save inline-css
```
## API
### inlineCss(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.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.
## License
MIT © [Jonathan Kemp](http://jonkemp.com)