From 755c6640fd0c14df4528964ccffdf6b463d136c7 Mon Sep 17 00:00:00 2001 From: Shelley Vohr Date: Thu, 22 Aug 2024 02:38:06 +0200 Subject: [PATCH] docs: clarify icon value in Notification (#43377) * docs: clarify icon value in Notification * Update docs/api/notification.md Co-authored-by: Erick Zhao --------- Co-authored-by: Erick Zhao --- docs/api/notification.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/notification.md b/docs/api/notification.md index fe12a9d050..efaa93b39e 100644 --- a/docs/api/notification.md +++ b/docs/api/notification.md @@ -36,7 +36,7 @@ Returns `boolean` - Whether or not desktop notifications are supported on the cu * `subtitle` string (optional) _macOS_ - A subtitle for the notification, which will be displayed below the title. * `body` string (optional) - The body text of the notification, which will be displayed below the title or subtitle. * `silent` boolean (optional) - Whether or not to suppress the OS notification noise when showing the notification. - * `icon` (string | [NativeImage](native-image.md)) (optional) - An icon to use in the notification. + * `icon` (string | [NativeImage](native-image.md)) (optional) - An icon to use in the notification. If a string is passed, it must be a valid path to a local icon file. * `hasReply` boolean (optional) _macOS_ - Whether or not to add an inline reply option to the notification. * `timeoutType` string (optional) _Linux_ _Windows_ - The timeout duration of the notification. Can be 'default' or 'never'. * `replyPlaceholder` string (optional) _macOS_ - The placeholder to write in the inline reply input field.