recharts-to-png

This package converts a Recharts chart to a png.

Usage no npm install needed!

<script type="module">
  import rechartsToPng from 'https://cdn.skypack.dev/recharts-to-png';
</script>

README

npm Build Status GitHub

recharts-to-png

Uses html2canvas to convert a Recharts chart to PNG.

Inspired by these Stack Overflow questions and answers from peter.bartos and AlbertMunichMar. Special thanks to HarmNullix for helping to improve the performance of this library.

Install

npm install recharts-to-png

Demo

See the demo here. It implements useCurrentPng with different chart types and file-saver.

Source:

Edit recharts-to-png

Usage

Compatible with React ^16.8.0:

useCurrentPng

useCurrentPng is a React hook that returns a tuple. The first parameter is a promise that will return a string if the PNG is valid. The second parameter is an object with two properties: ref, which is required to be attached to the target Recharts component, and isLoading, which is optional and changes state from false to true while the PNG is being generated and downloaded.

function MyApp(props) {
  // useCurrentPng usage (isLoading is optional)
  const [getPng, { ref, isLoading }] = useCurrentPng();

  // Can also pass in options for html2canvas
  // const [getPng, { ref }] = useCurrentPng({ backgroundColor: '#000' });

  const handleDownload = useCallback(async () => {
    const png = await getPng();

    // Verify that png is not undefined
    if (png) {
      // Download with FileSaver
      FileSaver.saveAs(png, 'myChart.png');
    }
  }, [getPng]);

  return (
    <>
      <ComposedChart data={props.data} ref={ref}>
        <XAxis dataKey="name" />
        <YAxis />
        <Tooltip />
        <Legend />
        <CartesianGrid stroke="#f5f5f5" />
        <Area type="monotone" dataKey="amt" fill="#8884d8" stroke="#8884d8" />
        <Bar dataKey="pv" barSize={20} fill="#413ea0" />
        <Line type="monotone" dataKey="uv" stroke="#ff7300" />
        <Brush dataKey="name" height={30} stroke="#8884d8" />
      </ComposedChart>
      <br/>
      <button onClick={handleDownload}>
        {isLoading ? 'Downloading...' : 'Download Chart'}
      </button>
    </>
  );

Contributing/Developing

  1. Fork/clone the repository

  2. Install dependencies

    npm i
    
  3. Build recharts-to-png in watch mode

    npm run watch
    
  4. Start the demo to observe your changes

    npm run demo
    
  5. Ensure all tests pass

    npm run test