Skip to content

Commit 1f28d6f

Browse files
docs: align with_menu_on_left_click with set_show_menu_on_left_click (#241)
* docs: align with_menu_on_left_click with set_show_menu_on_left_click * Add change file
1 parent 7c61204 commit 1f28d6f

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed
+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
tray-icon: patch
3+
---
4+
5+
Correct `with_menu_on_left_click`'s docs to include window support

src/lib.rs

+10-2
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,11 @@ pub struct TrayIconAttributes {
178178
/// Use the icon as a [template](https://developer.apple.com/documentation/appkit/nsimage/1520017-template?language=objc). **macOS only**.
179179
pub icon_is_template: bool,
180180

181-
/// Whether to show the tray menu on left click or not, default is `true`. **macOS & Windows only**.
181+
/// Whether to show the tray menu on left click or not, default is `true`.
182+
///
183+
/// ## Platform-specific:
184+
///
185+
/// - **Linux:** Unsupported.
182186
pub menu_on_left_click: bool,
183187

184188
/// Tray icon title.
@@ -293,7 +297,11 @@ impl TrayIconBuilder {
293297
self
294298
}
295299

296-
/// Whether to show the tray menu on left click or not, default is `true`. **macOS only**.
300+
/// Whether to show the tray menu on left click or not, default is `true`.
301+
///
302+
/// ## Platform-specific:
303+
///
304+
/// - **Linux:** Unsupported.
297305
pub fn with_menu_on_left_click(mut self, enable: bool) -> Self {
298306
self.attrs.menu_on_left_click = enable;
299307
self

0 commit comments

Comments
 (0)