1
forked from sheetjs/sheetjs
sheetjs/demos/requirejs/README.md
SheetJS 64798fd1f9 version bump 0.13.0: AMD support
- library reshaped to support requirejs / amd without shim
- control comment visibility (fixes , h/t @cmuruganmsc)
- fixed README code sample error (fixes  h/t @iahmedani)
2018-06-01 12:32:08 -04:00

68 lines
1.2 KiB
Markdown

# RequireJS
The module complies with the AMD `define` semantics, enabling use in RequireJS
out of the box.
The require config should set `xlsx` path to the appropriate dist file:
```js
paths: {
xlsx: "xlsx.full.min"
},
```
Once that is set, app code can freely require `"xlsx"`:
```js
require(["xlsx"], function(XLSX) {
/* use XLSX here */
});
```
## Deployments
`browser.html` demonstrates a dynamic deployment, using the in-browser config:
```html
<script src="require.js"></script>
<script>
require.config({
baseUrl: ".",
name: "app",
paths: {
xlsx: "xlsx.full.min"
}
});
</script>
<script src="app.js"></script>
```
`optimizer.html` demonstrates an optimized deployment using `build.js` config:
```js
/* build config */
({
baseUrl: ".",
name: "app",
paths: {
xlsx: "xlsx.full.min"
},
out: "app-built.js"
})
```
The optimizer is invoked with:
```bash
node r.js -o build.js paths.requireLib=./require include=requireLib
```
That step creates a file `app-built.js` that can be included in a page:
```html
<!-- final bundle includes require.js, library and app code -->
<script src="app-built.js"></script>
```
[![Analytics](https://ga-beacon.appspot.com/UA-36810333-1/SheetJS/js-xlsx?pixel)](https://github.com/SheetJS/js-xlsx)