Skip to main content

AMD (define)

Each standalone release script is available at https://cdn.sheetjs.com/.

xlsx.full.min.js supports AMD with name xlsx out of the box.


note

When referencing by file name, AMD loaders typically omit the file extension.

The actual file name is xlsx.full.min.js, but the examples will refer to the script as xlsx.full.min.

NetSuite

After downloading the script, it can be referenced directly in define calls in SuiteScripts:

define(['N/file', './xlsx.full.min'], function(file, XLSX) {
// ... use XLSX here
})

As explained in the NetSuite demo, module aliases are created in config files referenced via @NAmdConfig comments.

SAP UI5

After downloading the script, it can be uploaded to the UI5 project and loaded in the sap.ui.define call:

sap.ui.define([
/* ... other libraries ... */
"path/to/xlsx.full.min"
], function(/* ... variables for the other libraries ... */, XLSX) {
// use XLSX here
})
danger

The SAP Website has a note about including third-party JS libraries. It recommends copying and pasting JavaScript code.

Copy and pasting code does not work for SheetJS scripts as they contain Unicode characters that may be mangled. The standalone script should be downloaded and manually uploaded to the project.

RequireJS

caution

The standalone script must be aliased to the path xlsx.

The requirejs.config function can define aliases through the paths key:

requirejs.config({
paths: {
xlsx: [ './xlsx.full.min' ]
}
});

After configuring the alias, app code can freely require xlsx:

require(['xlsx'], function(XLSX) {
// ... use XLSX here
});

Dojo Toolkit

Dojo has changed module loading strategies over the years. These examples were tested with Dojo 1.10.4 and are not guaranteed to work with other versions.

Live demos are included in "Dojo Toolkit"

caution

The standalone scripts add window.XLSX, so it is recommended to use _XLSX in the function arguments and access the library with XLSX in the callback:

require(["xlsx"], function(
_XLSX // !! NOTE: this is not XLSX! A different variable name must be used
) {
console.log(XLSX.version); // use XLSX in the callback
})

Synchronous Loading

When async is disabled, the scripts can be referenced directly in require calls.

<script src="//ajax.googleapis.com/ajax/libs/dojo/1.10.4/dojo/dojo.js" data-dojo-config="isDebug:1, async:0"></script>
<script>
require([
"https://cdn.sheetjs.com/xlsx-latest/package/dist/xlsx.full.min.js"
], function(
_XLSX // !! NOTE: this is not XLSX! A different variable name must be used
) {
// ... use XLSX here
})
</script>

Asynchronous Loading

When async is enabled, Dojo will only understand the name xlsx. The config object can map package names to scripts:

<script>
// This setting must appear *before* loading dojo.js
dojoConfig = {
packages: [
{
name: "xlsx",
// if self-hosting the script, location should be a folder relative to baseUrl setting
location: "https://cdn.sheetjs.com/xlsx-latest/package/dist",
// name of the script (without the .js extension)
main: "xlsx.full.min"
}
]
}
</script>
<script src="//ajax.googleapis.com/ajax/libs/dojo/1.10.4/dojo/dojo.js" data-dojo-config="isDebug:1, async:1"></script>
<script>
require(["xlsx"], function(_XLSX) {
// ... use XLSX here
});
</script>