From 416370a6276efd4d67287dc1d6ee4f1c7a1500e4 Mon Sep 17 00:00:00 2001 From: i-c-b <133848861+i-c-b@users.noreply.github.com> Date: Mon, 6 Nov 2023 18:12:26 -0500 Subject: [PATCH] enhance(docs): Document Windows-specific icon behaviour (#8153) --- core/tauri/src/api/notification.rs | 4 ++++ tooling/api/src/notification.ts | 9 ++++++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/core/tauri/src/api/notification.rs b/core/tauri/src/api/notification.rs index 938f5d60850..2959591ca23 100644 --- 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) -> Self { self.icon = Some(icon.into()); diff --git a/tooling/api/src/notification.ts b/tooling/api/src/notification.ts index 056936a2b7f..68deca39e3d 100644 --- 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.