README
¶
Package systray is a cross platfrom Go library to place an icon and menu in the notification area. Tested on Windows 8, Mac OSX, Ubuntu 14.10 and Debian 7.6.
Usage
func main() {
// Should be called at the very beginning of main().
systray.Run(onReady)
}
func onReady() {
systray.SetIcon(icon.Data)
systray.SetTitle("Awesome App")
systray.SetTooltip("Pretty awesome超级棒")
mQuit := systray.AddMenuItem("Quit", "Quit the whole app")
}
Menu item can be checked and / or disabled. Methods except Run() can be invoked from any goroutine. See demo code under example folder.
Platform specific concerns
Linux
sudo apt-get install libgtk-3-dev libappindicator3-dev
Checked menu item not implemented on Linux yet.
Windows
Use the Visual Studio solution to build systray.dll. Make sure to target Windows
XP and build for Release (not Debug). Put the resulting dll in
dll/systray_unsigned.dll and then run ./signdll.bash to sign it. Check the
resulting dll into git at Git at dll/systray.dll and run ./embeddll.bash to
generate the systraydll_windows.go file.
The solution is configured to build with platform toolset v90 and dynamic linking to save on size and support Windows XP. To get platform toolset v90, you need to install Visual Studio 2008 (express edition is okay). You can build with a more recent Visual Studio, you just need the old one for the toolset.
Try
Under example folder.
Place tray icon under icon, and use make_icon.bat or make_icon.sh, whichever suit for your os, to convert the icon to byte array.
Your icon should be .ico file under Windows, whereas .ico, .jpg and .png is supported on other platform.
go get
go run main.go
Credits
Documentation
¶
Overview ¶
Package systray is a cross platfrom Go library to place an icon and menu in the notification area. Supports Windows, Mac OSX and Linux currently. Methods can be called from any goroutine except Run(), which should be called at the very beginning of main() to lock at main thread.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Run ¶
func Run(onReady func())
Run initializes GUI and starts the event loop, then invokes the onReady callback. It blocks until systray.Quit() is called. Should be called at the very beginning of main() to lock at main thread.
func SetIcon ¶
func SetIcon(iconBytes []byte)
SetIcon sets the systray icon. iconBytes should be the content of .ico for windows and .ico/.jpg/.png for other platforms.
func SetTooltip ¶
func SetTooltip(tooltip string)
SetTooltip sets the systray tooltip to display on mouse hover of the tray icon, only available on Mac and Windows.
Types ¶
type MenuItem ¶
type MenuItem struct {
// ClickedCh is the channel which will be notified when the menu item is clicked
ClickedCh chan interface{}
// contains filtered or unexported fields
}
MenuItem is used to keep track each menu item of systray Don't create it directly, use the one systray.AddMenuItem() returned
func AddMenuItem ¶
AddMenuItem adds menu item with designated title and tooltip, returning a channel that notifies whenever that menu item is clicked.
It can be safely invoked from different goroutines.
func (*MenuItem) Check ¶
func (item *MenuItem) Check()
Check a menu item regardless if it's previously checked or not
func (*MenuItem) Disable ¶
func (item *MenuItem) Disable()
Disable a menu item regardless if it's previously disabled or not
func (*MenuItem) Enable ¶
func (item *MenuItem) Enable()
Enable a menu item regardless if it's previously enabled or not
func (*MenuItem) SetTooltip ¶
SetTooltip set the tooltip to show when mouse hover
Source Files
Directories