sheetjs
/
sheetjs
26
Fork 25
Code Issues 176 Pull Requests 12 Wiki Activity
sheetjs/docbits/10_install.md

2.8 KiB
Raw Blame History

Getting Started

Installation

The complete browser standalone build is saved to dist/xlsx.full.min.js and can be directly added to a page with a script tag:

<script lang="javascript" src="dist/xlsx.full.min.js"></script>
CDN Availability (click to show)
CDN URL
unpkg https://unpkg.com/xlsx/
jsDelivr https://jsdelivr.com/package/npm/xlsx
CDNjs https://cdnjs.com/libraries/xlsx
packd https://bundle.run/xlsx@latest?name=XLSX

For example, unpkg makes the latest version available at:

<script src="https://unpkg.com/xlsx/dist/xlsx.full.min.js"></script>
Browser builds (click to show)

The complete single-file version is generated at dist/xlsx.full.min.js

A slimmer build is generated at dist/xlsx.mini.min.js. Compared to full build:

  • codepage library skipped (no support for XLS encodings)
  • XLSX compression option not currently available
  • no support for XLSB / XLS / Lotus 1-2-3 / SpreadsheetML 2003
  • node stream utils removed

Webpack and Browserify builds include optional modules by default. Webpack can be configured to remove support with resolve.alias:

  /* uncomment the lines below to remove support */
  resolve: {
    alias: { "./dist/cpexcel.js": "" } // <-- omit international support
  }

With npm:

$ npm install xlsx

With bower:

$ bower install js-xlsx

dist/xlsx.extendscript.js is an ExtendScript build for Photoshop and InDesign that is included in the npm package. It can be directly referenced with a #include directive:

#include "xlsx.extendscript.js"
Internet Explorer and ECMAScript 3 Compatibility (click to show)

For broad compatibility with JavaScript engines, the library is written using ECMAScript 3 language dialect as well as some ES5 features like Array#forEach. Older browsers require shims to provide missing functions.

To use the shim, add the shim before the script tag that loads xlsx.js:

<!-- add the shim first -->
<script type="text/javascript" src="shim.min.js"></script>
<!-- after the shim is referenced, add the library -->
<script type="text/javascript" src="xlsx.full.min.js"></script>

The script also includes IE_LoadFile and IE_SaveFile for loading and saving files in Internet Explorer versions 6-9. The xlsx.extendscript.js script bundles the shim in a format suitable for Photoshop and other Adobe products.