-_"Spacedrive had to feel native across all platforms, all while being lightweight, instant to launch and extremely fast to use. This just wasn't possible with a web-based UI — until now, thanks to Tauri."_
+_"Spacedrive had to feel native across all platforms, all while being lightweight, instant to launch and extremely fast to use. This just wasn't possible with a web-based UI — until now, thanks to Tauri."_
**- Jamie Pine**, [Spacedrive](https://www.spacedrive.com) Founder
@@ -146,7 +146,7 @@ _"Tauri stands to reduce the disastrously negative environmental costs of bloate
-_"With its security-focused design and low memory footprint, Tauri is the electron alternative we've been waiting for. Tauri has allowed us to build a more secure, more performant desktop app while using the same web technologies, which we love. Thanks to the team for their amazing work!_
+_"With its security-focused design and low memory footprint, Tauri is the electron alternative we've been waiting for. Tauri has allowed us to build a more secure, more performant desktop app while using the same web technologies, which we love. Thanks to the team for their amazing work!_
_P.S.: Can't wait for mobile support!"_
**- Martin Kleinschrodt**, [Padloc](https://padloc.app/) Founder
diff --git a/src/content/docs/blog/tauri_1_0_images/padloc_logo_dark.svg b/src/content/docs/blog/tauri_1_0_images/padloc_logo_dark.svg
index 9e6ecb6fb..379369b27 100644
--- a/src/content/docs/blog/tauri_1_0_images/padloc_logo_dark.svg
+++ b/src/content/docs/blog/tauri_1_0_images/padloc_logo_dark.svg
@@ -15,4 +15,4 @@
-
\ No newline at end of file
+
diff --git a/src/content/docs/concept/_recipes/bridge.md b/src/content/docs/concept/_recipes/bridge.md
deleted file mode 100644
index 8f4a515db..000000000
--- a/src/content/docs/concept/_recipes/bridge.md
+++ /dev/null
@@ -1,181 +0,0 @@
----
-title: Bridge
-draft: true
----
-
-import Rater from '@theme/Rater'
-import useBaseUrl from '@docusaurus/useBaseUrl'
-
-
-
-
-
- | Ease of Use |
- |
-
-
- | Extensibility |
- |
-
-
- | Performance |
- |
-
-
- | Security |
- |
-
-
-
-
-
})
-
-
- Pros:
-
- - Highly configurable
- - No Rust skills required
-
- Cons:
-
- - Some WebAPIs unavailable
- - Challenge to implement
-
-
-
-
-## Description
-
-The Bridge recipe is a secure pattern where messages are passed between brokers via an implicit bridge using the API. It isolates functionality to the specific scope and passes messages instead of functionality.
-
-## Diagram
-
-```mermaid
-graph TD
- H==>F
- subgraph WEBVIEW
- F-.-E
- end
- D-->E
- E-->D
- B-->D
- D-->B
- subgraph RUST
- A==>H
- A-->B
- B-.-C
- B-.-G
- end
- A[Binary]
- B{Rust Broker}
- C[Subprocess 2]
- G[Subprocess 1]
- D(( API BRIDGE ))
- E{JS Broker}
- F[Window]
- H{Bootstrap}
- class D apibridge
- class RUST rust
- class WEBVIEW webview
-```
-
-## Configuration
-
-Here's what you need to add to your tauri.conf.json file:
-
-```json
-{
- "tauri": {
- "allowlist": {
- "all": false,
- "clipboard": {
- "all": false,
- "readText": false,
- "writeText": false
- },
- "dialog": {
- "all": false,
- "ask": false,
- "confirm": false,
- "message": false,
- "open": false,
- "save": false
- },
- "fs": {
- "all": false,
- "copyFile": false,
- "createDir": false,
- "readDir": false,
- "readFile": false,
- "removeDir": false,
- "removeFile": false,
- "renameFile": false,
- "scope": [],
- "writeFile": false
- },
- "globalShortcut": {
- "all": false
- },
- "http": {
- "all": false,
- "request": false,
- "scope": []
- },
- "notification": {
- "all": false
- },
- "os": {
- "all": false
- },
- "path": {
- "all": false
- },
- "process": {
- "all": false,
- "exit": false,
- "relaunch": false,
- "relaunchDangerousAllowSymlinkMacos": false
- },
- "protocol": {
- "all": false,
- "asset": false,
- "assetScope": []
- },
- "shell": {
- "all": false,
- "execute": false,
- "open": false,
- "scope": [],
- "sidecar": false
- },
- "window": {
- "all": false,
- "center": false,
- "close": false,
- "create": false,
- "hide": false,
- "maximize": false,
- "minimize": false,
- "print": false,
- "requestUserAttention": false,
- "setAlwaysOnTop": false,
- "setDecorations": false,
- "setFocus": false,
- "setFullscreen": false,
- "setIcon": false,
- "setMaxSize": false,
- "setMinSize": false,
- "setPosition": false,
- "setResizable": false,
- "setSize": false,
- "setSkipTaskbar": false,
- "setTitle": false,
- "show": false,
- "startDragging": false,
- "unmaximize": false,
- "unminimize": false
- }
- }
- }
-}
-```
diff --git a/src/content/docs/concept/_recipes/bridge.mdx b/src/content/docs/concept/_recipes/bridge.mdx
new file mode 100644
index 000000000..e41131886
--- /dev/null
+++ b/src/content/docs/concept/_recipes/bridge.mdx
@@ -0,0 +1,189 @@
+---
+title: Bridge
+draft: true
+---
+
+import Rater from '@theme/Rater';
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
+
+
+
+
+ | Ease of Use |
+
+
+ |
+
+
+ | Extensibility |
+
+
+ |
+
+
+ | Performance |
+
+
+ |
+
+
+ | Security |
+
+
+ |
+
+
+
+
+
+
+
+ Pros:
+
+ - Highly configurable
+ - No Rust skills required
+
+ Cons:
+
+ - Some WebAPIs unavailable
+ - Challenge to implement
+
+
+
+
+## Description
+
+The Bridge recipe is a secure pattern where messages are passed between brokers via an implicit bridge using the API. It isolates functionality to the specific scope and passes messages instead of functionality.
+
+## Diagram
+
+```mermaid
+graph TD
+ H==>F
+ subgraph WEBVIEW
+ F-.-E
+ end
+ D-->E
+ E-->D
+ B-->D
+ D-->B
+ subgraph RUST
+ A==>H
+ A-->B
+ B-.-C
+ B-.-G
+ end
+ A[Binary]
+ B{Rust Broker}
+ C[Subprocess 2]
+ G[Subprocess 1]
+ D(( API BRIDGE ))
+ E{JS Broker}
+ F[Window]
+ H{Bootstrap}
+ class D apibridge
+ class RUST rust
+ class WEBVIEW webview
+```
+
+## Configuration
+
+Here's what you need to add to your tauri.conf.json file:
+
+```json
+{
+ "tauri": {
+ "allowlist": {
+ "all": false,
+ "clipboard": {
+ "all": false,
+ "readText": false,
+ "writeText": false
+ },
+ "dialog": {
+ "all": false,
+ "ask": false,
+ "confirm": false,
+ "message": false,
+ "open": false,
+ "save": false
+ },
+ "fs": {
+ "all": false,
+ "copyFile": false,
+ "createDir": false,
+ "readDir": false,
+ "readFile": false,
+ "removeDir": false,
+ "removeFile": false,
+ "renameFile": false,
+ "scope": [],
+ "writeFile": false
+ },
+ "globalShortcut": {
+ "all": false
+ },
+ "http": {
+ "all": false,
+ "request": false,
+ "scope": []
+ },
+ "notification": {
+ "all": false
+ },
+ "os": {
+ "all": false
+ },
+ "path": {
+ "all": false
+ },
+ "process": {
+ "all": false,
+ "exit": false,
+ "relaunch": false,
+ "relaunchDangerousAllowSymlinkMacos": false
+ },
+ "protocol": {
+ "all": false,
+ "asset": false,
+ "assetScope": []
+ },
+ "shell": {
+ "all": false,
+ "execute": false,
+ "open": false,
+ "scope": [],
+ "sidecar": false
+ },
+ "window": {
+ "all": false,
+ "center": false,
+ "close": false,
+ "create": false,
+ "hide": false,
+ "maximize": false,
+ "minimize": false,
+ "print": false,
+ "requestUserAttention": false,
+ "setAlwaysOnTop": false,
+ "setDecorations": false,
+ "setFocus": false,
+ "setFullscreen": false,
+ "setIcon": false,
+ "setMaxSize": false,
+ "setMinSize": false,
+ "setPosition": false,
+ "setResizable": false,
+ "setSize": false,
+ "setSkipTaskbar": false,
+ "setTitle": false,
+ "show": false,
+ "startDragging": false,
+ "unmaximize": false,
+ "unminimize": false
+ }
+ }
+ }
+}
+```
diff --git a/src/content/docs/concept/_recipes/cloudbridge.md b/src/content/docs/concept/_recipes/cloudbridge.mdx
similarity index 50%
rename from src/content/docs/concept/_recipes/cloudbridge.md
rename to src/content/docs/concept/_recipes/cloudbridge.mdx
index 4afce6b11..6fa9435a9 100644
--- a/src/content/docs/concept/_recipes/cloudbridge.md
+++ b/src/content/docs/concept/_recipes/cloudbridge.mdx
@@ -3,45 +3,53 @@ title: Cloudbridge
draft: true
---
-import Rater from '@theme/Rater'
-import useBaseUrl from '@docusaurus/useBaseUrl'
+import Rater from '@theme/Rater';
+import useBaseUrl from '@docusaurus/useBaseUrl';
-
-
-
- | Ease of Use |
- |
-
-
- | Extensibility |
- |
-
-
- | Performance |
- |
-
-
- | Security |
- |
-
-
-
-
-
})
-
-
- Pros:
-
- - All available features
- - No Rust skills required
-
- Cons:
-
- - Largest bundle size
- - Hard to separate concerns
-
-
+
+
+
+ | Ease of Use |
+
+
+ |
+
+
+ | Extensibility |
+
+
+ |
+
+
+ | Performance |
+
+
+ |
+
+
+ | Security |
+
+
+ |
+
+
+
+
+
+
+
+ Pros:
+
+ - All available features
+ - No Rust skills required
+
+ Cons:
+
+ - Largest bundle size
+ - Hard to separate concerns
+
+
## Description
diff --git a/src/content/docs/concept/_recipes/cloudish.md b/src/content/docs/concept/_recipes/cloudish.mdx
similarity index 50%
rename from src/content/docs/concept/_recipes/cloudish.md
rename to src/content/docs/concept/_recipes/cloudish.mdx
index 62e5f8709..b2e170c78 100644
--- a/src/content/docs/concept/_recipes/cloudish.md
+++ b/src/content/docs/concept/_recipes/cloudish.mdx
@@ -3,45 +3,53 @@ title: Cloudish
draft: true
---
-import Rater from '@theme/Rater'
-import useBaseUrl from '@docusaurus/useBaseUrl'
+import Rater from '@theme/Rater';
+import useBaseUrl from '@docusaurus/useBaseUrl';
-
-
-
- | Ease of Use |
- |
-
-
- | Extensibility |
- |
-
-
- | Performance |
- |
-
-
- | Security |
- |
-
-
-
-
-
})
-
-
- Pros:
-
- - Similar to a SPA web-app
- - No Rust skills required
-
- Cons:
-
- - No access to Rust API
- - Uses a localhost server
-
-
+
+
+
+ | Ease of Use |
+
+
+ |
+
+
+ | Extensibility |
+
+
+ |
+
+
+ | Performance |
+
+
+ |
+
+
+ | Security |
+
+
+ |
+
+
+
+
+
+
+
+ Pros:
+
+ - Similar to a SPA web-app
+ - No Rust skills required
+
+ Cons:
+
+ - No access to Rust API
+ - Uses a localhost server
+
+
## Description
diff --git a/src/content/docs/concept/_recipes/glui.md b/src/content/docs/concept/_recipes/glui.mdx
similarity index 53%
rename from src/content/docs/concept/_recipes/glui.md
rename to src/content/docs/concept/_recipes/glui.mdx
index ba3260176..c656d08e6 100644
--- a/src/content/docs/concept/_recipes/glui.md
+++ b/src/content/docs/concept/_recipes/glui.mdx
@@ -3,49 +3,57 @@ title: GLUI
draft: true
---
-import useBaseUrl from '@docusaurus/useBaseUrl'
+import useBaseUrl from '@docusaurus/useBaseUrl';
:::warning
This pattern is not available for now.
:::
-import Rater from '@theme/Rater'
+import Rater from '@theme/Rater';
-
-
-
- | Ease of Use |
- |
-
-
- | Extensibility |
- |
-
-
- | Performance |
- |
-
-
- | Security |
- |
-
-
-
-
-
})
-
-
- Pros:
-
- - Framebuffer FTW
- - Window events rigged
-
- Cons:
-
- - Broken on your machine
-
-
+
+
+
+ | Ease of Use |
+
+
+ |
+
+
+ | Extensibility |
+
+
+ |
+
+
+ | Performance |
+
+
+ |
+
+
+ | Security |
+
+
+ |
+
+
+
+
+
+
+
+ Pros:
+
+ - Framebuffer FTW
+ - Window events rigged
+
+ Cons:
+
+ - Broken on your machine
+
+
## Description
diff --git a/src/content/docs/concept/_recipes/hermit.md b/src/content/docs/concept/_recipes/hermit.mdx
similarity index 51%
rename from src/content/docs/concept/_recipes/hermit.md
rename to src/content/docs/concept/_recipes/hermit.mdx
index 252534b7d..fb1eb6afb 100644
--- a/src/content/docs/concept/_recipes/hermit.md
+++ b/src/content/docs/concept/_recipes/hermit.mdx
@@ -3,45 +3,53 @@ title: Hermit
draft: true
---
-import Rater from '@theme/Rater'
-import useBaseUrl from '@docusaurus/useBaseUrl'
+import Rater from '@theme/Rater';
+import useBaseUrl from '@docusaurus/useBaseUrl';
-
-
-
- | Ease of Use |
- |
-
-
- | Extensibility |
- |
-
-
- | Performance |
- |
-
-
- | Security |
- |
-
-
-
-
-
})
-
-
- Pros:
-
- - Quick to make
- - Smallest size
-
- Cons:
-
- - No remote resources
- - No access to API
-
-
+
+
+
+ | Ease of Use |
+
+
+ |
+
+
+ | Extensibility |
+
+
+ |
+
+
+ | Performance |
+
+
+ |
+
+
+ | Security |
+
+
+ |
+
+
+
+
+
+
+
+ Pros:
+
+ - Quick to make
+ - Smallest size
+
+ Cons:
+
+ - No remote resources
+ - No access to API
+
+
## Description
diff --git a/src/content/docs/concept/_recipes/lockdown.md b/src/content/docs/concept/_recipes/lockdown.md
deleted file mode 100644
index 6c6d4fec3..000000000
--- a/src/content/docs/concept/_recipes/lockdown.md
+++ /dev/null
@@ -1,82 +0,0 @@
----
-title: Lockdown
-draft: true
----
-
-import Rater from '@theme/Rater'
-import useBaseUrl from '@docusaurus/useBaseUrl'
-
-
-
-
-
- | Ease of Use |
- |
-
-
- | Extensibility |
- |
-
-
- | Performance |
- |
-
-
- | Security |
- |
-
-
-
-
-
})
-
-
- Pros:
-
- - Highest security rating
- - Elegant and powerful
-
- Cons:
-
- - Rust skills required
- - No remote resources
-
-
-
-
-## Description
-
-The Lockdown recipe is a minimal usage of the [Bridge pattern](./bridge), which only allows interaction between Rust and the Window via expiring JS Promise Closures that are injected into the Window by Rust and nulled as part of the callback.
-
-## Diagram
-
-```mermaid
-graph TD
- H==>F
- G-.->B
- B-->G
- subgraph WEBVIEW
- G-->F
- end
- subgraph RUST
- A-->B
- A==>H
- end
- A[Binary]
- B[API:Event]
- F[Window]
- G((Promise Closure))
- H{Bootstrap}
- class RUST rust
- class WEBVIEW webview
-```
-
-## Configuration
-
-Here's what you need to add to your tauri.conf.json file:
-
-```json
-"tauri": {
- "allowlist": {} // all API endpoints are default false
-}
-```
diff --git a/src/content/docs/concept/_recipes/lockdown.mdx b/src/content/docs/concept/_recipes/lockdown.mdx
new file mode 100644
index 000000000..8ab6f3f4b
--- /dev/null
+++ b/src/content/docs/concept/_recipes/lockdown.mdx
@@ -0,0 +1,90 @@
+---
+title: Lockdown
+draft: true
+---
+
+import Rater from '@theme/Rater';
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
+
+
+
+
+ | Ease of Use |
+
+
+ |
+
+
+ | Extensibility |
+
+
+ |
+
+
+ | Performance |
+
+
+ |
+
+
+ | Security |
+
+
+ |
+
+
+
+
+
+
+
+ Pros:
+
+ - Highest security rating
+ - Elegant and powerful
+
+ Cons:
+
+ - Rust skills required
+ - No remote resources
+
+
+
+
+## Description
+
+The Lockdown recipe is a minimal usage of the [Bridge pattern](./bridge), which only allows interaction between Rust and the Window via expiring JS Promise Closures that are injected into the Window by Rust and nulled as part of the callback.
+
+## Diagram
+
+```mermaid
+graph TD
+ H==>F
+ G-.->B
+ B-->G
+ subgraph WEBVIEW
+ G-->F
+ end
+ subgraph RUST
+ A-->B
+ A==>H
+ end
+ A[Binary]
+ B[API:Event]
+ F[Window]
+ G((Promise Closure))
+ H{Bootstrap}
+ class RUST rust
+ class WEBVIEW webview
+```
+
+## Configuration
+
+Here's what you need to add to your tauri.conf.json file:
+
+```json
+"tauri": {
+ "allowlist": {} // all API endpoints are default false
+}
+```
diff --git a/src/content/docs/concept/_recipes/multiwin.md b/src/content/docs/concept/_recipes/multiwin.md
deleted file mode 100644
index 4d98562d8..000000000
--- a/src/content/docs/concept/_recipes/multiwin.md
+++ /dev/null
@@ -1,91 +0,0 @@
----
-title: Multiwin
-draft: true
----
-
-import useBaseUrl from '@docusaurus/useBaseUrl'
-import Rater from '@theme/Rater'
-
-
-
-
-
- | Ease of Use |
- |
-
-
- | Extensibility |
- |
-
-
- | Performance |
- |
-
-
- | Security |
- |
-
-
-
-
-
})
-
-
- Pros:
-
- - Windows can be spawned or destroyed at runtime
- - Separation of concerns
-
- Cons:
-
-
-
-
-## Description
-
-The Multiwin recipe will allow you to have multiple windows.
-
-## Diagram
-
-```mermaid
-graph LR
- A==>H
- H==>F
- H==>G
- subgraph WEBVIEW
- F
- end
- subgraph WINIT
- G
- end
- subgraph RUST
- A
- end
- A[Binary]
- F[Window]
- G[Window]
- H{Bootstrap}
- class WINIT other
- class RUST rust
- class WEBVIEW webview
-```
-
-## Configuration
-
-Here's what you need to add to your tauri.conf.json file:
-
-```json
-"tauri": {
- "allowlist": {}, // all API endpoints are default false
- "windows": [{
- "title": "Window1",
- "label": "main",
- }, {
- "title": "Splash",
- "label": "splashscreen"
- }]
-}
-
-```
diff --git a/src/content/docs/concept/_recipes/multiwin.mdx b/src/content/docs/concept/_recipes/multiwin.mdx
new file mode 100644
index 000000000..98744af46
--- /dev/null
+++ b/src/content/docs/concept/_recipes/multiwin.mdx
@@ -0,0 +1,99 @@
+---
+title: Multiwin
+draft: true
+---
+
+import useBaseUrl from '@docusaurus/useBaseUrl';
+import Rater from '@theme/Rater';
+
+
+
+
+
+ | Ease of Use |
+
+
+ |
+
+
+ | Extensibility |
+
+
+ |
+
+
+ | Performance |
+
+
+ |
+
+
+ | Security |
+
+
+ |
+
+
+
+
+
+
+
+ Pros:
+
+ - Windows can be spawned or destroyed at runtime
+ - Separation of concerns
+
+ Cons:
+
+
+
+
+## Description
+
+The Multiwin recipe will allow you to have multiple windows.
+
+## Diagram
+
+```mermaid
+graph LR
+ A==>H
+ H==>F
+ H==>G
+ subgraph WEBVIEW
+ F
+ end
+ subgraph WINIT
+ G
+ end
+ subgraph RUST
+ A
+ end
+ A[Binary]
+ F[Window]
+ G[Window]
+ H{Bootstrap}
+ class WINIT other
+ class RUST rust
+ class WEBVIEW webview
+```
+
+## Configuration
+
+Here's what you need to add to your tauri.conf.json file:
+
+```json
+"tauri": {
+ "allowlist": {}, // all API endpoints are default false
+ "windows": [{
+ "title": "Window1",
+ "label": "main",
+ }, {
+ "title": "Splash",
+ "label": "splashscreen"
+ }]
+}
+
+```
diff --git a/src/content/docs/concept/index.mdx b/src/content/docs/concept/index.mdx
index e376d47ca..2464e1f23 100644
--- a/src/content/docs/concept/index.mdx
+++ b/src/content/docs/concept/index.mdx
@@ -23,22 +23,22 @@ Tauri has a variety of topics that are considered to be core concepts, things an
href="/concept/inter-process-communication/"
description="The inner workings on the IPC."
/>
-
-
-
+
-
@@ -48,7 +49,8 @@ panic = "abort" # Higher performance by disabling panic handlers.
strip = true # Ensures debug symbols are removed.
trim-paths = "all" # Removes potentially privileged information from your binaries.
rustflags = ["-Cdebuginfo=0", "-Zthreads=8"] # Better compile performance.
-```
+````
+
diff --git a/src/content/docs/develop/Debug/intellij.mdx b/src/content/docs/develop/Debug/intellij.mdx
index c18ca17f3..2c34dc9b1 100644
--- a/src/content/docs/develop/Debug/intellij.mdx
+++ b/src/content/docs/develop/Debug/intellij.mdx
@@ -6,10 +6,10 @@ sidebar:
variant: caution
---
-{ /* TODO: REVISE COPY TO V2 */}
-{ /* TODO: Update links and internal navigation */}
-{ /* TODO: Add support to light/dark mode images */}
-{ /* TODO: Revise this change: Debugging in CLion > Debug in CLion */}
+{/* TODO: REVISE COPY TO V2 */}
+{/* TODO: Update links and internal navigation */}
+{/* TODO: Add support to light/dark mode images */}
+{/* TODO: Revise this change: Debugging in CLion > Debug in CLion */}
In this guide, we'll be setting up IntelliJ CLion for debugging the [Core Process of your Tauri app](/concept/process-model/#the-core-process).
@@ -33,17 +33,17 @@ Before you proceed, make sure that your project is fully loaded. If the indexing
We will set up a Run/Debug configuration that we can use to launch our Tauri app in debugging mode. To create a configuration, go to Edit Configurations, click **+**, and then select Cargo Command.
-{ /*  */}
+{/*  */}
With that created we need to configure CLion so it instructs Cargo to build our app without any default features. This will tell Tauri to use your development server instead of reading assets from disk. Normally this flag is passed by the Tauri CLI, but since we're completely sidestepping that here, we need to pass the flag manually.
-{ /*  */}
+{/*  */}
Now we can optionally rename the Run/Debug Configuration to something more memorable, in this example we called it "Run Tauri App", but you can name it whatever you want.
-{ /*  */}
+{/*  */}
:::caution
diff --git a/src/content/docs/develop/Debug/rustrover.mdx b/src/content/docs/develop/Debug/rustrover.mdx
index cd5b00511..0f3a6ad62 100644
--- a/src/content/docs/develop/Debug/rustrover.mdx
+++ b/src/content/docs/develop/Debug/rustrover.mdx
@@ -6,8 +6,8 @@ sidebar:
variant: caution
---
-{ /* TODO: Update links and internal navigation */}
-{ /* TODO: Add support to light/dark mode images */}
+{/* TODO: Update links and internal navigation */}
+{/* TODO: Add support to light/dark mode images */}
In this guide, we'll be setting up JetBrains RustRover for debugging the [Core Process of your Tauri app](/concept/process-model/#the-core-process).
@@ -29,27 +29,29 @@ Before you proceed, make sure that your project is fully loaded. If the Cargo to
## Setting up Run Configurations
You will need to set up two separate Run/Debug configurations:
-* one for launching the Tauri app in debugging mode,
-* another one for running your frontend development server of choice.
+
+- one for launching the Tauri app in debugging mode,
+- another one for running your frontend development server of choice.
### Tauri App
1. In the main menu, go to **Run | Edit Configurations**.
2. In the **Run/Debug Configurations** dialog:
-* To create a new configuration, click **+** on the toolbar and select **Cargo**.
+
+- To create a new configuration, click **+** on the toolbar and select **Cargo**.
-{ /*  */}
+{/*  */}
With that created, we need to configure RustRover, so it instructs Cargo to build our app without any default features. This will tell Tauri to use your development server instead of reading assets from the disk. Normally this flag is passed by the Tauri CLI, but since we're completely sidestepping that here, we need to pass the flag manually.
-{ /*  */}
+{/*  */}
Now we can optionally rename the Run/Debug Configuration to something more memorable, in this example we called it "Run Tauri App", but you can name it whatever you want.
-{ /*  */}
+{/*  */}
### Development Server
@@ -64,22 +66,21 @@ To create the corresponding Run configuration, you need to check the actual deve
For `npm`, `pnpm`, or `yarn`, you could use the **npm** Run Configuration, for example:
-{ /*  */}
+{/*  */}
Make sure you have the correct values in the **Command**, **Scripts**, and **Package Manager** fields.
If your development server is `trunk` for Rust-based WebAssembly frontend frameworks, you could use the generic **Shell Script** Run Configuration:
-{ /*  */}
-
+{/*  */}
## Launching a Debugging Session
To launch a debugging session, you first need to run your development server, and then start debugging the Tauri App by clicking the **Debug** button next to the Run Configurations Switcher. RustRover will automatically recognize breakpoints placed in any Rust file in your project and stop on the first one hit.
-{ /*  */}
+{/*  */}
From this point, you can explore the values of your variables, step further into the code, and check what's going at runtime in detail.
diff --git a/src/content/docs/develop/Plugins/develop-mobile.mdx b/src/content/docs/develop/Plugins/develop-mobile.mdx
index 0802be3d8..1da6e6ec7 100644
--- a/src/content/docs/develop/Plugins/develop-mobile.mdx
+++ b/src/content/docs/develop/Plugins/develop-mobile.mdx
@@ -338,7 +338,7 @@ class ExamplePlugin: Plugin {
Tauri automatically implements two commands for the plugin: `checkPermissions` and `requestPermissions`. Those commands can be directly called from JavaScript or Rust:
-{ /* TODO: PermissionState type should be exported in Tauri */}
+{/* TODO: PermissionState type should be exported in Tauri */}
@@ -405,7 +405,7 @@ impl Notification {
## Plugin Events
-{ /* TODO: Is this section a duplicate of Lifecycle Events above? */}
+{/* TODO: Is this section a duplicate of Lifecycle Events above? */}
Plugins can emit events at any point of time using the `trigger` function:
diff --git a/src/content/docs/develop/Plugins/index.mdx b/src/content/docs/develop/Plugins/index.mdx
index 095479fa8..2f58d5743 100644
--- a/src/content/docs/develop/Plugins/index.mdx
+++ b/src/content/docs/develop/Plugins/index.mdx
@@ -6,11 +6,11 @@ sidebar:
order: 10
---
-{ /* TODO: Add a CLI section */}
+{/* TODO: Add a CLI section */}
import CommandTabs from '@components/CommandTabs.astro';
-{ /* TODO: Link to windowing system, commands for sending messages, and event system */}
+{/* TODO: Link to windowing system, commands for sending messages, and event system */}
:::tip[Plugin Development]
@@ -24,11 +24,11 @@ Tauri offers a windowing system with web view functionality, a way to send messa
A Tauri plugin is composed of a Cargo crate and an optional NPM package that provides API bindings for its commands and events. Additionally, a plugin project can include an Android library project and a Swift package for iOS. You can learn more about developing plugins for Android and iOS in the [Mobile Plugin Development guide](/develop/plugins/develop-mobile/).
-{ /* TODO: https://github.com/tauri-apps/tauri/issues/7749 */}
+{/* TODO: https://github.com/tauri-apps/tauri/issues/7749 */}
## Naming Convention
-{ /* TODO: Add link to allowlist */}
+{/* TODO: Add link to allowlist */}
Tauri plugins have a prefix (`tauri-plugin-` prefix for the Rust crate name and `@tauri-apps/plugin-` for the NPM package) followed by the plugin name. The plugin name is specified on the plugin configuration under [`tauri.conf.json > plugin`](/reference/config/#pluginconfig) and on the allowlist configuration.
diff --git a/src/content/docs/develop/Tests/WebDriver/index.mdx b/src/content/docs/develop/Tests/WebDriver/index.mdx
index 53d91cd6f..3a6159151 100644
--- a/src/content/docs/develop/Tests/WebDriver/index.mdx
+++ b/src/content/docs/develop/Tests/WebDriver/index.mdx
@@ -9,7 +9,7 @@ sidebar:
variant: caution
---
-{ /* TODO: REVISE COPY TO V2 */}
+{/* TODO: REVISE COPY TO V2 */}
:::caution[Currently in pre-alpha]
@@ -61,18 +61,24 @@ import { LinkCard, CardGrid } from '@astrojs/starlight/components';
-
+ title="Selenium"
+ href="/start/develop/tests/webdriver/example/selenium"
+ />
+
## Continuous Integration (CI)
The above examples also comes with a CI script to test with GitHub actions, but you may still be interested in the below WebDriver CI guide as it explains the concept a bit more.
-
+
[webdriver]: https://www.w3.org/TR/webdriver/
[`tauri-driver`]: https://crates.io/crates/tauri-driver
diff --git a/src/content/docs/develop/sidecar.mdx b/src/content/docs/develop/sidecar.mdx
index 81eefb49e..92555a8b9 100644
--- a/src/content/docs/develop/sidecar.mdx
+++ b/src/content/docs/develop/sidecar.mdx
@@ -7,7 +7,7 @@ sidebar:
variant: caution
---
-You may need to embed external binaries to add additional functionality to your application or prevent users from installing additional dependencies (e.g., Node.js or Python). We call this binary a `sidecar`.
+You may need to embed external binaries to add additional functionality to your application or prevent users from installing additional dependencies (e.g., Node.js or Python). We call this binary a `sidecar`.
Binaries are executables written in any programming language. Common use cases are Python CLI applications or API servers bundled using `pyinstaller`.
@@ -17,15 +17,15 @@ Here is a sample to illustrate the configuration. This is not a complete `tauri.
```json title="src-tauri/tauri.conf.json"
{
- "tauri": {
- "bundle": {
- "externalBin": [
- "/absolute/path/to/sidecar",
- "relative/path/to/binary",
- "binaries/my-sidecar"
- ]
- }
- }
+ "tauri": {
+ "bundle": {
+ "externalBin": [
+ "/absolute/path/to/sidecar",
+ "relative/path/to/binary",
+ "binaries/my-sidecar"
+ ]
+ }
+ }
}
```
@@ -54,29 +54,29 @@ rustc -Vv | Select-String "host:" | ForEach-Object {$_.Line.split(" ")[1]}
Here's a Node.js script to append the target triple to a binary:
```javascript
-const execa = require('execa')
-const fs = require('fs')
+const execa = require('execa');
+const fs = require('fs');
-let extension = ''
+let extension = '';
if (process.platform === 'win32') {
- extension = '.exe'
+ extension = '.exe';
}
async function main() {
- const rustInfo = (await execa('rustc', ['-vV'])).stdout
- const targetTriple = /host: (\S+)/g.exec(rustInfo)[1]
- if (!targetTriple) {
- console.error('Failed to determine platform target triple')
- }
- fs.renameSync(
- `src-tauri/binaries/sidecar${extension}`,
- `src-tauri/binaries/sidecar-${targetTriple}${extension}`
- )
+ const rustInfo = (await execa('rustc', ['-vV'])).stdout;
+ const targetTriple = /host: (\S+)/g.exec(rustInfo)[1];
+ if (!targetTriple) {
+ console.error('Failed to determine platform target triple');
+ }
+ fs.renameSync(
+ `src-tauri/binaries/sidecar${extension}`,
+ `src-tauri/binaries/sidecar-${targetTriple}${extension}`
+ );
}
main().catch((e) => {
- throw e
-})
+ throw e;
+});
```
## Running it from Rust
@@ -116,8 +116,8 @@ In the JavaScript code, import the `Command` class from the `@tauri-apps/plugin-
```javascript
import { Command } from '@tauri-apps/plugin-shell';
// `binaries/my-sidecar` is the EXACT value specified on `tauri.conf.json > tauri > bundle > externalBin`
-const sidecar_command = Command.sidecar('binaries/my-sidecar')
-const output = await sidecar_command.execute()
+const sidecar_command = Command.sidecar('binaries/my-sidecar');
+const output = await sidecar_command.execute();
```
## Passing arguments
@@ -130,38 +130,38 @@ First, define the arguments that need to be passed to the sidecar command in `sr
```json title="src-tauri/capabilities/main.json" ins={14-31}
{
- "$schema": "../gen/schemas/desktop-schema.json",
- "identifier": "default",
- "description": "Capability for the main window",
- "windows": ["main"],
- "permissions": [
- "path:default",
- "event:default",
- "window:default",
- "app:default",
- "resources:default",
- "menu:default",
- "tray:default",
- {
- "identifier": "shell:allow-execute",
- "allow": [
- {
- "args": [
- "arg1",
- "-a",
- "--arg2",
- {
- "validator": "\\S+"
- },
- ],
- "cmd": "",
- "name": "binaries/my-sidecar",
- "sidecar": true
- }
- ]
- },
- "shell:allow-open"
- ]
+ "$schema": "../gen/schemas/desktop-schema.json",
+ "identifier": "default",
+ "description": "Capability for the main window",
+ "windows": ["main"],
+ "permissions": [
+ "path:default",
+ "event:default",
+ "window:default",
+ "app:default",
+ "resources:default",
+ "menu:default",
+ "tray:default",
+ {
+ "identifier": "shell:allow-execute",
+ "allow": [
+ {
+ "args": [
+ "arg1",
+ "-a",
+ "--arg2",
+ {
+ "validator": "\\S+"
+ }
+ ],
+ "cmd": "",
+ "name": "binaries/my-sidecar",
+ "sidecar": true
+ }
+ ]
+ },
+ "shell:allow-open"
+ ]
}
```
@@ -192,26 +192,21 @@ import { Command } from '@tauri-apps/plugin-shell';
// `binaries/my-sidecar` is the EXACT value specified on `tauri.conf.json > tauri > bundle > externalBin`
// notice that the args array matches EXACTLY what is specified on `tauri.conf.json`.
const command = Command.sidecar('binaries/my-sidecar', [
- 'arg1',
- '-a',
- '--arg2',
- 'any-string-that-matches-the-validator',
-])
-const output = await command.execute()
+ 'arg1',
+ '-a',
+ '--arg2',
+ 'any-string-that-matches-the-validator',
+]);
+const output = await command.execute();
```
-
:::note
-Example: For a set of arguments like: `-i /path/to/input.png -o /path/to/output.txt`, the arguments array would look like –
+Example: For a set of arguments like: `-i /path/to/input.png -o /path/to/output.txt`, the arguments array would look like –
+
```json
-[
- "-i",
- {"validator": "\\S+"},
- "-o",
- {"validator": "\\S+"}
-]
-```
+["-i", { "validator": "\\S+" }, "-o", { "validator": "\\S+" }]
+```
Here, the first and third arguments are static (`-i` and `-o`), but the second and fourth are dynamic and match the regex pattern described (`\\S+` means anything except space).
diff --git a/src/content/docs/es/plugin/dialog.mdx b/src/content/docs/es/plugin/dialog.mdx
index 01a15a1c2..384bf8b83 100644
--- a/src/content/docs/es/plugin/dialog.mdx
+++ b/src/content/docs/es/plugin/dialog.mdx
@@ -82,7 +82,7 @@ en Rust:
Consulta todas las [Opciones de diálogo](/reference/javascript/dialog/) en la referencia de la API de JavaScript.
-{ /* ASK */}
+{/* ASK */}
#### Crear un diálogo de Si/No
@@ -101,7 +101,7 @@ console.log(answer);
// Imprime un booleano en la consola
```
-{ /* CONFIRM */}
+{/* CONFIRM */}
#### Crear un diálogo de Ok/Cancelar
@@ -120,7 +120,7 @@ console.log(confirmation);
// Imprime un booleano en la consola
```
-{ /* MESSAGE */}
+{/* MESSAGE */}
#### Crear un diálogo de mensaje
@@ -133,7 +133,7 @@ import { message } from '@tauri-apps/plugin-dialog';
await message('File not found', { title: 'Tauri', type: 'error' });
```
-{ /* OPEN */}
+{/* OPEN */}
#### Abrir un diálogo de selección de archivos
@@ -153,7 +153,7 @@ console.log(file);
// Imprime la ruta y el nombre del archivo en la consola
```
-{ /* SAVE */}
+{/* SAVE */}
#### Diálogo de guardar en archivo
diff --git a/src/content/docs/es/start/frontend/index.mdx b/src/content/docs/es/start/frontend/index.mdx
index 4321caf0b..55e4cce91 100644
--- a/src/content/docs/es/start/frontend/index.mdx
+++ b/src/content/docs/es/start/frontend/index.mdx
@@ -41,9 +41,9 @@ Conceptualmente Tauri desempeña el rol de un servidor web estático. Necesitas
Debajo puedes consultar una checklist de escenarios comunes al integrar un frontend con Tauri:
-{ /* TODO: Link to core concept of SSG/SSR, etc. */}
-{ /* TODO: Link to mobile development server guide */}
-{ /* TODO: Concept of how to do a client-server relationship? */}
+{/* TODO: Link to core concept of SSG/SSR, etc. */}
+{/* TODO: Link to mobile development server guide */}
+{/* TODO: Concept of how to do a client-server relationship? */}
- Usa la generación de sitios estáticos (SSG). Tauri no soporta alternativas basadas en servidores de manera oficial (como SSR).
- Para el desarrollo de apps móviles, es necesario un servidor de desarrollo de algun tipo para servir el frontend desde tu IP interna.
diff --git a/src/content/docs/es/start/frontend/nuxt.mdx b/src/content/docs/es/start/frontend/nuxt.mdx
index 4914b7c21..fb02d4eb3 100644
--- a/src/content/docs/es/start/frontend/nuxt.mdx
+++ b/src/content/docs/es/start/frontend/nuxt.mdx
@@ -21,7 +21,7 @@ Aprende más sobre Nuxt en https://nuxt.com. Esta guía es precisa a partir de N
-
+
```json
// tauri.conf.json
{
@@ -33,10 +33,10 @@ Aprende más sobre Nuxt en https://nuxt.com. Esta guía es precisa a partir de N
}
}
```
-
-
-
-
+
+
+
+
```json
// tauri.conf.json
{
@@ -48,10 +48,10 @@ Aprende más sobre Nuxt en https://nuxt.com. Esta guía es precisa a partir de N
}
}
```
-
-
-
-
+
+
+
+
```json
// tauri.conf.json
{
@@ -63,8 +63,9 @@ Aprende más sobre Nuxt en https://nuxt.com. Esta guía es precisa a partir de N
}
}
```
-
-
+
+
+
2. Actualiza la configuración de Nuxt:
diff --git a/src/content/docs/es/start/prerequisites.mdx b/src/content/docs/es/start/prerequisites.mdx
index b33a30ef4..bb51fa97d 100644
--- a/src/content/docs/es/start/prerequisites.mdx
+++ b/src/content/docs/es/start/prerequisites.mdx
@@ -23,8 +23,8 @@ Sigue el enlace para comenzar según tu sistema operativo:
Tauri requiere varias dependencias del sistema para el desarrollo en Linux. Estas pueden ser diferentes dependiendo de su distribución, pero hemos incluido algunas distribuciones populares a continuación para ayudarlo a configurar.
-{ /* Note: These are the officially supported linux distributions. */}
-{ /* If you wish to add another please open an issue to discuss prior to opening a PR */}
+{/* Note: These are the officially supported linux distributions. */}
+{/* If you wish to add another please open an issue to discuss prior to opening a PR */}
@@ -183,8 +183,8 @@ Aquí está el archivo como un script plano: [rustup.sh](https://sh.rustup.rs/)
-
- Visita https://www.rust-lang.org/tools/install para instalar `rustup`.
+
+Visita https://www.rust-lang.org/tools/install para instalar `rustup`.
@@ -205,7 +205,7 @@ Si deseas compilar tu aplicación para Android o iOS, entonces hay algunas depen
1. Descarga e instala [Android Studio desde el sitio web de Android Developers](https://developer.android.com/studio)
2. Establece la variable de entorno `JAVA_HOME`:
-{ /* TODO: Can this be done in the 4th step? */}
+{/* TODO: Can this be done in the 4th step? */}
@@ -240,7 +240,7 @@ export JAVA_HOME="/Applications/Android Studio.app/Contents/jbr/Contents/Home"
4. Establece las variables de entorno `ANDROID_HOME` y `NDK_HOME`. Reemplaza los números de versión para que coincidan con la versión instalada.
-{ /* TODO: Does the version number change below? */}
+{/* TODO: Does the version number change below? */}
@@ -261,7 +261,7 @@ export NDK_HOME="$ANDROID_HOME/ndk/25.0.8775105"
-{ /* TODO: Do we need a note about this version? */}
+{/* TODO: Do we need a note about this version? */}
```ps
[System.Environment]::SetEnvironmentVariable("ANDROID_HOME", "$env:LocalAppData\Android\Sdk", "User")
@@ -283,10 +283,10 @@ rustup target add aarch64-linux-android armv7-linux-androideabi i686-linux-andro
-
- ```ps
- rustup target add aarch64-linux-android armv7-linux-androideabi i686-linux-android x86_64-linux-android
- ```
+
+```ps
+rustup target add aarch64-linux-android armv7-linux-androideabi i686-linux-android x86_64-linux-android
+```
diff --git a/src/content/docs/fr/develop/Debug/index.mdx b/src/content/docs/fr/develop/Debug/index.mdx
index dce0f78d3..c72fd787d 100644
--- a/src/content/docs/fr/develop/Debug/index.mdx
+++ b/src/content/docs/fr/develop/Debug/index.mdx
@@ -11,5 +11,8 @@ import { LinkCard, CardGrid } from '@astrojs/starlight/components';
href="/fr/develop/Debug/application//"
/>
-
+
diff --git a/src/content/docs/fr/start/frontend/index.mdx b/src/content/docs/fr/start/frontend/index.mdx
index 752862d98..c710b9cb1 100644
--- a/src/content/docs/fr/start/frontend/index.mdx
+++ b/src/content/docs/fr/start/frontend/index.mdx
@@ -42,9 +42,9 @@ Théoriquement, Tauri agit comme un hôte web statique. Vous avez besoin de four
Ci-dessous se trouve une liste des scénarios communs nécessaires pour intégrer un frontend avec Tauri :
-{ /* TODO: Link to core concept of SSG/SSR, etc. */}
-{ /* TODO: Link to mobile development server guide */}
-{ /* TODO: Concept of how to do a client-server relationship? */}
+{/* TODO: Link to core concept of SSG/SSR, etc. */}
+{/* TODO: Link to mobile development server guide */}
+{/* TODO: Concept of how to do a client-server relationship? */}
- Utilisez la génération statique de site (SSG). Tauri ne supporte pas officiellent les solutions basées sur serveur (par exemple SSR).
- Pour le développement mobile, un serveur de développement d'un certain type est nécessaire pour héberger le frontend sur votre IP locale.
diff --git a/src/content/docs/fr/start/frontend/nuxt.mdx b/src/content/docs/fr/start/frontend/nuxt.mdx
index 789d8c175..fc73603ec 100644
--- a/src/content/docs/fr/start/frontend/nuxt.mdx
+++ b/src/content/docs/fr/start/frontend/nuxt.mdx
@@ -21,7 +21,7 @@ Apprenez-en plus au sujet de Nuxt sur https://nuxt.com. Ce guide est valable à
-
+
```json
// tauri.conf.json
{
@@ -33,10 +33,10 @@ Apprenez-en plus au sujet de Nuxt sur https://nuxt.com. Ce guide est valable à
}
}
```
-
-
-
-
+
+
+
+
```json
// tauri.conf.json
{
@@ -48,10 +48,10 @@ Apprenez-en plus au sujet de Nuxt sur https://nuxt.com. Ce guide est valable à
}
}
```
-
-
-
-
+
+
+
+
```json
// tauri.conf.json
{
@@ -63,8 +63,9 @@ Apprenez-en plus au sujet de Nuxt sur https://nuxt.com. Ce guide est valable à
}
}
```
-
-
+
+
+
2. Mettez à jour la configuration de Nuxt :
diff --git a/src/content/docs/fr/start/prerequisites.mdx b/src/content/docs/fr/start/prerequisites.mdx
index 713ce51ed..c5fe6ba4c 100644
--- a/src/content/docs/fr/start/prerequisites.mdx
+++ b/src/content/docs/fr/start/prerequisites.mdx
@@ -23,8 +23,8 @@ Suivez les liens pour votre système d'exploitation:
Tauri exige un système varié de dépendances pour le développement sur Linux. Celles-ci peuvent être différentes selon votre distribution, mais nous avons inclus quelques distributions populaires ci-dessous pour vous aider durant l'installation.
-{ /* Note: These are the officially supported linux distributions. */}
-{ /* If you wish to add another please open an issue to discuss prior to opening a PR */}
+{/* Note: These are the officially supported linux distributions. */}
+{/* If you wish to add another please open an issue to discuss prior to opening a PR */}
@@ -186,8 +186,8 @@ Voici le fichier contenant le script: [rustup.sh](https://sh.rustup.rs/)
-
- Visitez https://www.rust-lang.org/tools/install pour installer `rustup`.
+
+Visitez https://www.rust-lang.org/tools/install pour installer `rustup`.
@@ -208,7 +208,7 @@ Si vous vouler que votre application soit utilisable sur Android et iOS, il faut
1. Téléchargez et installez [Android Studio à partir du site Android Developers](https://developer.android.com/studio)
2. Configurez la variable d'environement `JAVA_HOME`:
-{ /* TODO: Can this be done in the 4th step? */}
+{/* TODO: Can this be done in the 4th step? */}
@@ -243,7 +243,7 @@ export JAVA_HOME="/Applications/Android Studio.app/Contents/jbr/Contents/Home"
4. Configurez les variables d'environemment `ANDROID_HOME` et `NDK_HOME`
-{ /* TODO: Does the version number change below? */}
+{/* TODO: Does the version number change below? */}
@@ -256,7 +256,7 @@ export NDK_HOME="$ANDROID_HOME/ndk/25.0.8775105"
-{ /* TODO: Do we need a note about this version? */}
+{/* TODO: Do we need a note about this version? */}
```ps
[System.Environment]::SetEnvironmentVariable("ANDROID_HOME", "$env:LocalAppData\Android\Sdk", "User")
@@ -278,10 +278,10 @@ rustup target add aarch64-linux-android armv7-linux-androideabi i686-linux-andro
-
- ```ps
- rustup target add aarch64-linux-android armv7-linux-androideabi i686-linux-android x86_64-linux-android
- ```
+
+```ps
+rustup target add aarch64-linux-android armv7-linux-androideabi i686-linux-android x86_64-linux-android
+```
diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx
index ffb11998f..417305b5b 100644
--- a/src/content/docs/index.mdx
+++ b/src/content/docs/index.mdx
@@ -37,9 +37,9 @@ import Cta from '@fragments/cta.mdx';