sheetjs_sheetjs/docbits/10_install.md
SheetJS 70c48a74b9 API Improvements
- `aoa_to_sheet` function (fixes #314 h/t @fonzy2013 @rvdwijngaard)
- `writeFileAsync` function (fixes #396 h/t @barbalex)
- `sheet_to_json` tests + docs + blankrows (fixes #602 h/t @EEaglehouse)
- write number format scan now includes every index >= 50
- propagate SSF IE8 fixes (fixes #171 h/t @sheetjsdev)
- update shim for extendscript (see #603 h/t @firas3d)
- more flow type definitions
2017-03-24 21:36:40 -04:00

1.8 KiB

Installation

With npm:

$ npm install xlsx

In the browser:

<script lang="javascript" src="dist/xlsx.core.min.js"></script>

With bower:

$ bower install js-xlsx

CDNjs automatically pulls the latest version and makes all versions available at http://cdnjs.com/libraries/xlsx

JS Ecosystem Demos

The demos directory includes sample projects for:

Optional Modules

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

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 5 Compatibility

Since xlsx.js uses ES5 functions like Array#forEach, older browsers require Polyfills. This repo and the gh-pages branch include a shim

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

<script type="text/javascript" src="/path/to/shim.js"></script>