1.0.4 • Published 5 months ago
@brighthr/component-donut v1.0.4
Donut
To install, type the following into the command line at the root of your project:
npm i @brighthr/component-donut
To implement the Donut component into your project you’ll need to add the import:
import Donut from '@brighthr/component-donut';
After adding import into your project you can use it simply like:
<Donut />
Props
Name | Type | Default | Description |
---|---|---|---|
animateClockWise | boolean | false | If true, the donut animation will play clockwise. |
children | React.ReactNode | Sets the information to display inside the donut. | |
className | string | Sets the className | |
percents | {percent: number, percentageUsed: number, donutCurrentTotal: number, color: string,} | Object of 4 keys, percent is a number for how filled the donut should animate. ` |