svg-crowbar

SVG Crowbar Library

A standalone 3.5Kb JS client library based on Chrome bookmarklet.

The library provides functionality to trigger a download of a given SVG file having all the styles inlined, to make it look the same when opened independently from the original HTML page.

It is also possible to use this library to convert an SVG to a PNG before downloading.

Usage

import downloadSvg from 'svg-crowbar';

downloadSvg(document.querySelector('svg'));

or

import { downloadPng } from 'svg-crowbar';

downloadPng(document.querySelector('svg'), 'my_svg', { css: 'internal' });

The downloadSVG/downloadPNG functions each have three arguments:

downloadSVG(svgElement, [filename], [options])
downloadPNG(svgElement, [filename], [options])

• svgElement (required)

  A DOM element selector for an SVG, e.g. document.querySelector('svg'). An error is thrown if no valid SVG element was provided.

• filename (optional)

  A string to set the filename. This is determined by element id, class or page title, when not provided explicitly.

• options (optional)

  An object literal. It presently has just a single configurable property:

• options.css (optional)

  This setting determines how the SVG will be styled:

  • 'inline'

    Default value. Inlines all computed styles on every element in the SVG. This setting best ensures that the exported SVG is accurate cross-browser.

  • 'internal'

    Adds an internal block of styles containing only explicitly declared style rules (from document.styleSheets). This can drastically reduce file-sizes and build time in exported SVGs, but could be less accurate if the styles are not consistent cross-browser, as it does not include styles from the browser's user agent stylesheet.

  • 'none'

    Doesn't add any CSS. This gives the smallest file-size, but you might need to manually add your own styles to exported SVGs to ensure an accurate output. You can do this by injecting a <style> block into the selected SVG before exporting.

  Example:

  const svg = document.querySelector('svg');
  
  // Add inline styles on SVG elements:
  downloadSvg(svg, 'my_svg'); 
  downloadSvg(svg, 'my_svg', { css: 'inline' });
  
  // Add a <style> block in the SVG:
  downloadSvg(svg, 'my_svg', { css: 'internal' });
  
  // Do not add CSS:
  downloadSvg(svg, 'my_svg', { css: 'none' });
  

Changelog

v0.4.0 (23/03/2020)

• #118 Remove references to global window object to fix SSR builds

<details> <summary>Updated dependencies</summary>

• #123 Update dependency eslint-config-prettier to v6.10.1
• #121 Update babel monorepo to v7.9.0
• #117 Update dependency electron to v8.1.1

</details>

---