docs.sheetjs.com/docz/docs/02-getting-started/01-installation/04-amd.md

173 lines
4.4 KiB
Markdown
Raw Normal View History

2022-06-11 17:21:26 +00:00
---
2022-08-24 23:48:22 +00:00
pagination_prev: getting-started/index
2023-07-26 20:18:07 +00:00
pagination_next: getting-started/examples/index
2022-08-31 06:46:03 +00:00
sidebar_position: 4
2022-06-11 17:21:26 +00:00
sidebar_custom_props:
2022-06-22 19:25:24 +00:00
summary: NetSuite, SAP UI5, RequireJS
2022-06-11 17:21:26 +00:00
---
import current from '/version.js';
2023-04-29 11:21:37 +00:00
import CodeBlock from '@theme/CodeBlock';
2022-06-11 17:21:26 +00:00
2022-06-27 02:05:36 +00:00
# AMD (define)
2022-06-11 17:21:26 +00:00
Each standalone release script is available at <https://cdn.sheetjs.com/>.
`xlsx.full.min.js` supports AMD with name `xlsx` out of the box.
2023-05-07 13:58:36 +00:00
<p><a href={`https://cdn.sheetjs.com/xlsx-${current}/package/dist/xlsx.full.min.js`}>https://cdn.sheetjs.com/xlsx-{current}/package/dist/xlsx.full.min.js</a> is the URL for {current}</p>
2022-06-11 17:21:26 +00:00
2022-06-22 19:25:24 +00:00
:::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`.
:::
2023-06-25 09:36:58 +00:00
:::tip pass
2023-04-27 09:12:19 +00:00
[Watch the repo](https://git.sheetjs.com/SheetJS/sheetjs) or subscribe to the
[RSS feed](https://git.sheetjs.com/sheetjs/sheetjs/tags.rss) to be notified when
new versions are released!
:::
2022-06-11 17:21:26 +00:00
## NetSuite
2023-07-26 20:18:07 +00:00
After adding to the File Cabinet, scripts can be referenced in `define` calls
in SuiteScripts. For example, if the `xlsx.full.min.js` script is placed in the
same folder as the SuiteScript, the relative import `"./xlsx.full.min"` works:
2022-06-11 17:21:26 +00:00
```js
define(['N/file', './xlsx.full.min'], function(file, XLSX) {
// ... use XLSX here
})
```
2023-07-23 21:01:30 +00:00
As explained in the [NetSuite demo](/docs/demos/cloud/netsuite), module aliases
can be created in config files referenced via `@NAmdConfig` comments.
2022-06-11 17:21:26 +00:00
2022-06-22 19:25:24 +00:00
## SAP UI5
After downloading the script, it can be uploaded to the UI5 project and loaded
in the `sap.ui.define` call:
```js
sap.ui.define([
/* ... other libraries ... */
"path/to/xlsx.full.min"
], function(/* ... variables for the other libraries ... */, XLSX) {
// use XLSX here
})
```
:::warning
**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.
:::
2022-06-11 17:21:26 +00:00
## RequireJS
2022-09-22 00:20:14 +00:00
:::caution
2022-06-11 17:21:26 +00:00
2022-09-22 00:20:14 +00:00
The standalone script must be aliased to the path `xlsx`.
2022-06-27 02:05:36 +00:00
2022-06-11 17:21:26 +00:00
The `requirejs.config` function can define aliases through the `paths` key:
```js
requirejs.config({
paths: {
xlsx: [ './xlsx.full.min' ]
}
});
```
2022-06-27 02:05:36 +00:00
2022-09-22 00:20:14 +00:00
:::
After configuring the alias, app code can freely require `xlsx`:
2022-06-27 02:05:36 +00:00
```js
require(['xlsx'], function(XLSX) {
// ... use XLSX here
});
```
2022-08-30 22:12:52 +00:00
## 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.
2023-01-09 17:25:32 +00:00
Live demos are included in ["Dojo Toolkit"](/docs/demos/frontend/legacy#dojo-toolkit)
2022-08-30 22:12:52 +00:00
:::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:
```js
require(["xlsx"], function(
// highlight-next-line
_XLSX // !! NOTE: this is not XLSX! A different variable name must be used
) {
// highlight-next-line
console.log(XLSX.version); // use XLSX in the callback
})
```
:::
#### Synchronous Loading
2023-07-06 07:21:41 +00:00
When `async` is set to `false` or `0`, the scripts can be directly referenced in
`require` calls.
2022-08-30 22:12:52 +00:00
2023-04-29 11:21:37 +00:00
<CodeBlock language="html">{`\
2022-08-30 22:12:52 +00:00
<script src="//ajax.googleapis.com/ajax/libs/dojo/1.10.4/dojo/dojo.js" data-dojo-config="isDebug:1, async:0"></script>
<script>
require([
// highlight-next-line
2023-04-29 11:21:37 +00:00
"https://cdn.sheetjs.com/xlsx-${current}/package/dist/xlsx.full.min.js"
2022-08-30 22:12:52 +00:00
], function(
// highlight-next-line
_XLSX // !! NOTE: this is not XLSX! A different variable name must be used
) {
// ... use XLSX here
2023-04-29 11:21:37 +00:00
});
</script>`}
</CodeBlock>
2022-08-30 22:12:52 +00:00
#### Asynchronous Loading
When `async` is enabled, Dojo will only understand the name `xlsx`. The config
object can map package names to scripts:
2023-04-29 11:21:37 +00:00
<CodeBlock language="html">{`\
2022-08-30 22:12:52 +00:00
<script>
// This setting must appear *before* loading dojo.js
dojoConfig = {
packages: [
// highlight-start
{
name: "xlsx",
// if self-hosting the script, location should be a folder relative to baseUrl setting
2023-04-29 11:21:37 +00:00
location: "https://cdn.sheetjs.com/xlsx-${current}/package/dist",
2022-08-30 22:12:52 +00:00
// name of the script (without the .js extension)
main: "xlsx.full.min"
}
// highlight-end
]
2023-04-29 11:21:37 +00:00
};
2022-08-30 22:12:52 +00:00
</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
});
2023-04-29 11:21:37 +00:00
</script>`}
2023-07-26 20:18:07 +00:00
</CodeBlock>