React mini charts

A collection of tiny chart components for React projects. Written with TypeScript and CSS modules.

You can see an interactive preview of all components in the public Storybook instance. Use the "Controls" and "JSX" tabs in Storybook to customize the charts and get the code to paste into your project.

Installation

npm:

npm install --save react-mini-charts

yarn:

yarn add react-mini-charts

Usage

BarChart

import { BarChart } from 'react-mini-charts'

<BarChart
	items={[
		{
			barWidth: '10%',
			barColor: '#adfc92',
			labels: {
				left: { text: 'Something good' },
				right: { text: '10%' },
			},
		},
		{
			barWidth: '50%',
			barColor: '#4a0d67',
			labels: {
				left: { text: 'Something mediocre' },
				right: { text: '50%' },
			},
		},
		{
			barWidth: '40%',
			barColor: '#db3069',
			labels: {
				left: { text: 'Something bad' },
				right: { text: '40%' },
			},
		},
	]}
/>

PieChart (SVG)

import { PieChart } from 'react-mini-charts'

<PieChart
	size={240}
	items={[
		{ percentage: 0.37, color: '#4a0d67' },
		{ percentage: 0.21, color: '#db3069' },
		{ percentage: 0.13, color: '#adfc92' },
	]}
/>

Customization

• General styles like font-family are inherited from the surrounding CSS context.
• Specific chart styles can be overridden with className props.
• By default, charts have transition styles that allow for smooth transitions between values. The timing and behavior can be overridden with custom CSS classes.

Development

Requirements

• Node 18.x with npm 9.x (other versions might work as well)
• Editor (e.g. VS Code) with TypeScript, ESLint and Prettier integration

Setup

1. Install dependencies with npm install
2. Start editing and preview your changes in Storybook with npm run storybook

Building & publishing

1. Build the project to generate the output in /dist via npm run build
2. Bump the version in package.json
3. Re-run npm install to update the version in package-lock.json
4. Update the CHANGELOG.md
5. Publish to npm via npm publish (you might need to log in first)

Other commands

# Format all files according to Prettier config:
npm run format

# Run all tests:
npm test

Contributions & feedback

This is a spare-time project by one person, but feedback is very welcome! Feel free to leave comments and suggestions as issues on GitHub!

Improvement ideas

• [ ] Make charts more responsive
• [ ] Add legend component
• [ ] Add more chart types (e.g. line chart, horizontal bar chart)
• [ ] Document requirements (e.g. minimum React version)
• [ ] Document difference between HTML-based and SVG-based charts
• [ ] Calculate the percentages based on absolute values (instead of percentages to be pre-calculated on the outside)