tauri/examples/api
Lucas Fernandes Nogueira e227fe02f9
feat(core): allow defining global API script on plugin build (#9156)
* feat(core): allow defining global API script on plugin build

Adds `tauri_plugin::Builder::global_api_script_path` so plugin authors can define the JavaScript global API bindings (supposed to be injected to `window.__TAURI__`) at compile time, so the string is only part of the binary when withGlobalTauri is true.
Currently this needs to be done manually at runtime (and it's always added to the binary via include_str).

* prefix variable

* use list of scripts instead of combining them

* static str

* header [skip ci]

* slice
2024-03-12 12:01:13 -03:00
..
isolation-dist chore: update license headers 2024 (#9043) 2024-03-01 08:29:01 -03:00
public refactor(examples/api): new look (#4465) 2022-07-03 22:15:23 -03:00
src fix(core): fix emit skipping webview listeners if filter wasn't provided (#9107) 2024-03-07 20:36:52 +02:00
src-tauri feat(core): allow defining global API script on plugin build (#9156) 2024-03-12 12:01:13 -03:00
.gitignore fix(cli): build command features and bundles can have multiple values (#8744) 2024-02-03 09:14:02 -03:00
.setup-cross.sh fix(cross): Fix docker image and cross setup (#8094) 2023-10-26 13:58:56 -03:00
.taurignore feat(cli): automatically use .taurignore, ref #4617 (#4623) 2022-07-28 18:58:38 -03:00
index.html feat: add tray and menu javascript APIs and events, closes #6617 (#7709) 2023-11-19 08:38:24 -03:00
jsconfig.json refactor(core&api)!: hide internal functions and reuse them in api.js & rename tauri module to primitives (#7942) 2023-10-17 09:40:20 -03:00
package.json chore(deps-dev): bump vite from 4.4.12 to 4.5.2 in /examples/api (#8646) 2024-01-20 04:50:55 +02:00
README.md feat: add tray and menu javascript APIs and events, closes #6617 (#7709) 2023-11-19 08:38:24 -03:00
screenshot.png fix(examples): icon transparency (#2450) 2021-08-16 13:01:53 -03:00
svelte.config.js chore: update license headers 2024 (#9043) 2024-03-01 08:29:01 -03:00
unocss.config.js chore: update license headers 2024 (#9043) 2024-03-01 08:29:01 -03:00
vite.config.js chore: fix various typos (#9131) 2024-03-11 16:25:20 +02:00
yarn.lock chore(deps): bump undici from 5.26.5 to 5.28.3 in /examples/api (#8877) 2024-02-18 10:42:24 -03:00

API example

This example demonstrates Tauri's API capabilities using the @tauri-apps/api package. It's used as the main validation app, serving as the testbed of our development process. In the future, this app will be used on Tauri's integration tests.

App screenshot

Running the example

  • Compile Tauri go to root of the Tauri repo and run: Linux / Mac:
# choose to install node cli (1)
bash .scripts/setup.sh

Windows:

./.scripts/setup.ps1
  • Install dependencies (Run inside of this folder examples/api/)
# with yarn
$ yarn
# with npm
$ npm install
  • Run the app in development mode (Run inside of this folder examples/api/)
# with yarn
$ yarn tauri dev
# with npm
$ npm run tauri dev
  • Build an run the release app (Run inside of this folder examples/api/)
$ yarn tauri build
$ ./src-tauri/target/release/app