diff --git a/plugins/notification/CHANGELOG.md b/plugins/notification/CHANGELOG.md index 42efb6ab..5f8ce795 100644 --- a/plugins/notification/CHANGELOG.md +++ b/plugins/notification/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## \[Unreleased] + +- Added sound support for desktop notifications which was previously only available on mobile platforms. + ## \[2.2.2] - [`a1b3fa27`](https://github.com/tauri-apps/plugins-workspace/commit/a1b3fa27f11022c9b6622b4fab12d93239eb05de) ([#2515](https://github.com/tauri-apps/plugins-workspace/pull/2515) by [@FabianLars](https://github.com/tauri-apps/plugins-workspace/../../FabianLars)) Re-exported the `Geolocation`, `Haptics`, `Notification`, and `Os` structs so that they show up on docs.rs. diff --git a/plugins/notification/README.md b/plugins/notification/README.md index 04632493..3717b474 100644 --- a/plugins/notification/README.md +++ b/plugins/notification/README.md @@ -104,6 +104,44 @@ export async function enqueueNotification(title, body) { } ``` +### Notification with Sound + +You can add sound to your notifications on all platforms (desktop and mobile): + +```javascript +import { sendNotification } from '@tauri-apps/plugin-notification' + +// Basic notification with sound +sendNotification({ + title: 'New Message', + body: 'You have a new message', + sound: 'notification.wav' // Path to sound file +}) + +// Platform-specific sounds +async function sendPlatformSpecificNotification() { + const platform = await import('@tauri-apps/api/os').then(os => os.platform()) + + let soundPath + if (platform === 'darwin') { + // On macOS: use system sounds or sound files in the app bundle + soundPath = 'Ping' // macOS system sound + } else if (platform === 'linux') { + // On Linux: use XDG theme sounds or file paths + soundPath = 'message-new-instant' // XDG theme sound + } else { + // On Windows: use file paths + soundPath = 'notification.wav' + } + + sendNotification({ + title: 'Platform-specific Notification', + body: 'This notification uses platform-specific sound', + sound: soundPath + }) +} +``` + ## Contributing PRs accepted. Please make sure to read the Contributing Guide before making a pull request. diff --git a/plugins/notification/guest-js/index.ts b/plugins/notification/guest-js/index.ts index 9f81a1e1..9d3e3ff0 100644 --- a/plugins/notification/guest-js/index.ts +++ b/plugins/notification/guest-js/index.ts @@ -71,7 +71,13 @@ interface Options { */ groupSummary?: boolean /** - * The sound resource name. Only available on mobile. + * The sound resource name or file path for the notification. + * + * Platform specific behavior: + * - On macOS: use system sounds (e.g., "Ping", "Blow") or sound files in the app bundle + * - On Linux: use XDG theme sounds (e.g., "message-new-instant") or file paths + * - On Windows: use file paths to sound files (.wav format) + * - On Mobile: use resource names */ sound?: string /** diff --git a/plugins/notification/src/desktop.rs b/plugins/notification/src/desktop.rs index 47279225..21ede1a9 100644 --- a/plugins/notification/src/desktop.rs +++ b/plugins/notification/src/desktop.rs @@ -39,6 +39,9 @@ impl crate::NotificationBuilder { if let Some(icon) = self.data.icon { notification = notification.icon(icon); } + if let Some(sound) = self.data.sound { + notification = notification.sound(sound); + } #[cfg(feature = "windows7-compat")] { notification.notify(&self.app)?; @@ -102,6 +105,8 @@ mod imp { title: Option, /// The notification icon. icon: Option, + /// The notification sound. + sound: Option, /// The notification identifier identifier: String, } @@ -136,6 +141,13 @@ mod imp { self } + /// Sets the notification sound file. + #[must_use] + pub fn sound(mut self, sound: impl Into) -> Self { + self.sound = Some(sound.into()); + self + } + /// Shows the notification. /// /// # Examples @@ -177,6 +189,9 @@ mod imp { } else { notification.auto_icon(); } + if let Some(sound) = self.sound { + notification.sound_name(&sound); + } #[cfg(windows)] { let exe = tauri::utils::platform::current_exe()?; @@ -250,6 +265,7 @@ mod imp { } } + /// Shows the notification on Windows 7. #[cfg(all(windows, feature = "windows7-compat"))] fn notify_win7(self, app: &tauri::AppHandle) -> crate::Result<()> { let app_ = app.clone(); @@ -264,6 +280,10 @@ mod imp { if let Some(icon) = app_.default_window_icon() { notification.icon(icon.rgba().to_vec(), icon.width(), icon.height()); } + // Enable sound if specified + if self.sound.is_some() { + notification.sound(true); + } let _ = notification.show(); }); diff --git a/plugins/notification/src/lib.rs b/plugins/notification/src/lib.rs index 9ca33d63..8b79c873 100644 --- a/plugins/notification/src/lib.rs +++ b/plugins/notification/src/lib.rs @@ -132,7 +132,7 @@ impl NotificationBuilder { self } - /// The sound resource name. Only available on mobile. + /// The sound resource name for the notification. pub fn sound(mut self, sound: impl Into) -> Self { self.data.sound.replace(sound.into()); self diff --git a/plugins/notification/test/sound-notification.html b/plugins/notification/test/sound-notification.html new file mode 100644 index 00000000..c5dd7d66 --- /dev/null +++ b/plugins/notification/test/sound-notification.html @@ -0,0 +1,115 @@ + + + + + + Tauri Notification Sound Test + + + +
+

Tauri Notifications with Sound

+ +
+

This demo shows how to use sound with Tauri notifications across different platforms.

+

Make sure you have the notification plugin installed and configured correctly.

+
+ +

Test Notifications

+ + + + +

Example Code

+ 
+// Example with system sound (mainly for macOS)
+await sendNotification({
+  title: 'Notification with System Sound',
+  body: 'This notification uses a system sound on macOS.',
+  sound: 'Ping' // macOS system sound
+});
+
+// Example with custom sound file
+await sendNotification({
+  title: 'Notification with Custom Sound',
+  body: 'This notification uses a custom sound file.',
+  sound: 'notification.wav' // path to your sound file
+});
+
+// Example with different sounds based on platform
+const platform = await import('@tauri-apps/api/os').then(os => os.platform());
+  
+let soundPath;
+if (platform === 'darwin') {
+  soundPath = 'Blow'; // macOS system sound
+} else if (platform === 'linux') {
+  soundPath = 'message-new-instant'; // XDG theme sound
+} else {
+  soundPath = 'notification.wav'; // Custom sound file for Windows
+}
+  
+await sendNotification({
+  title: 'Platform-specific Sound',
+  body: `This notification uses platform-specific sound settings for ${platform}.`,
+  sound: soundPath
+});
+
+ + + + + \ No newline at end of file diff --git a/plugins/notification/test/sound-notification.js b/plugins/notification/test/sound-notification.js new file mode 100644 index 00000000..3f81e47c --- /dev/null +++ b/plugins/notification/test/sound-notification.js @@ -0,0 +1,64 @@ +// Copyright 2019-2023 Tauri Programme within The Commons Conservancy +// SPDX-License-Identifier: Apache-2.0 +// SPDX-License-Identifier: MIT + +/** + * This file demonstrates how to use sound with notifications in Tauri v2. + * + * On macOS: + * - Sound file should be in your application bundle + * - Use the sound name without extension + * - Or use system sounds like "Ping", "Basso", "Blow", "Bottle", "Frog", "Funk", "Glass", etc. + * + * On Linux: + * - Use a file path to a sound file (e.g., .wav file) + * - Or use XDG theme sounds by name (e.g., "message-new-instant") + * + * On Windows: + * - Use a file path to a sound file (e.g., .wav file) + */ + +import { sendNotification } from '@tauri-apps/api/notification'; + +// Example with system sound (macOS) +async function showNotificationWithSystemSound() { + await sendNotification({ + title: 'Notification with System Sound', + body: 'This notification uses a system sound on macOS.', + sound: 'Ping' // macOS system sound + }); +} + +// Example with custom sound file +async function showNotificationWithCustomSound() { + await sendNotification({ + title: 'Notification with Custom Sound', + body: 'This notification uses a custom sound file.', + sound: 'notification.wav' // path to your sound file + }); +} + +// Example with different sounds based on platform +async function showNotificationWithPlatformSpecificSound() { + const platform = await import('@tauri-apps/api/os').then(os => os.platform()); + + let soundPath; + if (platform === 'darwin') { + soundPath = 'Blow'; // macOS system sound + } else if (platform === 'linux') { + soundPath = 'message-new-instant'; // XDG theme sound + } else { + soundPath = 'notification.wav'; // Custom sound file for Windows + } + + await sendNotification({ + title: 'Platform-specific Sound', + body: `This notification uses platform-specific sound settings for ${platform}.`, + sound: soundPath + }); +} + +// Export functions to be called from HTML +window.showNotificationWithSystemSound = showNotificationWithSystemSound; +window.showNotificationWithCustomSound = showNotificationWithCustomSound; +window.showNotificationWithPlatformSpecificSound = showNotificationWithPlatformSpecificSound; \ No newline at end of file