docs.sheetjs.com/docz/docs/03-demos/06-desktop/02-nwjs.md

175 lines
4.6 KiB
Markdown
Raw Normal View History

2023-01-05 03:57:48 +00:00
---
title: NW.js
2023-01-05 23:33:49 +00:00
pagination_prev: demos/mobile/index
2023-02-28 11:40:44 +00:00
pagination_next: demos/data/index
2023-01-05 03:57:48 +00:00
sidebar_position: 2
sidebar_custom_props:
summary: Embedded Chromium + NodeJS
---
2023-04-27 09:12:19 +00:00
import current from '/version.js';
2023-01-05 03:57:48 +00:00
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
2023-04-29 11:21:37 +00:00
import CodeBlock from '@theme/CodeBlock';
2023-01-05 03:57:48 +00:00
2023-09-22 06:32:55 +00:00
The [SheetJS Standalone scripts](/docs/getting-started/installation/standalone)
can be referenced in a `SCRIPT` tag from the entry point HTML page.
2023-01-05 03:57:48 +00:00
2023-01-09 05:08:30 +00:00
The "Complete Example" creates an app that looks like the screenshots below:
2023-01-05 03:57:48 +00:00
2023-01-09 05:08:30 +00:00
<table><thead><tr>
2023-02-21 01:04:05 +00:00
<th><a href="#complete-example">Win10</a></th>
2023-01-09 05:08:30 +00:00
<th><a href="#complete-example">macOS</a></th>
<th><a href="#complete-example">Linux</a></th>
</tr></thead><tbody><tr><td>
2023-01-05 03:57:48 +00:00
2023-02-21 01:04:05 +00:00
![Win10 screenshot](pathname:///nwjs/nww.png)
</td><td>
2023-01-09 05:08:30 +00:00
![macOS screenshot](pathname:///nwjs/nwm.png)
2023-01-05 03:57:48 +00:00
2023-01-09 05:08:30 +00:00
</td><td>
2023-01-05 03:57:48 +00:00
2023-01-09 05:08:30 +00:00
![Linux screenshot](pathname:///nwjs/nwl.png)
2023-01-05 03:57:48 +00:00
2023-01-09 05:08:30 +00:00
</td></tr></tbody></table>
2023-01-05 03:57:48 +00:00
2023-01-09 05:08:30 +00:00
## Integration Details
2023-01-05 03:57:48 +00:00
2023-01-09 05:08:30 +00:00
NW.js provides solutions for reading and writing files.
2023-01-05 03:57:48 +00:00
2023-02-12 08:15:17 +00:00
### Reading Files
2023-01-05 03:57:48 +00:00
The standard HTML5 `FileReader` techniques from the browser apply to NW.js!
NW.js handles the OS minutiae for dragging files into app windows. The
[drag and drop snippet](/docs/solutions/input#example-user-submissions) apply
to DIV elements on the page.
Similarly, file input elements automatically map to standard Web APIs.
For example, assuming a file input element on the page:
```html
<input type="file" name="xlfile" id="xlf" />
```
The event handler would process the event as if it were a web event:
```js
async function handleFile(e) {
const file = e.target.files[0];
const data = await file.arrayBuffer();
/* data is an ArrayBuffer */
const workbook = XLSX.read(data);
/* DO SOMETHING WITH workbook HERE */
}
document.getElementById("xlf").addEventListener("change", handleFile, false);
```
2023-02-12 08:15:17 +00:00
### Writing Files
2023-01-05 03:57:48 +00:00
File input elements with the attribute `nwsaveas` show UI for saving a file. The
standard trick is to generate a hidden file input DOM element and "click" it.
Since NW.js does not present a `writeFileSync` in the `fs` package, a manual
step is required:
```js
/* pre-build the hidden nwsaveas input element */
var input = document.createElement('input');
input.style.display = 'none';
input.setAttribute('nwsaveas', 'SheetJSNWDemo.xlsx');
input.setAttribute('type', 'file');
document.body.appendChild(input);
/* show a message if the save is canceled */
input.addEventListener('cancel',function(){ alert("Save was canceled!"); });
/* write to a file on the 'change' event */
input.addEventListener('change',function(e){
/* the `value` is the path that the program will write */
var filename = this.value;
/* use XLSX.write with type "buffer" to generate a buffer" */
/* highlight-next-line */
var wbout = XLSX.write(workbook, {type:'buffer', bookType:"xlsx"});
/* highlight-next-line */
2023-01-09 05:08:30 +00:00
require("fs").writeFile(filename, wbout, function(err) {
2023-01-05 03:57:48 +00:00
if(!err) return alert("Saved to " + filename);
alert("Error: " + (err.message || err));
});
});
input.click();
```
2023-01-09 05:08:30 +00:00
## Complete Example
2023-02-12 08:15:17 +00:00
:::note
2023-09-25 07:30:54 +00:00
This demo was tested in the following environments:
| OS and Version | Arch | NW.js | Date |
|:---------------|:-----|:---------|:-----------|
2023-09-27 04:43:00 +00:00
| macOS 13.5.2 | x64 | `0.78.1` | 2023-09-27 |
| macOS 13.5.2 | ARM | `0.78.1` | 2023-09-27 |
| Windows 10 | x64 | `0.78.1` | 2023-09-27 |
| Windows 11 | ARM | `0.78.1` | 2023-09-27 |
| Linux (HoloOS) | x64 | `0.78.1` | 2023-09-27 |
2023-02-12 08:15:17 +00:00
:::
2023-01-09 05:08:30 +00:00
1) Create a `package.json` file that specifies the entry point:
2023-04-29 11:21:37 +00:00
<CodeBlock language="json" title="package.json">{`\
2023-01-09 05:08:30 +00:00
{
"name": "sheetjs-nwjs",
"author": "sheetjs",
"version": "0.0.0",
"main": "index.html",
"dependencies": {
2023-09-27 04:43:00 +00:00
"nw": "0.78.1",
2023-04-29 11:21:37 +00:00
"xlsx": "https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz"
2023-01-09 05:08:30 +00:00
}
2023-04-29 11:21:37 +00:00
}`}
</CodeBlock>
2023-01-09 05:08:30 +00:00
2) Download [`index.html`](pathname:///nwjs/index.html) into the same folder.
2023-09-24 03:59:48 +00:00
:::caution pass
2023-01-09 05:08:30 +00:00
Right-click the link and select "Save Link As...". Left-clicking the link will
try to load the page in your browser. The goal is to save the file contents.
:::
2023-02-21 01:04:05 +00:00
In the terminal window, the download can be performed with:
```bash
curl -LO https://docs.sheetjs.com/nwjs/index.html
```
2023-09-27 04:43:00 +00:00
3) Install dependencies:
```bash
npm i
```
2023-01-09 05:08:30 +00:00
4) To verify the app works, run in the test environment:
```bash
npx nw .
```
The app will show and you should be able to verify reading and writing by using
the file input element to select a spreadsheet and clicking the export button.
5) To build a standalone app, run the builder:
```bash
2023-09-27 04:43:00 +00:00
npx -p nw-builder nwbuild --mode=build --version=0.78.1 --glob=false --outDir=../out ./
2023-01-09 05:08:30 +00:00
```
2023-09-27 04:43:00 +00:00
This will generate the standalone app in the `..\out\` folder.