Hi, I want to share a library that I am building. If you find a mistake I would like to be told to improve the library and as a developer.
Install
npm install --save funnel-react
or
yarn add funnel-react
Test Library
Usage
import { Funnel } from 'funnel-react';
Simple example
<Funnel
height={252}
colors={[ '#1890FF', '#BAE7FF' ]}
valueKey='quantity'
width={800}
data={data} />
Render prop example
const data = [
{
"label": "Aceptados",
"quantity": 135
},
...{}
]
<Funnel
labelKey='label'
height={252}
colors={[ '#1890FF', '#BAE7FF' ]} // array or string : 'red' || '#666'
valueKey='quantity'
width={800}
displayPercent={true}
data={data} />
| props | Type | Default Value | Options |
|---|---|---|---|
| labelKey | string | ||
| colors | array or string | ['#FF4589', '#FF5050'] | |
| valueKey | string | ||
| width | number | container width | |
| displayPercent | boolean | false | false / true |
| data | array |
License
MIT © xavivzla
Top comments (5)
Could you share what the library about?
Normally README's are enough but can't figure out what it is for... 🤔
add the readme, where it is explained a little better :)
Thank you for the updated post, Xavier~
What I meant was that the README doesn't seem to explain what the library is for. I see a funnel but unsure of the purpose...
thanks. I will improve the documentation. and I tell you when I finish it to see if you can understand. : D
Thanks... :)