Skip to content

xavivzla/Funnel-React

Repository files navigation

Funnel-react logo

NPM JavaScript Style Guide

Funnel-react logo

Install

npm install --save funnel-react

or

yarn add funnel-react

Usage

import { Funnel } from 'funnel-react';

##Simple example

<Funnel
  height={252}
  colors={{
    graph: [ '#1890FF', '#BAE7FF' ],
    percent: 'red',
    label: 'yellow',
    value: 'orange'
  }}
  valueKey='quantity'
  width={800}
  data={data} />

##Render prop example

const data = [
  {
      "label": "Aceptados",
      "quantity": 135
  },
  ...{}
]

  <Funnel
  labelKey='label'
  height={252}
  colors={{
    graph: [ '#1890FF', '#BAE7FF' ], // array or string : 'red' || '#666'
    percent: 'red',
    label: 'yellow',
    value: 'orange'
  }}
  valueKey='quantity' 
  width={800}
  displayPercent={true}
  data={data} />
props Type Default Value Options
labelKey string
colors object
valueKey string
width number container width
displayPercent boolean false false / true
data array

License

MIT © xavivzla

About

a small library to build a funnel

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published