2.0.2 • Published 4 years ago

@byu-law/react-csv-reader v2.0.2

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

react-csv-reader

license npm version npm

React component that handles csv file input.
It handles file input and returns its content as a matrix.

You can try it out in a demo on Codesandbox.

Installation

Install the package with either yarn or npm.

With yarn:

yarn add react-csv-reader

With npm:

npm install --save react-csv-reader

Usage

Basic usage:

import React, { Component } from 'react'
import ReactDOM from 'react-dom'
import CSVReader from 'react-csv-reader'

class App extends Component {
  ...

  render() {
    return (
      <CSVReader onFileLoaded={(data, fileName) => console.log(data, fileName)} />
    )
  }
}

ReactDOM.render(<App />, document.getElementById('root'))

More complex example:

import React, { Component } from 'react'
import ReactDOM from 'react-dom'
import CSVReader from 'react-csv-reader'

class App extends Component {
  ...

  const papaparseOptions = {
    header: true,
    dynamicTyping: true,
    skipEmptyLines: true,
    transformHeader: header =>
      header
        .toLowerCase()
        .replace(/\W/g, '_')
  }

  render() {
    return (
      <CSVReader
        cssClass="csv-reader-input"
        label="Select CSV with secret Death Star statistics"
        onFileLoaded={this.handleForce}
        onError={this.handleDarkSideForce}
        parserOptions={papaparseOptions}
        inputId="ObiWan"
        inputStyle={{color: 'red'}}
      />
    )
  }
}

ReactDOM.render(<App />, document.getElementById('root'))

Parameters

NameTypeDefaultDescription
cssClassstringcsv-reader-inputA CSS class to be applied to the wrapper element.
cssInputClassstringcsv-inputA CSS class to be applied to the <input> element.
labelstring, elementIf present, it will be rendered in a <label> to describe input aim.
onFileLoadedfunction(required) The function to be called passing loaded results.
onErrorfunctionError handling function.
parserOptionsobject{}PapaParse configuration object override
inputIdstringAn id to be applied to the <input> element.
inputStyleobject{}Some style to be applied to the <input> element.
fileEncodingstringUTF-8Encoding type of the input file

Results

When the file has been loaded, it will be parsed with PapaParse from a CSV formatted text to a matrix of strings or a list of objects (using header option). That matrix is returned to the parent component with onFileLoaded function (it will be passed as an argument). The second argument to onFileLoaded will be the filename provided