feat(api): add WebviewWindow.isValid, closes #5380

tauri-apps · Oct 21, 2022 · d0d9778 · d0d9778
1 parent 161d5be
commit d0d9778
Show file tree

Hide file tree

Showing 7 changed files with 65 additions and 34 deletions.
diff --git a/.changes/api-webviewwindow-isvalid.md b/.changes/api-webviewwindow-isvalid.md
@@ -0,0 +1,5 @@
+---
+"api": "patch"
+---
+
+Add `WebviewWindow.isValid` to check if it is valid against the app core cache. Useful when creating a `WebviewWindow` through `WebviewWindow.getByLabelUnchecked`.
diff --git a/core/tauri/scripts/bundle.global.js b/core/tauri/scripts/bundle.global.js
diff --git a/core/tauri/src/endpoints/window.rs b/core/tauri/src/endpoints/window.rs
@@ -71,6 +71,7 @@ pub enum WindowManagerCmd {
   PrimaryMonitor,
   AvailableMonitors,
   Theme,
+  IsValid,
   // Setters
   #[cfg(window_center)]
   Center,
@@ -261,6 +262,10 @@ impl Cmd {
       WindowManagerCmd::PrimaryMonitor => return Ok(window.primary_monitor()?.into()),
       WindowManagerCmd::AvailableMonitors => return Ok(window.available_monitors()?.into()),
       WindowManagerCmd::Theme => return Ok(window.theme()?.into()),
+      WindowManagerCmd::IsValid => {
+        // this is unreachable unless the window is valid and exists in the cache.
+        return Ok(true.into());
+      }
       // Setters
       #[cfg(window_center)]
       WindowManagerCmd::Center => window.center()?,

diff --git a/examples/api/README.md b/examples/api/README.md
@@ -2,7 +2,7 @@
 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](./screenshot.png?raw=true)
+![App screenshot (Windows version)](./screenshot.png?raw=true)
 
 ## Running the example
 

diff --git a/examples/api/dist/assets/index.js b/examples/api/dist/assets/index.js
diff --git a/examples/api/screenshot.png b/examples/api/screenshot.png
diff --git a/tooling/api/src/window.ts b/tooling/api/src/window.ts
@@ -710,6 +710,27 @@ class WindowManager extends WebviewWindowHandle {
     })
   }
 
+  /**
+   * Checks if this WebviewWindow is valid against the app core cache.
+   * Useful for checking if a WebviewWindow created through {@link WebviewWindow.getByLabelUnchecked} is valid.
+   *
+   * @since 1.2.0
+   */
+  async isValid(): Promise<boolean> {
+    return invokeTauriCommand<boolean>({
+      __tauriModule: 'Window',
+      message: {
+        cmd: 'manage',
+        data: {
+          label: this.label,
+          cmd: {
+            type: 'isValid'
+          }
+        }
+      }
+    }).catch((_) => false)
+  }
+
   // Setters
 
   /**