feat(window): add option to disable controls (#406)

Co-authored-by: Amr Bashir <[email protected]>

.changes/disable-window-controls-api-options.md

@@ -0,0 +1,5 @@
+---
+"window-js": "minor:feat"
+---
+
+Added the `maximizable`, `minimizable` and `closable` fields on `WindowOptions`.

.changes/disable-window-controls-api.md

@@ -0,0 +1,6 @@
+---
+"window": "minor:feat"
+"window-js": "minor:feat"
+---
+
+Added the `setMaximizable`, `setMinimizable`, `setClosable`, `isMaximizable`, `isMinimizable` and `isClosable` methods.

examples/api/src/views/Window.svelte

@@ -78,6 +78,9 @@
 
   let urlValue = "https://tauri.app";
   let resizable = true;
+  let maximizable = true;
+  let minimizable = true;
+  let closable = true;
   let maximized = false;
   let decorations = true;
   let alwaysOnTop = false;
@@ -231,6 +234,9 @@
     loadWindowSize();
   }
   $: windowMap[selectedWindow]?.setResizable(resizable);
+  $: windowMap[selectedWindow]?.setMaximizable(maximizable);
+  $: windowMap[selectedWindow]?.setMinimizable(minimizable);
+  $: windowMap[selectedWindow]?.setClosable(closable);
   $: maximized
     ? windowMap[selectedWindow]?.maximize()
     : windowMap[selectedWindow]?.unmaximize();
@@ -333,6 +339,18 @@
         Resizable
         <input type="checkbox" bind:checked={resizable} />
       </label>
+      <label>
+        Maximizable
+        <input type="checkbox" bind:checked={maximizable} />
+      </label>
+      <label>
+        Minimizable
+        <input type="checkbox" bind:checked={minimizable} />
+      </label>
+      <label>
+        Closable
+        <input type="checkbox" bind:checked={closable} />
+      </label>
       <label>
         Has decorations
         <input type="checkbox" bind:checked={decorations} />

plugins/window/guest-js/index.ts

@@ -617,6 +617,69 @@ class WindowManager extends WebviewWindowHandle {
     });
   }
 
+  /**
+   * Gets the window’s native maximize button state.
+   *
+   * #### Platform-specific
+   *
+   * - **Linux / iOS / Android:** Unsupported.
+   *
+   * @example
+   * ```typescript
+   * import { appWindow } from '@tauri-apps/plugin-window';
+   * const maximizable = await appWindow.isMaximizable();
+   * ```
+   *
+   * @returns Whether the window's native maximize button is enabled or not.
+   *  */
+  async isMaximizable(): Promise<boolean> {
+    return window.__TAURI_INVOKE__("plugin:window|is_maximizable", {
+      label: this.label,
+    });
+  }
+
+  /**
+   * Gets the window’s native minimize button state.
+   *
+   * #### Platform-specific
+   *
+   * - **Linux / iOS / Android:** Unsupported.
+   *
+   * @example
+   * ```typescript
+   * import { appWindow } from '@tauri-apps/plugin-window';
+   * const minimizable = await appWindow.isMinimizable();
+   * ```
+   *
+   * @returns Whether the window's native minimize button is enabled or not.
+   *  */
+  async isMinimizable(): Promise<boolean> {
+    return window.__TAURI_INVOKE__("plugin:window|is_minimizable", {
+      label: this.label,
+    });
+  }
+
+  /**
+   * Gets the window’s native close button state.
+   *
+   * #### Platform-specific
+   *
+   * - **iOS / Android:** Unsupported.
+   *
+   * @example
+   * ```typescript
+   * import { appWindow } from '@tauri-apps/plugin-window';
+   * const closable = await appWindow.isClosable();
+   * ```
+   *
+   * @returns Whether the window's native close button is enabled or not.
+   *  */
+  async isClosable(): Promise<boolean> {
+    return window.__TAURI_INVOKE__("plugin:window|is_closable", {
+      label: this.label,
+    });
+  }
+
   /**
    * Gets the window's current visible state.
    * @example
@@ -713,7 +776,7 @@ class WindowManager extends WebviewWindowHandle {
    * await appWindow.requestUserAttention();
    * ```
    *
-   * @param resizable
+   * @param requestType
    * @returns A promise indicating the success or failure of the operation.
    *
    * @since 2.0.0
@@ -756,6 +819,78 @@ class WindowManager extends WebviewWindowHandle {
     });
   }
 
+  /**
+   * Sets whether the window's native maximize button is enabled or not.
+   * If resizable is set to false, this setting is ignored.
+   *
+   * #### Platform-specific
+   *
+   * - **macOS:** Disables the "zoom" button in the window titlebar, which is also used to enter fullscreen mode.
+   * - **Linux / iOS / Android:** Unsupported.
+   *
+   * @example
+   * ```typescript
+   * import { appWindow } from '@tauri-apps/plugin-window';
+   * await appWindow.setMaximizable(false);
+   * ```
+   *
+   * @param maximizable
+   * @returns A promise indicating the success or failure of the operation.
+   */
+  async setMaximizable(maximizable: boolean): Promise<void> {
+    return window.__TAURI_INVOKE__("plugin:window|set_maximizable", {
+      label: this.label,
+      value: maximizable,
+    });
+  }
+
+  /**
+   * Sets whether the window's native minimize button is enabled or not.
+   *
+   * #### Platform-specific
+   *
+   * - **Linux / iOS / Android:** Unsupported.
+   *
+   * @example
+   * ```typescript
+   * import { appWindow } from '@tauri-apps/plugin-window';
+   * await appWindow.setMinimizable(false);
+   * ```
+   *
+   * @param minimizable
+   * @returns A promise indicating the success or failure of the operation.
+   */
+  async setMinimizable(minimizable: boolean): Promise<void> {
+    return window.__TAURI_INVOKE__("plugin:window|set_minimizable", {
+      label: this.label,
+      value: minimizable,
+    });
+  }
+
+  /**
+   * Sets whether the window's native close button is enabled or not.
+   *
+   * #### Platform-specific
+   *
+   * - **Linux:** GTK+ will do its best to convince the window manager not to show a close button. Depending on the system, this function may not have any effect when called on a window that is already visible
+   * - **iOS / Android:** Unsupported.
+   *
+   * @example
+   * ```typescript
+   * import { appWindow } from '@tauri-apps/plugin-window';
+   * await appWindow.setClosable(false);
+   * ```
+   *
+   * @param closable
+   * @returns A promise indicating the success or failure of the operation.
+   */
+  async setClosable(closable: boolean): Promise<void> {
+    return window.__TAURI_INVOKE__("plugin:window|set_closable", {
+      label: this.label,
+      value: closable,
+    });
+  }
+
   /**
    * Sets the window title.
    * @example
@@ -2123,6 +2258,18 @@ interface WindowOptions {
    * - **Android:** Unsupported.
    */
   incognito?: boolean;
+  /**
+   * Whether the window's native maximize button is enabled or not. Defaults to `true`.
+   */
+  maximizable?: boolean;
+  /**
+   * Whether the window's native minimize button is enabled or not. Defaults to `true`.
+   */
+  minimizable?: boolean;
+  /**
+   * Whether the window's native close button is enabled or not. Defaults to `true`.
+   */
+  closable?: boolean;
 }
 
 function mapMonitor(m: Monitor | null): Monitor | null {