sheetjs/docbits/10_install.md

Getting Started

Installation

In the browser, just add 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

unpkg makes the latest version available at:

<script src="https://unpkg.com/xlsx/dist/xlsx.full.min.js"></script>

With npm:

$ npm install xlsx

With bower:

$ bower install js-xlsx

Optional features (click to show)

The node version automatically requires modules for additional features. Some of these modules are rather large in size and are only needed in special circumstances, so they do not ship with the core. For browser use, they must be included directly:

<!-- international support from js-codepage -->
<script src="dist/cpexcel.js"></script>

An appropriate version for each dependency is included in the dist/ directory.

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
  }

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.