enhance(docs): Document Windows-specific icon behaviour (#8153)

tauri-apps · Nov 6, 2023 · 416370a · 416370a
1 parent 2c7d683
commit 416370a
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/core/tauri/src/api/notification.rs b/core/tauri/src/api/notification.rs
@@ -110,6 +110,10 @@ impl Notification {
   }
 
   /// Sets the notification icon.
+  ///
+  /// ## Platform-specific
+  ///
+  /// - **Windows**: The app must be installed for this to have any effect.
   #[must_use]
   pub fn icon(mut self, icon: impl Into<String>) -> Self {
     self.icon = Some(icon.into());

diff --git a/tooling/api/src/notification.ts b/tooling/api/src/notification.ts
@@ -36,7 +36,14 @@ interface Options {
   title: string
   /** Optional notification body. */
   body?: string
-  /** Optional notification icon. */
+  /**
+   * Optional notification icon.
+   *
+   * #### Platform-specific
+   *
+   * - **Windows**: The app must be installed for this to have any effect.
+   *
+   */
   icon?: string
   /**
    * Optional notification sound.