├── .babelrc ├── .github └── FUNDING.yml ├── .gitignore ├── LICENSE ├── README.md ├── build └── index.js ├── package-lock.json ├── package.json ├── src └── index.js └── webpack.config.js /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": ["env"], 3 | "plugins": [ 4 | "transform-object-rest-spread", 5 | "transform-react-jsx" 6 | ] 7 | } -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | custom: ['https://www.buymeacoffee.com/ashishd751'] 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | 63 | *.iml 64 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2019 Ashish Deshpande 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # react-excel-renderer ![](https://img.shields.io/npm/l/react-excel-renderer.svg?style=flat) ![](https://img.shields.io/npm/v/react-excel-renderer.svg?style=flat) ![](https://img.shields.io/npm/dt/react-excel-renderer.svg?style=flat) 2 | A react library to render and display excel sheets on webpage 3 | 4 | --- 5 | 6 | ## Demo 7 | * A sample demo can be found - [here](https://ashishd751.github.io/excel-renderer-demo/) 8 | * You can find code for the demo - [here](https://github.com/ashishd751/excel-renderer-demo) 9 | 10 | ![](https://github.com/ashishd751/excel-renderer-demo/blob/master/public/DemoSample.gif) 11 | 12 | ## Installation 13 | 14 | ``` 15 | npm install react-excel-renderer --save 16 | ``` 17 | 18 | ## Usage 19 | * Import the primary module *ExcelRenderer* to convert sheet data into JSON format. 20 | * Also import *OutTable* to display the obtained JSON into a HTML Table. 21 | ``` 22 | import {OutTable, ExcelRenderer} from 'react-excel-renderer'; 23 | ``` 24 | * Place a simple `input` element in the render function of your class and pass an `onChange` handler 25 | ``` 26 | 27 | ``` 28 | * In the `onChange` handler, invoke the `ExcelRenderer` function and provide file object from the event handler to the `ExcelRenderer` function to obtain JSON data from sheet 29 | ``` 30 | fileHandler = (event) => { 31 | let fileObj = event.target.files[0]; 32 | 33 | //just pass the fileObj as parameter 34 | ExcelRenderer(fileObj, (err, resp) => { 35 | if(err){ 36 | console.log(err); 37 | } 38 | else{ 39 | this.setState({ 40 | cols: resp.cols, 41 | rows: resp.rows 42 | }); 43 | } 44 | }); 45 | 46 | } 47 | ``` 48 | * Use the OutTable component to render obtained JSON data into HTML table, and provide classnames as props to make table look alike an Excel Sheet 49 | ``` 50 | 51 | ``` 52 | * To make this table look more like an excel sheet, follow this article - [Quick CSS Tools to make your web page tables to look just like excel](https://www.cogniview.com/articles-resources/quick-css-tools-for-making-your-web-tables-look-just-like-excel) 53 | 54 | 55 | **Note:** Once the JSON data is obatined, you can also use other options to render them instead of the OutTable component. For example, [CanvasDataGrid](https://github.com/TonyGermaneri/canvas-datagrid) provides various features to render tabular data. 56 | 57 | 58 | ## Built With 59 | * [SheetJS](https://github.com/SheetJS/js-xlsx) - The web page sheet framework used 60 | 61 | 62 | ## Authors 63 | **Ashish Deshpande** - *Initial work* - [Ashish's Github Profile](https://github.com/ashishd751) 64 | 65 | ## License 66 | This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/ashishd751/react-excel-renderer/blob/master/LICENSE) file for details 67 | 68 | ## Acknowledgments 69 | * Special shout out to the guys at **Sheet JS** for developing the parent library 70 | * High gratitude towards Bernard Bado to help me publish my first npm package 71 | 72 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "react-excel-renderer", 3 | "version": "1.1.3", 4 | "description": "A react library to render and display excel sheets on webpage", 5 | "main": "build/index.js", 6 | "mode": "production", 7 | "scripts": { 8 | "test": "echo \"Error: no test specified\" && exit 1", 9 | "start": "webpack --watch", 10 | "build": "webpack" 11 | }, 12 | "repository": { 13 | "type": "git", 14 | "url": "git+https://github.com/ashishd751/react-excel-renderer.git" 15 | }, 16 | "keywords": [ 17 | "react", 18 | "react-dom", 19 | "excel", 20 | "sheetjs", 21 | "workbook", 22 | "table" 23 | ], 24 | "author": "Ashish Deshpande", 25 | "license": "MIT", 26 | "bugs": { 27 | "url": "https://github.com/ashishd751/react-excel-renderer/issues" 28 | }, 29 | "homepage": "https://github.com/ashishd751/react-excel-renderer#readme", 30 | "peerDependencies": { 31 | "react": "^16.7.0" 32 | }, 33 | "dependencies": { 34 | "xlsx": "^0.14.1" 35 | }, 36 | "devDependencies": { 37 | "babel-cli": "^6.26.0", 38 | "babel-core": "^6.26.3", 39 | "babel-loader": "^7.1.4", 40 | "babel-plugin-transform-object-rest-spread": "^6.26.0", 41 | "babel-plugin-transform-react-jsx": "^6.24.1", 42 | "babel-preset-env": "^1.7.0", 43 | "react": "^16.13.1", 44 | "webpack": "^4.12.0", 45 | "webpack-cli": "^3.0.4" 46 | } 47 | } 48 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | import React, { Component } from 'react'; 2 | import XLSX from 'xlsx'; 3 | 4 | export class OutTable extends Component { 5 | 6 | constructor(props) { 7 | super(props); 8 | this.state = { 9 | 10 | } 11 | } 12 | 13 | render() { 14 | return ( 15 |
16 | 17 | 18 | 19 | {this.props.withZeroColumn && !this.props.withoutRowNum && } 20 | { 21 | this.props.columns.map((c) => 22 | 23 | ) 24 | 25 | } 26 | 27 | {this.props.data.map((r,i) => 28 | {!this.props.withoutRowNum && } 29 | {this.props.columns.map(c => )} 30 | )} 31 | 32 |
{c.key === -1 ? "" : c.name}
{this.props.renderRowNum?this.props.renderRowNum(r,i):i}{ r[c.key] }
33 |
34 | ); 35 | } 36 | } 37 | 38 | export function ExcelRenderer(file, callback) { 39 | return new Promise(function(resolve, reject) { 40 | var reader = new FileReader(); 41 | var rABS = !!reader.readAsBinaryString; 42 | reader.onload = function(e) { 43 | /* Parse data */ 44 | var bstr = e.target.result; 45 | var wb = XLSX.read(bstr, { type: rABS ? "binary" : "array" }); 46 | 47 | /* Get first worksheet */ 48 | var wsname = wb.SheetNames[0]; 49 | var ws = wb.Sheets[wsname]; 50 | 51 | /* Convert array of arrays */ 52 | var json = XLSX.utils.sheet_to_json(ws, { header: 1 }); 53 | var cols = make_cols(ws["!ref"]); 54 | 55 | var data = { rows: json, cols: cols }; 56 | 57 | resolve(data); 58 | return callback(null, data); 59 | }; 60 | if (file && rABS) reader.readAsBinaryString(file); 61 | else reader.readAsArrayBuffer(file); 62 | }); 63 | } 64 | 65 | function make_cols(refstr) { 66 | var o = [], 67 | C = XLSX.utils.decode_range(refstr).e.c + 1; 68 | for (var i = 0; i < C; ++i) { 69 | o[i] = { name: XLSX.utils.encode_col(i), key: i }; 70 | } 71 | return o; 72 | } 73 | -------------------------------------------------------------------------------- /webpack.config.js: -------------------------------------------------------------------------------- 1 | var path = require('path'); 2 | module.exports = { 3 | entry: './src/index.js', 4 | output: { 5 | path: path.resolve(__dirname, 'build'), 6 | filename: 'index.js', 7 | libraryTarget: 'commonjs2' 8 | }, 9 | module: { 10 | rules: [ 11 | { 12 | test: /\.js$/, 13 | include: path.resolve(__dirname, 'src'), 14 | exclude: /(node_modules|bower_components|build)/, 15 | use: { 16 | loader: 'babel-loader', 17 | options: { 18 | presets: ['env'] 19 | } 20 | } 21 | } 22 | ] 23 | }, 24 | externals: { 25 | 'react': 'commonjs react' 26 | } 27 | }; --------------------------------------------------------------------------------