react-sparklines-ts
v1.8.6
Published
Beautiful and expressive Sparklines component for React (continued)
Downloads
159
Maintainers
Readme
Beautiful and expressive sparklines component for React
[!NOTE] I really wanted to use
react-sparklines
, but using something that was last released 7 years ago didn't feel so good (and I didn't want separate typescript types!), so I rewrote it based on the original.
Live demos and docs: aeolun.github.io/react-sparklines-ts/
Install
# pnpm
pnpm add react-sparklines-ts
# yarn
yarn add react-sparklines-ts
# npm
npm install react-sparklines-ts --save
Run demo
pnpm install
pnpm start
http://localhost:3000
Use
Import the Sparklines components that you need; for example to generate a simple chart:
import React from 'react';
import { Sparklines } from 'react-sparklines-ts';
...
<Sparklines data={[5, 10, 5, 20, 8, 15]} limit={5} width={100} height={20} margin={5}>
</Sparklines>
Sparklines component is a container with the following properties:
data
- the data set used to build the sparkline
limit
- optional, how many data points to display at once
width
, height
- dimensions of the generated sparkline in the SVG viewbox. This will be automatically scaled (i.e. responsive) inside the parent container by default.
svgWidth
, svgHeight
- If you want absolute dimensions instead of a responsive component set these attributes.
preserveAspectRatio - default: 'none', set this to modify how the sparkline should scale
margin
- optional, offset the chart
min
, max
- optional, bound the chart
Basic Sparkline
import React from 'react';
import { Sparklines, SparklinesLine } from 'react-sparklines-ts';
...
<Sparklines data={[5, 10, 5, 20]}>
<SparklinesLine color="blue" />
</Sparklines>
Bars
import React from 'react';
import { Sparklines, SparklinesBars } from 'react-sparklines-ts';
...
<Sparklines data={[5, 10, 5, 20]}>
<SparklinesBars />
</Sparklines>
Spots
import React from 'react';
import { Sparklines, SparklinesLine, SparklinesSpots } from 'react-sparklines-ts';
...
<Sparklines data={sampleData}>
<SparklinesLine style={{ fill: "none" }} />
<SparklinesSpots />
</Sparklines>
Reference Line
import React from 'react';
import { Sparklines, SparklinesLine, SparklinesReferenceLine } from 'react-sparklines-ts';
...
<Sparklines data={sampleData}>
<SparklinesLine />
<SparklinesReferenceLine type="mean" />
</Sparklines>
Normal Band
import React from 'react';
import { Sparklines, SparklinesLine, SparklinesNormalBand } from 'react-sparklines-ts';
...
<Sparklines data={sampleData}>
<SparklinesLine style={{ fill: "none" }}/>
<SparklinesNormalBand />
</Sparklines>