systray

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, onExit)
}

func onReady() {
	systray.SetIcon(icon.Data)
	systray.SetTitle("Awesome App")
	systray.SetTooltip("Pretty awesome超级棒")
	mQuit := systray.AddMenuItem("Quit", "Quit the whole app")

	// Sets the icon of a menu item. Only available on Mac.
	mQuit.SetIcon(icon.Data)
}

func onExit() {
	// clean up here
}

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.

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

Building and the Console Window

By default, the binary created by go build will cause a console window to be opened on both Windows and macOS when run.

Windows

To prevent launching a console window when running on Windows, add these command-line build flags:

go build -ldflags -H=windowsgui

macOS

On macOS, you will need to create an application bundle to wrap the binary; simply folders with the following minimal structure and assets:

SystrayApp.app/
  Contents/
    Info.plist
    MacOS/
      go-executable
    Resources/
      SystrayApp.icns

Consult the Official Apple Documentation here.

Credits

• https://github.com/xilp/systray
• https://github.com/cratonica/trayhost

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

• func AddSeparator()
• func Quit()
• func Run(onReady func(), onExit func())
• func SetIcon(iconBytes []byte)
• func SetTitle(title string)
• func SetTooltip(tooltip string)
• type MenuItem
  • func AddMenuItem(title string, tooltip string) *MenuItem
  • func (item *MenuItem) Check()
  • func (item *MenuItem) Checked() bool
  • func (item *MenuItem) Disable()
  • func (item *MenuItem) Disabled() bool
  • func (item *MenuItem) Enable()
  • func (item *MenuItem) Hide()
  • func (item *MenuItem) SetIcon(iconBytes []byte)
  • func (item *MenuItem) SetTitle(title string)
  • func (item *MenuItem) SetTooltip(tooltip string)
  • func (item *MenuItem) Show()
  • func (item *MenuItem) Uncheck()

Functions

func AddSeparator

func AddSeparator()

AddSeparator adds a separator bar to the menu

func Quit

func Quit()

Quit the systray

func Run

func Run(onReady func(), onExit 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 SetTitle

func SetTitle(title string)

SetTitle sets the systray title, only available on Mac.

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 struct{}
	// 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

func AddMenuItem(title string, tooltip string) *MenuItem

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) Checked

func (item *MenuItem) Checked() bool

Checked returns if the menu item has a check mark

func (*MenuItem) Disable

func (item *MenuItem) Disable()

Disable a menu item regardless if it's previously disabled or not

func (*MenuItem) Disabled

func (item *MenuItem) Disabled() bool

Disabled checkes if the menu item is disabled

func (*MenuItem) Enable

func (item *MenuItem) Enable()

Enable a menu item regardless if it's previously enabled or not

func (*MenuItem) Hide

func (item *MenuItem) Hide()

Hide hides a menu item

func (*MenuItem) SetIcon

func (item *MenuItem) SetIcon(iconBytes []byte)

SetIcon sets the icon of a menu item. Only available on Mac. iconBytes should be the content of .ico/.jpg/.png

func (*MenuItem) SetTitle

func (item *MenuItem) SetTitle(title string)

SetTitle set the text to display on a menu item

func (*MenuItem) SetTooltip

func (item *MenuItem) SetTooltip(tooltip string)

SetTooltip set the tooltip to show when mouse hover

func (*MenuItem) Show

func (item *MenuItem) Show()

Show shows a previously hidden menu item

func (*MenuItem) Uncheck

func (item *MenuItem) Uncheck()

Uncheck a menu item regardless if it's previously unchecked or not