Skip to content
This repository has been archived by the owner on Jan 28, 2020. It is now read-only.

jonkemp/style-data

Repository files navigation

Moved

This module has moved and is now available at https://github.com/jonkemp/inline-css/tree/master/packages/style-data. This repository is no longer maintained.

style-data Build Status Coverage Status

NPM

Get the content of style tags.

Install

Install with npm

npm install --save style-data

Usage

var getStylesData = require('style-data');

getStylesData(html, options, function (err, results) {
    console.log(results.html);  // resulting html
    console.log(results.css);   // array of css rules
});

API

getStylesData(html, options, callback)

options.applyStyleTags

Type: Boolean
Default: true

Whether to inline styles in <style></style>.

options.removeStyleTags

Type: Boolean
Default: true

Whether to remove the original <style></style> 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.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. For example, Handlebars (hbs) templates are HBS: {start: '{{', end: '}}'}. 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 <style></style> tag, style-data will not inline the styles and will not remove the <style></style> 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.

Credit

The code for this module was originally taken from the Juice library.

License

MIT © Jonathan Kemp