docs.sheetjs.com/docz/docs/02-installation/02-frameworks.md
2022-08-07 03:48:40 -04:00

2.4 KiB

sidebar_position sidebar_custom_props
2
summary
Angular, React, VueJS, Webpack, etc.

import current from '/version.js';

Frameworks and Bundlers

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Each standalone release package is available at https://cdn.sheetjs.com/. The NodeJS package is designed to be used with frameworks and bundlers. It is a proper ECMAScript Module release which can be optimized with developer tools.

{`\
npm i --save https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`}
{`\
pnpm install https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`}
{`\
yarn add https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`}

Once installed, the library can be imported under the name xlsx:

import { read, writeFileXLSX } from "xlsx";

:::warning

Older releases are technically available on the public npm registry as xlsx, but the registry is out of date. The latest version on that registry is 0.18.5

This is a known registry bug

https://cdn.sheetjs.com/ is the authoritative source for SheetJS scripts.

For existing projects, the easiest approach is to uninstall and reinstall:

{`\
npm rm --save xlsx
npm i --save file:vendor/xlsx-${current}.tgz`}
{`\
pnpm rm xlsx
pnpm install file:vendor/xlsx-${current}.tgz`}
{`\
yarn remove xlsx
yarn add file:vendor/xlsx-${current}.tgz`}

:::

XLS Support

If XLS support is required, cpexcel.full.mjs must be manually imported:

/* load the codepage support library for extended support with older formats  */
import { set_cptable } from "xlsx";
import * as cptable from 'xlsx/dist/cpexcel.full.mjs';
set_cptable(cptable);