tauri/examples/api
Lucas Fernandes Nogueira 3e5c28ff4f
feat(tauri-plugin): generate permissions reference markdown file for plugin (#8729)
* feat(acl): generate reference markdown file

* lint

* generate plugin docs instead
2024-02-01 17:14:23 -03:00
..
dist refactor(core): add support to multiple webviews on a Tauri window (#8280) 2024-01-24 11:05:18 -03:00
isolation-dist refactor(core): use webview's URI schemes for IPC (#7170) 2023-08-10 10:12:38 -03:00
public refactor(examples/api): new look (#4465) 2022-07-03 22:15:23 -03:00
src fix: improvements and ipc fixes for loading window content using custom protocol (#8670) 2024-01-31 09:38:25 -03:00
src-tauri feat(tauri-plugin): generate permissions reference markdown file for plugin (#8729) 2024-02-01 17:14:23 -03:00
.gitignore chore(examples): ignore mobile artifacts on api example 2022-11-18 13:11:18 -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 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
unocss.config.js chore: update license year (#6311) 2023-02-19 10:17:49 -03:00
vite.config.js feat: add tray and menu javascript APIs and events, closes #6617 (#7709) 2023-11-19 08:38:24 -03:00
yarn.lock 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

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