Import from XLSX

Import from XLSX

The JSS parser is a JavaScript plugin that converts XLSX files to JSON format. It can be used as a standalone converter or to import XLSX files into the JSS data grid.

Documentation

Settings

PropertyDescription
url?: string Load the XSLX from a remote URL. Bear in mind any potential CORS restrictions using this property.
locale?: string Define the decimal and thousand separator based on a locale.
file?: object load from a local file. This property is used along input type='file'
onload?: function When the file is loaded.
onerror?: function Method to be called when something is wrong.


Installation

Please choose one of the following options

Using NPM

npm install @jspreadsheet/parser

Using a CDN

<script src="https://cdn.jsdelivr.net/npm/@jspreadsheet/parser/dist/index.min.js"></script>

Example

JavaScript example

<html>
<script src="https://jspreadsheet.com/v10/jspreadsheet.js"></script>
<script src="https://jsuites.net/v5/jsuites.js"></script>
<link rel="stylesheet" href="https://jspreadsheet.com/v10/jspreadsheet.css" type="text/css" />
<link rel="stylesheet" href="https://jsuites.net/v5/jsuites.css" type="text/css" />
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Material+Icons" />

<script src="https://cdn.jsdelivr.net/npm/jszip@3.6.0/dist/jszip.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@jspreadsheet/parser/dist/index.min.js"></script>

<div id="spreadsheet"></div>

<input type="file" name="file" id='file' onchange="load(event)" style='display:none'>

<input type='button' value='Load a XLSX file from my local computer'
    onclick="document.getElementById('file').click()">

<script>
// Set license
jspreadsheet.setLicense('ZGI4Mzc0NzIwNmRkYzE4ZWUyMjFhN2YzMzU3ZTU4MGVkMjRkNDMwODQ2YjAzOGMwZWM3MjllZGJiNDMwZThhOWQyMTFhYjhhYWU5M2VkYThmYzY3N2Y0N2RiNDkxZWM1NGI2ZDhlNjIyNjQzMGUzMmQwOWIxOTU1ZWMzNzVmNzIsZXlKdVlXMWxJam9pU25Od2NtVmhaSE5vWldWMElpd2laR0YwWlNJNk1UY3hNRGt5T0Rnd01Td2laRzl0WVdsdUlqcGJJbXB6Y0hKbFlXUnphR1ZsZEM1amIyMGlMQ0pqYjJSbGMyRnVaR0p2ZUM1cGJ5SXNJbXB6YUdWc2JDNXVaWFFpTENKamMySXVZWEJ3SWl3aWQyVmlJaXdpYkc5allXeG9iM04wSWwwc0luQnNZVzRpT2lJek5DSXNJbk5qYjNCbElqcGJJblkzSWl3aWRqZ2lMQ0oyT1NJc0luWXhNQ0lzSW1Ob1lYSjBjeUlzSW1admNtMXpJaXdpWm05eWJYVnNZU0lzSW5CaGNuTmxjaUlzSW5KbGJtUmxjaUlzSW1OdmJXMWxiblJ6SWl3aWFXMXdiM0owWlhJaUxDSmlZWElpTENKMllXeHBaR0YwYVc5dWN5SXNJbk5sWVhKamFDSXNJbkJ5YVc1MElpd2ljMmhsWlhSeklsMHNJbVJsYlc4aU9uUnlkV1Y5');

// Set extensions
jspreadsheet.setExtensions({ parser });

// Create the spreadsheet from a local file
var load = function(e) {
    // Parse XLSX file and create a new spreadsheet
    jspreadsheet.parser({
        file: e.target.files[0],
        // It would be used to updated the formats only
        locale: 'en-GB',
        onload: function(config) {
            jspreadsheet(document.getElementById('spreadsheet'), config);
        },
        onerror: function(error) {
            alert(error);
        }
    });
}
</script>
</html>

React example

import React, { useRef } from "react";
import { Spreadsheet, Worksheet, jspreadsheet } from "@jspreadsheet/react";
import parser from "@jspreadsheet/parser";

// Set license
jspreadsheet.setLicense('ZGI4Mzc0NzIwNmRkYzE4ZWUyMjFhN2YzMzU3ZTU4MGVkMjRkNDMwODQ2YjAzOGMwZWM3MjllZGJiNDMwZThhOWQyMTFhYjhhYWU5M2VkYThmYzY3N2Y0N2RiNDkxZWM1NGI2ZDhlNjIyNjQzMGUzMmQwOWIxOTU1ZWMzNzVmNzIsZXlKdVlXMWxJam9pU25Od2NtVmhaSE5vWldWMElpd2laR0YwWlNJNk1UY3hNRGt5T0Rnd01Td2laRzl0WVdsdUlqcGJJbXB6Y0hKbFlXUnphR1ZsZEM1amIyMGlMQ0pqYjJSbGMyRnVaR0p2ZUM1cGJ5SXNJbXB6YUdWc2JDNXVaWFFpTENKamMySXVZWEJ3SWl3aWQyVmlJaXdpYkc5allXeG9iM04wSWwwc0luQnNZVzRpT2lJek5DSXNJbk5qYjNCbElqcGJJblkzSWl3aWRqZ2lMQ0oyT1NJc0luWXhNQ0lzSW1Ob1lYSjBjeUlzSW1admNtMXpJaXdpWm05eWJYVnNZU0lzSW5CaGNuTmxjaUlzSW5KbGJtUmxjaUlzSW1OdmJXMWxiblJ6SWl3aWFXMXdiM0owWlhJaUxDSmlZWElpTENKMllXeHBaR0YwYVc5dWN5SXNJbk5sWVhKamFDSXNJbkJ5YVc1MElpd2ljMmhsWlhSeklsMHNJbVJsYlc4aU9uUnlkV1Y5');

// Set extensions
jspreadsheet.setExtensions({ parser });

// Create the spreadsheet from a local file
const load = function(e) {
    // Parse XLSX file and create a new spreadsheet
    jspreadsheet.parser({
        file: e.target.files[0],
        // It would be used to updated the formats only
        locale: 'en-GB',
        onload: function(config) {
            jspreadsheet(document.getElementById('spreadsheet'), config);
        },
        onerror: function(error) {
            alert(error);
        }
    });
}

export default function App() {
    // Spreadsheet array of worksheets
    const spreadsheet = useRef();
    // Render component
    return (
        <>
            <div id="spreadsheet"></div>
            <input type="file" name="file" id="file" onChange={load} style={{ display: 'none' }} />
            <input type="button" value="Load a XLSX file from my local computer"
                    onClick="() => document.getElementById("file").click()">
        </>
    );
}
See this example on codesandbox

Vue example

<template>
  <div ref="spreadsheet"></div>
  <input
    type="file"
    name="file"
    ref="fileInput"
    @change="loadFile"
    style="display: none"
  />
  <input
    type="button"
    value="Load a XLSX file from my local computer"
    @click="triggerFileInput"
  />
</template>
  
<script>
import { jspreadsheet } from "@jspreadsheet/vue";
import parser from "@jspreadsheet/parser";

jspreadsheet.setLicense('ZGI4Mzc0NzIwNmRkYzE4ZWUyMjFhN2YzMzU3ZTU4MGVkMjRkNDMwODQ2YjAzOGMwZWM3MjllZGJiNDMwZThhOWQyMTFhYjhhYWU5M2VkYThmYzY3N2Y0N2RiNDkxZWM1NGI2ZDhlNjIyNjQzMGUzMmQwOWIxOTU1ZWMzNzVmNzIsZXlKdVlXMWxJam9pU25Od2NtVmhaSE5vWldWMElpd2laR0YwWlNJNk1UY3hNRGt5T0Rnd01Td2laRzl0WVdsdUlqcGJJbXB6Y0hKbFlXUnphR1ZsZEM1amIyMGlMQ0pqYjJSbGMyRnVaR0p2ZUM1cGJ5SXNJbXB6YUdWc2JDNXVaWFFpTENKamMySXVZWEJ3SWl3aWQyVmlJaXdpYkc5allXeG9iM04wSWwwc0luQnNZVzRpT2lJek5DSXNJbk5qYjNCbElqcGJJblkzSWl3aWRqZ2lMQ0oyT1NJc0luWXhNQ0lzSW1Ob1lYSjBjeUlzSW1admNtMXpJaXdpWm05eWJYVnNZU0lzSW5CaGNuTmxjaUlzSW5KbGJtUmxjaUlzSW1OdmJXMWxiblJ6SWl3aWFXMXdiM0owWlhJaUxDSmlZWElpTENKMllXeHBaR0YwYVc5dWN5SXNJbk5sWVhKamFDSXNJbkJ5YVc1MElpd2ljMmhsWlhSeklsMHNJbVJsYlc4aU9uUnlkV1Y5');

jspreadsheet.setExtensions({ parser });

export default {
  methods: {
    triggerFileInput() {
      this.$refs.fileInput.click();
    },
    loadFile(e) {
      const spreadsheetEl = this.$refs.spreadsheet;
      jspreadsheet.parser({
        file: e.target.files[0],
        locale: "en-GB",
        onload: function (config) {
          jspreadsheet(spreadsheetEl, config);
        },
        onerror: function (error) {
          alert(error);
        },
      });
    },
  },
};
</script>
See this example on codesandbox

Angular example

import { Component, ViewChild, ElementRef } from "@angular/core";
import * as jspreadsheet from "jspreadsheet";
import * as parser from "@jspreadsheet/parser";

// Set your JSS license key (The following key only works for one day)
jspreadsheet.setLicense('ZGI4Mzc0NzIwNmRkYzE4ZWUyMjFhN2YzMzU3ZTU4MGVkMjRkNDMwODQ2YjAzOGMwZWM3MjllZGJiNDMwZThhOWQyMTFhYjhhYWU5M2VkYThmYzY3N2Y0N2RiNDkxZWM1NGI2ZDhlNjIyNjQzMGUzMmQwOWIxOTU1ZWMzNzVmNzIsZXlKdVlXMWxJam9pU25Od2NtVmhaSE5vWldWMElpd2laR0YwWlNJNk1UY3hNRGt5T0Rnd01Td2laRzl0WVdsdUlqcGJJbXB6Y0hKbFlXUnphR1ZsZEM1amIyMGlMQ0pqYjJSbGMyRnVaR0p2ZUM1cGJ5SXNJbXB6YUdWc2JDNXVaWFFpTENKamMySXVZWEJ3SWl3aWQyVmlJaXdpYkc5allXeG9iM04wSWwwc0luQnNZVzRpT2lJek5DSXNJbk5qYjNCbElqcGJJblkzSWl3aWRqZ2lMQ0oyT1NJc0luWXhNQ0lzSW1Ob1lYSjBjeUlzSW1admNtMXpJaXdpWm05eWJYVnNZU0lzSW5CaGNuTmxjaUlzSW5KbGJtUmxjaUlzSW1OdmJXMWxiblJ6SWl3aWFXMXdiM0owWlhJaUxDSmlZWElpTENKMllXeHBaR0YwYVc5dWN5SXNJbk5sWVhKamFDSXNJbkJ5YVc1MElpd2ljMmhsWlhSeklsMHNJbVJsYlc4aU9uUnlkV1Y5');

// Set the extensions
jspreadsheet.setExtensions({ parser });

@Component({
    selector: "app-root",
    template: `<div #spreadsheet></div>
        <input #file type="file" name="file" style="display:none" />
        <input type="button" value="Load a XLSX file from my local computer" (click)="this.file.click()"/>`
})
export class AppComponent {
    @ViewChild("spreadsheet") spreadsheet: ElementRef;
    @ViewChild("file") file: ElementRef;

    ngAfterViewInit() {
        let spreadsheet = this.spreadsheet.nativeElement;
        // Add event to the file input
        this.file.nativeElement.onchange = function (e) {
            // Parse XLSX file and create a new spreadsheet
            jspreadsheet.parser({
                file: e.target.files[0],
                locale: "en-GB",
                onload: function (config) {
                    jspreadsheet(spreadsheet, config);
                },
                onerror: function (error) {
                    alert(error);
                }
            });
        };
    }
}


Example in action

Click the Import button below to import an XLSX from your local device and create a JSS spreadsheet.