docs.sheetjs.com/docz/docs/03-demos/06-desktop/04-tauri.md
2023-03-19 02:02:55 -04:00

4.6 KiB

title pagination_prev pagination_next sidebar_position sidebar_custom_props
Tauri demos/mobile/index demos/data/index 4
summary
Webview + Rust Backend

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

The NodeJS Module can be imported from JavaScript code.

The "Complete Example" creates an app that looks like the screenshot:

Win10 macOS Linux

Win10 screenshot

macOS screenshot

Linux screenshot

Integration Details

:::note

Tauri currently does not provide the equivalent of NodeJS fs module. The raw @tauri-apps/api methods used in the examples are not expected to change.

:::

http, dialog, and fs must be explicitly allowed in tauri.conf.json:

    "allowlist": {
      "http": {
        "all": true,
        "request": true,
        "scope": ["https://**"]
      },
      "dialog": {
        "all": true
      },
      "fs": {
        "all": true
      }

Reading Files

There are two steps to reading files: obtaining a path and reading binary data:

import { read } from 'xlsx';
import { open } from '@tauri-apps/api/dialog';
import { readBinaryFile } from '@tauri-apps/api/fs';

const filters = [
  {name: "Excel Binary Workbook", extensions: ["xlsb"]},
  {name: "Excel Workbook", extensions: ["xlsx"]},
  {name: "Excel 97-2004 Workbook", extensions: ["xls"]},
  // ... other desired formats ...
];

async function openFile() {
  /* show open file dialog */
  const selected = await open({
    title: "Open Spreadsheet",
    multiple: false,
    directory: false,
    filters
  });

  /* read data into a Uint8Array */
  const d = await readBinaryFile(selected);

  /* parse with SheetJS */
  const wb = read(d);
  return wb;
}

Writing Files

There are two steps to writing files: obtaining a path and writing binary data:

import { write } from 'xlsx';
import { save } from '@tauri-apps/api/dialog';
import { writeBinaryFile } from '@tauri-apps/api/fs';

const filters = [
  {name: "Excel Binary Workbook", extensions: ["xlsb"]},
  {name: "Excel Workbook", extensions: ["xlsx"]},
  {name: "Excel 97-2004 Workbook", extensions: ["xls"]},
  // ... other desired formats ...
];

async function saveFile(wb) {
  /* show save file dialog */
  const selected = await save({
    title: "Save to Spreadsheet",
    filters
  });
  if(!selected) return;

  /* Generate workbook */
  const bookType = selected.slice(selected.lastIndexOf(".") + 1);
  const d = write(wb, {type: "buffer", bookType});

  /* save data to file */
  await writeBinaryFile(selected, d);
}

Complete Example

:::note

This demo was tested against Tauri v1.2.3 on 2023 March 18.

:::

  1. Read Tauri "Getting Started" guide and install dependencies.

  2. Create a new Tauri app:

npm create tauri-app

When prompted:

  • Project Name: SheetJSTauri
  • Choose which language to use for your frontend: TypeScript / JavaScript
  • Choose your package manager: npm
  • Choose your UI template: Vue
  • Choose your UI flavor: TypeScript
  1. Enter the directory and install dependencies:
cd SheetJSTauri
npm i --save https://cdn.sheetjs.com/xlsx-latest/xlsx-latest.tgz
npm i --save @tauri-apps/api
npm i --save-dev @tauri-apps/cli
  1. Enable operations by adding the highlighted lines to tauri.conf.json in the tauri.allowlist section:
  "tauri": {
    "allowlist": {
// highlight-start
      "http": {
        "all": true,
        "request": true,
        "scope": ["https://**"]
      },
      "dialog": {
        "all": true
      },
      "fs": {
        "all": true
      },
// highlight-end

In the same file, look for the "identifier" key and replace the value with com.sheetjs.tauri:

        "icons/icon.ico"
      ],
      // highlight-next-line
      "identifier": "com.sheetjs.tauri",
      "longDescription": "",
  1. Download App.vue and replace src/App.vue with the downloaded script.
curl -L -o src/App.vue https://docs.sheetjs.com/tauri/App.vue
  1. Build the app with
npm run tauri build

At the end, it will print the path to the generated program. Run the program!