2023-04-29 07:21:37 -04:00

172 lines
5.8 KiB

pagination_prev: getting-started/index
pagination_next: getting-started/example
sidebar_position: 1
summary: Classic pages with simple <script> tags
import current from '/version.js';
# Standalone Browser Scripts
Each standalone release script is available at <>.
<div>The current version is {current} and can be referenced as follows:</div>
<pre><code parentName="pre" {...{"className": "language-html"}}>{`\
<!-- use version ${current} -->
<script lang="javascript" src="${current}/package/dist/xlsx.full.min.js"></script>`}
[Watch the repo]( or subscribe to the
[RSS feed]( to be notified when
new versions are released!
A number of services host older versions of the SheetJS libraries. Due to
syncing issues, they are generally out of date.
They are known CDN bugs.
<> is the authoritative source for SheetJS modules.
## Browser Scripts
`xlsx.full.min.js` is the complete standalone script. It includes support for
reading and writing many spreadsheet formats.
<pre><code parentName="pre" {...{"className": "language-html"}}>{`\
<!-- use xlsx.full.min.js from version ${current} -->
<script lang="javascript" src="${current}/package/dist/xlsx.full.min.js"></script>`}
A slimmer build is generated at `dist/`. Compared to full build:
- codepage library skipped (no support for XLS encodings)
- no support for XLSB / XLS / Lotus 1-2-3 / SpreadsheetML 2003 / Numbers
- node stream utils removed
<details><summary><b>How to integrate the mini build</b> (click to show)</summary>
Replace references to `xlsx.full.min.js` with ``. Starting from
scratch, a single script tag should be added at the top of the HTML page:
<pre><code parentName="pre" {...{"className": "language-html"}}>{`\
<!-- use from version ${current} -->
<script lang="javascript" src="${current}/package/dist/"></script>`}
### Internet Explorer and Older Browsers
For broad compatibility with JavaScript engines, the library is written using
ECMAScript 3 language dialect. A "shim" script provides implementations of
functions for older browsers and environments.
<div>Due to SSL compatibility issues, older versions of IE will not be able to
use the CDN scripts directly. They should be downloaded and saved to a public
directory in the site:
<li>Standalone: <a href={`${current}/package/dist/`}>{current}/package/dist/</a></li>
<li>Shim: <a href={`${current}/package/dist/shim.min.js`}>{current}/package/dist/shim.min.js</a></li>
Add a `script` reference to 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>
### Web Workers
The standalone scripts can be loaded using `importScripts` at the top of the
worker scripts:
<pre><code parentName="pre" {...{"className": "language-js"}}>{`\
## ECMAScript Module Imports
This section refers to imports using `script type="module"`. For imports in
modern projects using Webpack or React or Angular or VueJS, the installation is
described [in the next section](/docs/getting-started/installation/frameworks).
The ECMAScript Module build is saved to `xlsx.mjs` and can be directly added to
a page with a `script` tag using `type="module"`:
<pre><code parentName="pre" {...{"className": "language-html"}}>{`\
<script type="module">
import { read, writeFileXLSX } from "${current}/package/xlsx.mjs";
If Encoding support is required, `cpexcel.full.mjs` must be manually imported:
<pre><code parentName="pre" {...{"className": "language-html"}}>{`\
<script type="module">
/* load the codepage support library for extended support with older formats */
import { set_cptable } from "${current}/package/xlsx.mjs";
import * as cptable from '${current}/package/dist/cpexcel.full.mjs';
Dynamic imports with `import()` can be used in data export scenarios. This
example will download the library only when the export button is pressed:
<pre><code parentName="pre" {...{"className": "language-html"}}>{`\
<button id="xport">Export</button>
<script type="module">
xport.addEventListener("click", async() => {
/* dynamically import the library in the event listener */
// highlight-next-line
const XLSX = await import("${current}/package/xlsx.mjs");
const wb = XLSX.utils.book_new();
const ws = XLSX.utils.aoa_to_sheet([["a","b","c"],[1,2,3]]);
XLSX.utils.book_append_sheet(wb, ws, "Sheet1");
XLSX.writeFile(wb, "SheetJSESMTest.xlsx");
Web Worker support is noted in [the demo](/docs/demos/bigdata/worker#installation)
## Bower
Bower is deprecated and the maintainers recommend using other tools.
The Bower package manager plays nice with the CDN tarballs:
<pre><code parentName="pre" {...{"className": "language-bash"}}>{`\
npx bower install${current}/xlsx-${current}.tgz`}
Bower will place the standalone scripts in `bower_components/js-xlsx/dist/`