Package Exports

get-css-data

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (get-css-data) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

get-css-data

A micro-library for collecting stylesheet data from link and style nodes.

Features
Installation
Example
Options
Contact
License

Features

Collect CSS data for all <link> and <style> nodes or only those specified
Handles absolute and relative @import rules
Inspect, modify and/or filter CSS data from each node
Access CSS data as concatenated string or an array of per-node data in DOM order
Modify XHR object before each request
UMD and ES6 modules available
Compatible with modern and legacy browsers (IE9+)
Lightweight (less than 1.5k min+gzip) and dependency-free

Installation

NPM:

npm install get-css-data

// file.js
import getCssData from 'get-css-data';
getCssData({
  // ...
});

Git:

git clone https://github.com/jhildenbiddle/get-css-data.git

CDN (unpkg.com shown, also on jsdelivr.net):

<!-- ES5 in file.html (latest v1.x.x) -->
<script src="https://unpkg.com/get-css-data@1"></script>
<script>
  getCssData({
    // ...
  });
</script>

<!-- ES6 module in file.html (latest v1.x.x) -->
<script type="module">
  import getCssData from 'https://unpkg.com/get-css-data@1/dist/get-css-data.esm.min.js';
  getCssData({
    // ...
  });
</script>

Example

HTML:

<!-- file.html -->
<head>
  <link rel="stylesheet" href="style1.css">
  <style>
    @import "style2.css";
    p { color: blue; }
  </style>
</head>

CSS:

/* style1.css */
p { color: red; }

/* style2.css */
p { color: green; }

JavaScript (see Options for details)

getCss({
  onComplete(cssText, cssArray, nodeArray) {
    console.log(cssText); // 1
    console.log(cssArray); // 2
    console.log(nodeArray); // 3
  }
});

// 1 => 'p { color: red; } p { color: green; } p { color: blue; }'
// 2 => ['p { color: red; }', 'p { color: green; } p { color: blue; }']
// 3 => [<linkElement>, <styleElement>]

Example

// Default values shown
getCssData({
  include: 'link[rel=stylesheet],style',
  exclude: '',
  filter : '',
  onSuccess(cssText, node, url) {
    // ...
  },
  onError(xhr, node, url) {
    // ...
  },
  onComplete(cssText, cssArray, nodeArray) {
    // ...
  }
});

options.include

Type: string
Default: "link[rel=stylesheet],style"

CSS selector matching <link rel="stylesheet"> and <style> nodes to collect data from. The default value includes all style and link nodes.

Example

getCssData({
  // Include only <link rel="stylesheet"> nodes
  // with an href that does not contains "bootstrap"
  include: 'link[rel=stylesheet]:not([href*=bootstrap])',
  ...
});

options.exclude

Type: string

CSS selector matching <link rel="stylesheet"> and <style> nodes to exclude from those matched by options.include.

Example

getCssData({
  // Of matched `include` nodes, exclude any node
  // with an href that contains "bootstrap"
  exclude: '[href*=bootstrap]',
  ...
});

options.filter

Type: object

Regular expression used to filter node CSS data. Each block of CSS data is tested against the filter, and only matching data is processed.

Example

getCssData({
  // Test each block of CSS for the existence
  // of ".myclass". If found, process the CSS.
  // If not, ignore the CSS.
  filter: /\.myclass/,
  ...
});

options.onBeforeSend

Type: function
Arguments:
1. xhr: The XHR object containing details of the failed request
2. node: The source node object reference
3. url: The source URL string (<link> href or @import url)

Callback before each XMLHttpRequest (XHR) is sent. Allows modifying the XML object by setting properties, calling methods, or adding event handlers.

Example

getCss({
  onBeforeSend(xhr, node, url) {
    // Domain-specific XHR settings
    if (/some-domain.com/.test(url)) {
      xhr.withCredentials = true;
      xhr.setRequestHeader("foo", "1");
      xhr.setRequestHeader("bar", "2");
    }
  }
});

options.onSuccess

Type: function
Arguments:
1. cssText: A string of CSS text from node and url
2. node: The source node object reference
3. url: The source URL string (<link> href or page url for <style> data)

Callback after CSS data has been collected from each node. Allows modifying the CSS data before it is added to the final output by returning any string value (or false to skip).

Note that the order in which CSS data is "successfully" collected (thereby triggering this callback) is not guaranteed when <link> nodes or @import rules are being processed as this data is collected asynchronously. To access CSS data in DOM order, use the cssArray argument passed to the options.oncomplete callback.

Example

getCss({
  onSuccess(cssText, node, url) {
    // Skip any data not from this domain
    if (url.indexOf(location.hostname) === -1) {
      return false;
    }
    // Otherwise modify the CSS data
    else {
      const newCssText = cssText.replace(/color:\s*red\s;/g, 'color: blue;');
      return newCssText
    }
  }
});

options.onError

Type: function
Arguments:
1. xhr: The XHR object containing details of the failed request
2. node: The source node object reference
3. url: The source URL string (<link> href or @import url)

Callback after <link> or @import request has failed.

Example

getCss({
  onError(xhr, node, url) {
    console.log(xhr.status); // 1
    console.log(xhr.statusText); // 2
  }
});

// 1 => '404'
// 2 => 'Not Found'

options.onComplete

Type: function
Arguments:
1. cssText: A string of concatenated CSS text from all nodes in DOM order.
2. cssArray: An array of per-node CSS text in DOM order. The node containing each CSS text block is available at the same nodeArray index.
3. nodeArray: An array of processed <style> and <link> nodes in DOM order. The CSS text for each node is available at the same cssArray index.

Callback after CSS data has been collected from all nodes.

Example

getCss({
  onComplete(cssText, cssArray, nodeArray) {
    // ...
  }
});

Contact

Create a Github issue for bug reports, feature requests, or questions
Follow @jhildenbiddle for announcements
Add a star on GitHub or tweet to support the project!

License

This project is licensed under the MIT License. See the LICENSE for details.