# [gulp](https://github.com/wearefractal/gulp)-inline-css [![Build Status](https://travis-ci.org/jonkemp/gulp-inline-css.svg?branch=master)](https://travis-ci.org/jonkemp/gulp-inline-css) [![Coverage Status](https://coveralls.io/repos/jonkemp/gulp-inline-css/badge.svg?branch=master&service=github)](https://coveralls.io/github/jonkemp/gulp-inline-css?branch=master) [![NPM](https://nodei.co/npm/gulp-inline-css.png?downloads=true)](https://nodei.co/npm/gulp-inline-css/) > Inline your CSS properties into the `style` attribute in an html file. Useful for emails. Inspired by the grunt plugin [grunt-inline-css](https://github.com/jgallen23/grunt-inline-css). Uses the [inline-css](https://github.com/jonkemp/inline-css) module. ## What's new in 3.0? - Uses Promises with [inline-css](https://github.com/jonkemp/inline-css) version 2.0 ## How It Works This gulp plugin takes an html file and inlines the CSS properties into the style attribute. `/path/to/file.html`: ```html
Test
``` `style.css` ```css p { text-decoration: underline; } ``` Output: ```htmlTest
``` ## 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/gulp-inline-css) ``` npm install --save-dev gulp-inline-css ``` ## Usage ```js var gulp = require('gulp'), inlineCss = require('gulp-inline-css'); gulp.task('default', function() { return gulp.src('./*.html') .pipe(inlineCss()) .pipe(gulp.dest('build/')); }); ``` With options: ```js var gulp = require('gulp'), inlineCss = require('gulp-inline-css'); gulp.task('default', function() { return gulp.src('./*.html') .pipe(inlineCss({ applyStyleTags: true, applyLinkTags: true, removeStyleTags: true, removeLinkTags: true })) .pipe(gulp.dest('build/')); }); ``` Options are passed directly to [inline-css](https://github.com/jonkemp/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 ``. #### 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. #### 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. ### cheerio options Options to passed to [cheerio](https://github.com/cheeriojs/cheerio). ## License MIT © [Jonathan Kemp](http://jonkemp.com)