Package Exports

react-svg-to-image

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 (react-svg-to-image) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

react-svg-to-image

react-svg-to-image was forked from JuanIrache/d3-svg-to-png. Converts SVG elements in the browser to PNG and other image formats, while keeping CSS styles. Optionally, it returns the data as a promise or downloads it. It can also rescale the svg image, ignore certain DOM elements...

Installation

$ npm i react-svg-to-image

Usage

const toImg = require('react-svg-to-image');
toImg('selector', 'name');

or

import toImg from 'react-svg-to-image';

Mandatory fields

Selector (String): Commonly 'svg'.
Name (String): Name for the file output, without extension.

Output: name.png

Options

const toImg = require('react-svg-to-image');

or 

import toImg from 'react-svg-to-image';

toImg('svg', 'name', {
  scale: 3,
  format: 'webp',
  quality: 0.01,
  download: false,
  ignore: '.ignored'
}).then(fileData => {
  //do something with the data
});

scale (number): Rescale the image by this factor. Default: 1
format (string): The format to output to. Compatibility might vary between browsers. See HTMLCanvasElement.toDataURL() . Default: png
quality (number): Between 0 (lowest) and 1. Affects formats with compression, like jpg. Default: .92
download (boolean): Wether to download the resulting image. Default: true
ignore (string): A CSS selector, the matched elements of which will not be added to the output. Default: null

Contribution

Please make your changes to the dev branch, so that automated tests can be run before merging to master. Also, if possible, provide tests for new functionality.