React minimal pie chart

Lightweight React SVG pie charts, with versatile options and CSS animation included. < 2kB gzipped. 👏 Demo 👏.

Why?

Because Recharts is awesome, but when you just need a simple pie/donought chart, 3kB 2kB are usually enough.

	Size by Bundlefobia	Benchmark Size *	Loading time on a slow 3g *
react-minimal-pie-chart (v8.4.0)		1.93 KB	~39 ms
rechart (v1.8.5)		96.9 KB	~1900 ms
victory-pie (v34.1.3)		50.5 KB	~1100 ms
react-apexcharts (v1.3.7)		114.6 KB	~2300 ms
react-vis (v1.11.7)		78.3 KB	~1600 ms

* Benchmark carried out with size-limit with a "real-world" setup: see benchmark repo. (What matter here are not absolute values but the relation between magnitudes)

Features

• < 2kB gzipped
• Versatile: Pie, Donut, Loading, Completion charts (see Demo)
• Customizable chart labels and CSS animations
• Written in Typescript
• No dependencies

Installation

npm install react-minimal-pie-chart

If you don't use a package manager, react-minimal-pie-chart exposes also an UMD module ready for the browser.

https://unpkg.com/react-minimal-pie-chart/dist/index.js

Minimum supported Typescript version: >= 3.8

Usage

import { PieChart } from 'react-minimal-pie-chart';

<PieChart
  data={[
    { title: 'One', value: 10, color: '#E38627' },
    { title: 'Two', value: 15, color: '#C13C37' },
    { title: 'Three', value: 20, color: '#6A2135' },
  ]}
/>;

Options

Prop types are exposed for convenience:

import type { PieChartProps } from 'react-minimal-pie-chart';

About data prop

data prop expects an array of chart entries as follows:

type Data = {
  color: string;
  value: number;
  key?: string | number;
  title?: string | number;
  [key: string]: any;
}[];

Each entry accepts any custom property plus the following optional ones:

• key: custom value to be used as segments element keys

• title: title element rendered as segment's child

Custom labels with label render prop

label prop accepts a function returning the string, number or element rendered as label for each segment:

<PieChart
  label={(labelRenderProps: LabelRenderProps) =>
    number | string | React.ReactElement | undefined | null
  }
/>

The function receives labelRenderProps object as single argument:

type LabelRenderProps = {
  x: number;
  y: number;
  dx: number;
  dy: number;
  textAnchor: string;
  dataEntry: {
    ...props.data[dataIndex]
    // props.data entry relative to the label extended with:
    startAngle: number;
    degrees: number;
    percentage: number;
  };
  dataIndex: number;
  style: React.CSSProperties;
};

Label prop, common scenarios

Render entries' values as labels:

label={({ dataEntry }) => dataEntry.value}

Render segment's percentage as labels:

label={({ dataEntry }) => `${Math.round(dataEntry.percentage)} %`}

See examples in the demo source.

How to

User interactions with the chart

See demo and relative source here and here.

Custom tooltip

See demo and relative source.

Browsers support

Here is an updated browsers support list 🔍.

The main requirement of this library is an accurate rendering of SVG Stroke properties.

Please consider that Math.sign and Object.assign polyfills are required to support legacy browsers.

Misc

How svg arc paths work?

• http://xahlee.info/js/svg_circle_arc.html
• https://codepen.io/lingtalfi/pen/yaLWJG

How SVG animations work?

This library uses the stroke-dasharray + stroke-dashoffset animation strategy described here.

Todo's

• Consider moving storybook deployment to CI
• Consider using transform to mutate segments/labels positions
• Consider abstracting React bindings to re-use business logic with other frameworks
• Provide a way to supply svg element with any extra prop
• Find a better solution to assign default props

Contributors

Thanks to you all (emoji key):

Andrea Carraro 💻 📖 🚇 ⚠️ 👀	Stephane Rufer 🐛 💻	Jørgen Aaberg 💻	Tobiah Rex 🐛	Edward Xiao 🐛	David Konsumer 💻 📖 💡 🤔	Ori 🤔
Emmanouil Konstantinidis 🐛	yuruc 💻	luca-esse 🐛	Oscar Mendoza 🐛 💻	damien-git 🐛 🤔	Vianney Stroebel 🐛 🤔	Maxime Zielony 🐛 💻
Raz Kedem 🐛	Blocksmith 🐛	Jamie Talbot 🐛	Oscar Yixuan Chen 🐛	RuiRocha1991 🐛	Roman Kushyn 🐛	Divjot Singh 💻