js2excel

js2excel

A simple module exports json data to excel, which works in the browser.

Installation

It is recommended to run webpack on node 6.x or higher.

Install the pkg with npm:

npm install js2excel --save

or yarn

yarn add js2excel

or bower

bower install js2excel

Usage

// es6
import js2excel from 'js2excel';

//CommonJS
let js2excel = require('js2excel');

/**
 * excel's data
 **/

// excel's header columes
let columns = [
    {
        // the name will be as the excel colume name
        name: 'User Id', 
        // the prop will be as the excel row data, which is the rows' item's property.
        prop: 'userId'     
    },
    {
        name: 'Phone Number',
        prop: 'userPhoneNumber'
    },
    {
        name: 'User Address',
        prop: 'userAddress'
    }
];

// excel rows' data
// rows' data will be exports, which you probably get it from server.
let rows = [
    {
        "userId": 1,
        "userPhoneNumber": 1888888888,
        "userAddress": 'xxxx'
    },
    {
        "userId": 2,
        "userPhoneNumber": 1888888888,
        "userAddress": 'xxxx'
    },
    {
        "userId": 3,
        "userPhoneNumber": 1888888888,
        "userAddress": 'xxxx'
    }
];

// this will be export a excel and the file's name is user-info-data.xlsx
// the default file's name is excel.xlsx
try {
    js2excel(columns, rows, 'user-info-data');
} catch (e) {
    console.error('export error');
}

// for webpack 3: dynamic import
import(/* webpackChunkName: "js2excel" */ 'js2excel').then((js2excel) => {
    js2excel(columns, rows, 'user-info-data');
}).catch((e) => {

});

Supported browsers

See this: FileSaver#supported-browsers

License

MIT