Support Tray Menus (Windows) #1521

leaanthony · 2022-07-03T01:38:11Z

Wails should support Tray Menus for all platforms. It should support the features appropriate to each platform, EG text for Mac, icons for all platforms, etc.

Other Platforms:

doc-war · 2022-08-10T02:16:07Z

windows Tray（托盘）目前都没支持，非常不便

ha-sante · 2022-08-24T12:02:14Z

Any ideas on what would be the right mode of implementation?

e.g Should we start off with using a stable package or implement it ourselves @leaanthony ?

I mean in terms of contributing to the wails project?

Seeing this as a candidate for the library package dependency. https://github.com/getlantern/systray

leaanthony · 2022-08-24T12:13:22Z

Awesome that you'd like to contribute 🙏 Trays are literally the first cab off the rank post v2. There's some preliminary work in the exp branch if you want to have a look. I fear Linux may be a no-go with it as it's likely to need a library installed on the client machine because the Gnome project don't believe it should be there 🙄

saul-data · 2022-10-28T18:33:44Z

We would like to use this project (fantastic work btw) and have tray icon feature for the background workers for our cloud native ETL / data pipeline tool also written in Golang - https://github.com/dataplane-app/dataplane

@leaanthony When do you think this feature will be available?

leaanthony · 2022-10-29T01:23:34Z

Congratulations on releasing dataplane! Looks cool. There are never ETAs on features, however this feature is currently in-progress. There is a PR open with RFC here: #1959. Is this time critical for you?

saul-data · 2022-10-29T06:50:08Z

We were hoping to release in two weeks. We need the tray icon for basic open and exit a background process. I also want to show to users that it is running in the background. Is there any icon functionality available? I am not sure I need menus, just the icon to open and close the window. Once the window is open, we can then exit the app. To open the window, we can just click or double click the icon.

leaanthony · 2022-10-29T08:32:23Z

Multi platform tray icons will not be ready in 2 weeks unfortunately.

saul-data · 2022-10-29T08:35:49Z

Will any platforms be available? We are focusing on Windows right now. Mac?

leaanthony · 2022-10-29T08:43:15Z

There's the PR I linked. That's where we are at.

StephenBrown2 · 2022-11-10T16:14:03Z

Linux may be a no-go with it as it's likely to need a library installed on the client machine because the Gnome project don't believe it should be there roll_eyes

While it may require a library on Linux, I still think it's worth implementing something or at least giving a bit of boilerplate code to be able to have KStatusNotifierItem/AppIndicator support on Linux.

I understand you're working on Windows and Mac support first, but just wanted to put my vote in for Linux support, since we do have the capability of specifying dependencies, though maybe this is for dev only and not runtime? https://wails.io/docs/guides/linux-distro-support#adding-package-names

Thank you for the excellent project, and you have my sincerest gratitude for your effort!

lyimmi · 2022-11-11T18:35:13Z

Hi,

I think we could use Dbus with SystemNotifier/AppIndicator as our main implementaion. It seems to me that it could solve the problem on a big portion of the most used distros without depending on any installed C library. For example fyne-io only supports the DBus way.

I tried this on a few distros:

fedora latest (not working, default gnome)
fedora KDE (works)
kubuntu 22.04 (works)
kubuntu 20.04 (works)
ubuntu 22.04 gnome (works)
popOS 22.04 gnome (works)
linux mint cinnamon (works)
linux mint xfce (works)
linux mint mate (not working)

As a second option:
If we want (have the time and determination to implement them) we could maybe hide the fallback implementations behind a build flag as an optional dependency?

And if the DBus way is not available fallback to libayatana-appindicator and maybe libappindicator3 if its not available and throw a warning if neither is available. Tauri does the same thing. Electron simply depends on libappindicator1. In the documentation we could inform the developers that the packaging and distribution of the libraries is their job.

leaanthony · 2022-11-11T21:32:06Z

I'm happy with this approach. If only linux had some common installer mechanism to make this easy 🤦

lyimmi · 2022-11-11T22:04:59Z

https://xkcd.com/927

I don't know if anyone is "assigned" to the linux part of the tray pr #1959, if you'd like @leaanthony I could pick it up in mid November.

leaanthony · 2022-11-11T22:52:25Z

That would be amazing @lyimmi Thank you! 🙏

Aceix · 2022-11-22T11:43:03Z

There's this fork also https://github.com/fyne-io/systray. It claims to remove GTK deps. might be worth looking at.
I tried it with a wails app I'm building and no issues on Ubuntu 22.04 (GNOME 42.5) so far. The app is still under development though

lyimmi · 2022-11-22T12:01:52Z

Yes, this is a Dbus implementation as well.

TheFranconianCoder · 2023-02-17T13:33:27Z

Currently I'm working on a background app, which should mostly sits in the tray. Are there plans, the WebView can actually be closed and re-started, instead of hide and show? To hide the WebView in such a scenario would be a waste of ressources.

leaanthony · 2023-02-17T20:02:56Z

Will be possible in v3 which has a much better API for such things 👍

lthon09 · 2023-05-30T09:11:00Z

I've found a better fork of systray here, which supports left, right click and double (?) click: https://github.com/energye/systray

TheFranconianCoder · 2023-05-30T09:56:43Z

I've found a better fork of systray here, which supports left, right click and double (?) click: https://github.com/energye/systray

Used that before. Worked pretty well. 👍

lthon09 · 2023-05-30T13:25:12Z

I'm currently using it in a Wails project, it provides a much easier to use API and even extra click callbacks. Seamlessly integrates with Wails :)

leaanthony · 2023-06-01T09:09:10Z

I'm glad there's a workaround for v2. We will have native support in v3 (already working pretty well for Mac and Windows)

dami-i · 2023-06-24T02:41:34Z

I'm currently using it in a Wails project, it provides a much easier to use API and even extra click callbacks. Seamlessly integrates with Wails :)

@lthon09 Would you mind giving me a glimpse on how you assembled the integration?

I'm glad there's a workaround for v2. We will have native support in v3 (already working pretty well for Mac and Windows)

@leaanthony I just stumbled upon a options.SystemTray and options.SystemTrayIcon with the help of intellisense. Is this fully implemented yet? I'm using v2.5.1.

leaanthony · 2023-06-24T02:52:33Z

@leaanthony I just stumbled upon a options.SystemTray and options.SystemTrayIcon with the help of intellisense. Is this fully implemented yet? I'm using v2.5.1.

They were experiments. Ultimately, the v2 API is written specifically for single windows and that runs deep. I looked at adding it and it wasn't great so we've added it to v3 where the entire guts were built in a way to better support these features. A brave soul has made a project with it (even though it's alpha) and has screenshots here: https://github.com/duolabmeng6/go-qoq

lthon09 · 2023-06-24T04:17:57Z

I'm currently using it in a Wails project, it provides a much easier to use API and even extra click callbacks. Seamlessly integrates with Wails :)

@lthon09 Would you mind giving me a glimpse on how you assembled the integration?

It's just using some basic features of the package, create some menu items for showing and quitting the program. Here's some example code:

package main

import (
	"github.com/energye/systray"

	"github.com/wailsapp/wails/v2"
	"github.com/wailsapp/wails/v2/pkg/options"
	"github.com/wailsapp/wails/v2/pkg/runtime"
)

type _application struct {
	context _context.Context
}
var __application *_application

func systemTray() {
	systray.SetIcon([]byte()) // read the icon from a file

	show := systray.AddMenuItem("Show", "Show The Window")
	systray.AddSeparator()
	exit := systray.AddMenuItem("Exit", "Quit The Program")

	show.Click(func() {wailsRuntime.WindowShow(__application.context)})
	exit.Click(func() {os.Exit(0)})

	systray.SetOnClick(func() {wailsRuntime.WindowShow(__application.context)})
	systray.SetOnRClick(func(menu systray.IMenu) {menu.ShowMenu()})
}

func main() {
	__application = &_application{}
	wails.Run(&options.App{
		// ...

		OnStartup: __application.startUp,

		Bind: []interface{}{__application},
	})
}

func (application *_application) startUp(context _context.Context) {
	application.context = context
	systray.Run(systemTray, func() {})
}

It integrates with Wails really well. Sorry if my code looks unclean!

leaanthony · 2023-08-03T22:37:21Z

Closing this as it's intended for v3 and there's no more work to be done on it.

nsainaney · 2024-02-13T20:31:00Z

I'm currently using it in a Wails project, it provides a much easier to use API and even extra click callbacks. Seamlessly integrates with Wails :)

@lthon09 Would you mind giving me a glimpse on how you assembled the integration?

It's just using some basic features of the package, create some menu items for showing and quitting the program. Here's some example code:

package main

import (
	"github.com/energye/systray"

	"github.com/wailsapp/wails/v2"
	"github.com/wailsapp/wails/v2/pkg/options"
	"github.com/wailsapp/wails/v2/pkg/runtime"
)

type _application struct {
	context _context.Context
}
var __application *_application

func systemTray() {
	systray.SetIcon([]byte()) // read the icon from a file

	show := systray.AddMenuItem("Show", "Show The Window")
	systray.AddSeparator()
	exit := systray.AddMenuItem("Exit", "Quit The Program")

	show.Click(func() {wailsRuntime.WindowShow(__application.context)})
	exit.Click(func() {os.Exit(0)})

	systray.SetOnClick(func() {wailsRuntime.WindowShow(__application.context)})
	systray.SetOnRClick(func(menu systray.IMenu) {menu.ShowMenu()})
}

func main() {
	__application = &_application{}
	wails.Run(&options.App{
		// ...

		OnStartup: __application.startUp,

		Bind: []interface{}{__application},
	})
}

func (application *_application) startUp(context _context.Context) {
	application.context = context
	systray.Run(systemTray, func() {})
}

It integrates with Wails really well. Sorry if my code looks unclean!

The above doesn't work as wails and energye/systray both have an AppDelegate on MacOS and it results in a linker error (see below). Were you able to get it working on Mac?

running cc failed: exit status 1
ld: warning: ignoring duplicate libraries: '-lobjc'
duplicate symbol '_OBJC_METACLASS_$_AppDelegate' in:
    /private/var/folders/0v/0fvf17zn0q95mlsp1pp7sz3m0000gn/T/go-link-233777249/000002.o
    /private/var/folders/0v/0fvf17zn0q95mlsp1pp7sz3m0000gn/T/go-link-233777249/000026.o
duplicate symbol '_OBJC_CLASS_$_AppDelegate' in:
    /private/var/folders/0v/0fvf17zn0q95mlsp1pp7sz3m0000gn/T/go-link-233777249/000002.o
    /private/var/folders/0v/0fvf17zn0q95mlsp1pp7sz3m0000gn/T/go-link-233777249/000026.o
ld: 2 duplicate symbols```

lthon09 · 2024-02-13T20:54:55Z

I'm currently using it in a Wails project, it provides a much easier to use API and even extra click callbacks. Seamlessly integrates with Wails :)

@lthon09 Would you mind giving me a glimpse on how you assembled the integration?

It's just using some basic features of the package, create some menu items for showing and quitting the program. Here's some example code:

package main

import (
	"github.com/energye/systray"

	"github.com/wailsapp/wails/v2"
	"github.com/wailsapp/wails/v2/pkg/options"
	"github.com/wailsapp/wails/v2/pkg/runtime"
)

type _application struct {
	context _context.Context
}
var __application *_application

func systemTray() {
	systray.SetIcon([]byte()) // read the icon from a file

	show := systray.AddMenuItem("Show", "Show The Window")
	systray.AddSeparator()
	exit := systray.AddMenuItem("Exit", "Quit The Program")

	show.Click(func() {wailsRuntime.WindowShow(__application.context)})
	exit.Click(func() {os.Exit(0)})

	systray.SetOnClick(func() {wailsRuntime.WindowShow(__application.context)})
	systray.SetOnRClick(func(menu systray.IMenu) {menu.ShowMenu()})
}

func main() {
	__application = &_application{}
	wails.Run(&options.App{
		// ...

		OnStartup: __application.startUp,

		Bind: []interface{}{__application},
	})
}

func (application *_application) startUp(context _context.Context) {
	application.context = context
	systray.Run(systemTray, func() {})
}

It integrates with Wails really well. Sorry if my code looks unclean!

The above doesn't work as wails and energye/systray both have an AppDelegate on MacOS and it results in a linker error (see below). Were you able to get it working on Mac?

running cc failed: exit status 1
ld: warning: ignoring duplicate libraries: '-lobjc'
duplicate symbol '_OBJC_METACLASS_$_AppDelegate' in:
    /private/var/folders/0v/0fvf17zn0q95mlsp1pp7sz3m0000gn/T/go-link-233777249/000002.o
    /private/var/folders/0v/0fvf17zn0q95mlsp1pp7sz3m0000gn/T/go-link-233777249/000026.o
duplicate symbol '_OBJC_CLASS_$_AppDelegate' in:
    /private/var/folders/0v/0fvf17zn0q95mlsp1pp7sz3m0000gn/T/go-link-233777249/000002.o
    /private/var/folders/0v/0fvf17zn0q95mlsp1pp7sz3m0000gn/T/go-link-233777249/000026.o
ld: 2 duplicate symbols```

Unfortunately no I haven't tried anything on Mac and this code was from really long ago.

zhufucdev · 2024-07-13T15:49:46Z

I'm currently using it in a Wails project, it provides a much easier to use API and even extra click callbacks. Seamlessly integrates with Wails :)

@lthon09 Would you mind giving me a glimpse on how you assembled the integration?

It's just using some basic features of the package, create some menu items for showing and quitting the program. Here's some example code:

package main

import (
	"github.com/energye/systray"

	"github.com/wailsapp/wails/v2"
	"github.com/wailsapp/wails/v2/pkg/options"
	"github.com/wailsapp/wails/v2/pkg/runtime"
)

type _application struct {
	context _context.Context
}
var __application *_application

func systemTray() {
	systray.SetIcon([]byte()) // read the icon from a file

	show := systray.AddMenuItem("Show", "Show The Window")
	systray.AddSeparator()
	exit := systray.AddMenuItem("Exit", "Quit The Program")

	show.Click(func() {wailsRuntime.WindowShow(__application.context)})
	exit.Click(func() {os.Exit(0)})

	systray.SetOnClick(func() {wailsRuntime.WindowShow(__application.context)})
	systray.SetOnRClick(func(menu systray.IMenu) {menu.ShowMenu()})
}

func main() {
	__application = &_application{}
	wails.Run(&options.App{
		// ...

		OnStartup: __application.startUp,

		Bind: []interface{}{__application},
	})
}

func (application *_application) startUp(context _context.Context) {
	application.context = context
	systray.Run(systemTray, func() {})
}

It integrates with Wails really well. Sorry if my code looks unclean!

The above doesn't work as wails and energye/systray both have an AppDelegate on MacOS and it results in a linker error (see below). Were you able to get it working on Mac?

running cc failed: exit status 1
ld: warning: ignoring duplicate libraries: '-lobjc'
duplicate symbol '_OBJC_METACLASS_$_AppDelegate' in:
    /private/var/folders/0v/0fvf17zn0q95mlsp1pp7sz3m0000gn/T/go-link-233777249/000002.o
    /private/var/folders/0v/0fvf17zn0q95mlsp1pp7sz3m0000gn/T/go-link-233777249/000026.o
duplicate symbol '_OBJC_CLASS_$_AppDelegate' in:
    /private/var/folders/0v/0fvf17zn0q95mlsp1pp7sz3m0000gn/T/go-link-233777249/000002.o
    /private/var/folders/0v/0fvf17zn0q95mlsp1pp7sz3m0000gn/T/go-link-233777249/000026.o
ld: 2 duplicate symbols```

This fork contains the modification you wanted.

fyne-io/systray@6539193

It's not released though, so perhaps you want to add it to your project's submodule and replace the go module with it

git submodule add https://github.com/fyne-io/systray.git systray
echo 'replace fyne.io/systray => ./systray' >> go.mod

leaanthony self-assigned this Jul 3, 2022

leaanthony mentioned this issue Jul 3, 2022

[v2] MacOS New feature of tray menu. #1010

Closed

leaanthony added Enhancement New feature or request TODO The issue is ready to be developed labels Jul 3, 2022

leaanthony moved this to 🆕 TODO in Wails Backlog Jul 3, 2022

leaanthony removed this from Wails Backlog Jul 25, 2022

leaanthony added this to Wails Backlog Sep 23, 2022

leaanthony moved this to 🆕 TODO in Wails Backlog Sep 23, 2022

leaanthony moved this from 🆕 TODO to 🏗 In progress in Wails Backlog Sep 23, 2022

leaanthony moved this from 🏗 In progress to 🆕 TODO in Wails Backlog Sep 23, 2022

leaanthony moved this from 🆕 TODO to 🏗 In progress in Wails Backlog Sep 23, 2022

leaanthony mentioned this issue Sep 27, 2022

Refactor app #1909

Merged

leaanthony mentioned this issue Oct 12, 2022

[RFC] Support tray menus (Windows) #1959

Closed

leaanthony added this to the v2.2.0 milestone Oct 16, 2022

leaanthony mentioned this issue Nov 9, 2022

MacOSX Top Menu Tray #2071

Closed

leaanthony removed this from the v2.2 milestone Nov 22, 2022

leaanthony added this to the v2.3.0 milestone Nov 22, 2022

leaanthony changed the title ~~Support Tray Menus~~ Support Tray Menus (Windows) Dec 1, 2022

leaanthony removed this from the v2.4.0 milestone Dec 29, 2022

benoitf mentioned this issue Feb 23, 2023

podman desktop 0.12.0 is slow and stuck - Linux podman-desktop/podman-desktop#1533

Closed

andrewbrey mentioned this issue Mar 1, 2023

How to embed the system tray? #2437

Closed

stffabi mentioned this issue Mar 16, 2023

Set options HideWindowOnClose: true, but windows system tray does not display #2491

Closed

leaanthony added the Implemented in v3 label Jun 24, 2023

leaanthony closed this as completed Aug 3, 2023

W1M0R mentioned this issue Sep 18, 2023

How to use system tray #2821

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support Tray Menus (Windows) #1521

Support Tray Menus (Windows) #1521

leaanthony commented Jul 3, 2022 •

edited

Loading

doc-war commented Aug 10, 2022

ha-sante commented Aug 24, 2022 •

edited

Loading

leaanthony commented Aug 24, 2022

saul-data commented Oct 28, 2022

leaanthony commented Oct 29, 2022

saul-data commented Oct 29, 2022

leaanthony commented Oct 29, 2022

saul-data commented Oct 29, 2022

leaanthony commented Oct 29, 2022

StephenBrown2 commented Nov 10, 2022

lyimmi commented Nov 11, 2022 •

edited

Loading

leaanthony commented Nov 11, 2022

lyimmi commented Nov 11, 2022 •

edited

Loading

leaanthony commented Nov 11, 2022

Aceix commented Nov 22, 2022 •

edited

Loading

lyimmi commented Nov 22, 2022

TheFranconianCoder commented Feb 17, 2023

leaanthony commented Feb 17, 2023

lthon09 commented May 30, 2023

TheFranconianCoder commented May 30, 2023

lthon09 commented May 30, 2023

leaanthony commented Jun 1, 2023

dami-i commented Jun 24, 2023 •

edited

Loading

leaanthony commented Jun 24, 2023

lthon09 commented Jun 24, 2023 •

edited

Loading

leaanthony commented Aug 3, 2023

nsainaney commented Feb 13, 2024

lthon09 commented Feb 13, 2024

zhufucdev commented Jul 13, 2024

Support Tray Menus (Windows) #1521

Support Tray Menus (Windows) #1521

Comments

leaanthony commented Jul 3, 2022 • edited Loading

doc-war commented Aug 10, 2022

ha-sante commented Aug 24, 2022 • edited Loading

leaanthony commented Aug 24, 2022

saul-data commented Oct 28, 2022

leaanthony commented Oct 29, 2022

saul-data commented Oct 29, 2022

leaanthony commented Oct 29, 2022

saul-data commented Oct 29, 2022

leaanthony commented Oct 29, 2022

StephenBrown2 commented Nov 10, 2022

lyimmi commented Nov 11, 2022 • edited Loading

leaanthony commented Nov 11, 2022

lyimmi commented Nov 11, 2022 • edited Loading

leaanthony commented Nov 11, 2022

Aceix commented Nov 22, 2022 • edited Loading

lyimmi commented Nov 22, 2022

TheFranconianCoder commented Feb 17, 2023

leaanthony commented Feb 17, 2023

lthon09 commented May 30, 2023

TheFranconianCoder commented May 30, 2023

lthon09 commented May 30, 2023

leaanthony commented Jun 1, 2023

dami-i commented Jun 24, 2023 • edited Loading

leaanthony commented Jun 24, 2023

lthon09 commented Jun 24, 2023 • edited Loading

leaanthony commented Aug 3, 2023

nsainaney commented Feb 13, 2024

lthon09 commented Feb 13, 2024

zhufucdev commented Jul 13, 2024

leaanthony commented Jul 3, 2022 •

edited

Loading

ha-sante commented Aug 24, 2022 •

edited

Loading

lyimmi commented Nov 11, 2022 •

edited

Loading

lyimmi commented Nov 11, 2022 •

edited

Loading

Aceix commented Nov 22, 2022 •

edited

Loading

dami-i commented Jun 24, 2023 •

edited

Loading

lthon09 commented Jun 24, 2023 •

edited

Loading