1.1.0 • Published 3 years ago

artree-react-csv-creator v1.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

react-csv-creator

A react component for downloading data into a csv file.

npm

Development utilizes storybook and based on react-storybook-boilerplate.

running

$ npm i
$ npm start

packaging

$ npm run build
$ npm publish

props

NameTypeDefaultRequiredDescription
disabledboolfalsefalseDisable the downloading of the csv
headersarray objectnullfalseHeader's names
filenamestringcurrent timefalseThe filename without extension. Defaults to current date/time
noHeaderboolfalsefalseIf true, will omit the header from the file
rowsarray objectnulltrueThe main data for the csv
textstringnullfalseThe text to use if no children component

Usage

import CsvCreator from 'react-csv-creator';

const headers = [{
  id: 'first',
  display: 'First column'
}, {
  id: 'second',
  display: 'Second column'
}];

const rows = [{
  first: 'foo',
  second: 'bar'
}, {
  first: 'foobar',
  second: 'foobar'
}];

<CsvCreator
  filename='my_cool_csv'
  headers={headers}
  rows={rows}
>
  <p>Download CSV</p>
</CsvCreator>