https://github.com/lukehorvat/computed-style-to-inline-style
Convert a HTML element's computed CSS to inline CSS.
https://github.com/lukehorvat/computed-style-to-inline-style
computed-css css element html-element inline-css style svg-element
Last synced: over 1 year ago
JSON representation
Convert a HTML element's computed CSS to inline CSS.
- Host: GitHub
- URL: https://github.com/lukehorvat/computed-style-to-inline-style
- Owner: lukehorvat
- License: mit
- Created: 2015-06-03T13:44:33.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-03-03T18:43:03.000Z (over 2 years ago)
- Last Synced: 2024-04-14T18:44:17.396Z (about 2 years ago)
- Topics: computed-css, css, element, html-element, inline-css, style, svg-element
- Language: TypeScript
- Homepage:
- Size: 83 KB
- Stars: 102
- Watchers: 8
- Forks: 12
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# computed-style-to-inline-style [](https://www.npmjs.org/package/computed-style-to-inline-style)
Convert a HTML element's computed CSS to inline CSS.
Uses [Window.getComputedStyle](https://developer.mozilla.org/en-US/docs/Web/API/Window/getComputedStyle) internally.
## Installation
Install the package via npm:
```sh
npm install computed-style-to-inline-style
```
Or download it from the unpkg CDN:
```html
```
## Usage
Example:
```js
import computedStyleToInlineStyle from 'computed-style-to-inline-style';
computedStyleToInlineStyle(document.body, {
recursive: true,
properties: ['font-size', 'text-decoration'],
});
```
## API
### computedStyleToInlineStyle(element, [options])
A function that iterates through the computed style properties of `element` and redefines them as inline styles.
#### element
An HTML element.
#### options
An (optional) object with any of the following keys defined:
- `recursive` – A boolean indicating whether to recursively process child elements or not. Defaults to `false`.
- `properties` – An array of property names to operate on; all others are filtered out. Defaults to `undefined` (i.e. _every_ computed style property is redefined as an inline style).
## Why?
Consider a scenario where you're rendering an SVG element in a HTML document, with its pretty styling defined in external stylesheets:
```html
...
```
You then add a link to let users download the SVG as a file:
```html
Download
```
To your dismay, you find that none of the SVG's pretty styling is preserved when downloaded to disk! This is because the file lacks the original context in which the SVG element was rendered in the browser and has no reference to those nice external stylesheets you wrote.
As a solution, you use this package to redefine the SVG styling inline, guaranteeing that the element is saved to file with all of its fancy CSS information embedded within:
```js
computedStyleToInlineStyle(svgElement, { recursive: true });
```