Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonkemp/inline-css
Inline css into an html file.
https://github.com/jonkemp/inline-css
inline-css
Last synced: 1 day ago
JSON representation
Inline css into an html file.
- Host: GitHub
- URL: https://github.com/jonkemp/inline-css
- Owner: jonkemp
- License: mit
- Created: 2015-01-21T14:48:54.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2025-01-03T15:05:14.000Z (15 days ago)
- Last Synced: 2025-01-11T05:05:38.115Z (7 days ago)
- Topics: inline-css
- Language: JavaScript
- Size: 1.89 MB
- Stars: 432
- Watchers: 10
- Forks: 84
- Open Issues: 59
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-emails - Inline-css (node.js)
README
# inline-css [](https://badge.fury.io/js/inline-css)  [](https://coveralls.io/github/jonkemp/inline-css?branch=master)
[](https://nodei.co/npm/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.
## Features
- Uses [cheerio](https://github.com/cheeriojs/cheerio) instead of jsdom
- Works on Windows
- Preserves Doctype
- Modular
- Gets your CSS automatically through style and link tags
- Functions return [A+ compliant](https://promisesaplus.com/) Promises
## How It Works
This module takes html and inlines the CSS properties into the style attribute.
`/path/to/file.html`:
```html
p { color: red; }
Test
```
`style.css`
```css
p {
text-decoration: underline;
}
```
Output:
```html
Test
```
## 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
```
## Usage
```js
var inlineCss = require('inline-css');
var html = "div{color:red;}
";
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 ``.
#### options.applyLinkTags
Type: `Boolean`
Default: `true`
Whether to resolve `` tags and inline the resulting styles.
#### options.removeStyleTags
Type: `Boolean`
Default: `true`
Whether to remove the original `` tags after (possibly) inlining the css from them.
#### options.removeLinkTags
Type: `Boolean`
Default: `true`
Whether to remove the original `` 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 `` 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.
#### options.removeHtmlSelectors
Type: `Boolean`
Default: `false`
Whether to remove the `class` and `id` attributes from the markup.
#### options.codeBlocks
Type: `Object`
Default: `{ EJS: { start: '<%', end: '%>' }, HBS: { start: '{{', end: '}}' } }`
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 = {...}`.
### Special markup
#### 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.
### cheerio options
Options to passed to [cheerio](https://github.com/cheeriojs/cheerio).
## Contributing
See the [CONTRIBUTING Guidelines](https://github.com/jonkemp/inline-css/blob/master/CONTRIBUTING.md)
## License
MIT © [Jonathan Kemp](http://jonkemp.com)