systray

README

systray is a cross-platform Go library to place an icon and menu in the notification area.

Features

• Supported on Windows, macOS, and Linux
• Menu items can be checked and/or disabled
• Methods may be called from any Goroutine

API

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
}

Try the example app!

Have go v1.12+ or higher installed? Here's an example to get started on macOS:

git clone https://github.com/getlantern/systray
env GO111MODULE=on go run systray/example/main.go

The following text will then appear on the console:

go: finding github.com/skratchdot/open-golang latest
go: finding github.com/getlantern/systray latest
go: finding github.com/getlantern/golog latest

Now look for Awesome App in your menu bar!

Platform notes

Linux

• Building apps requires the gtk3 and libappindicator3 development headers to be installed. For Debian or Ubuntu, you can may install these using:

sudo apt-get install libgtk-3-dev libappindicator3-dev

• Checked menu items are not yet implemented

Windows

• To avoid opening a console at application startup, use these compile 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

• Variables
• func AddExistingMenuItem(item *MenuItem)
• func AddSeparator()
• func Quit()
• func Run(onReady func(), onExit func(), selectedChannel chan *MenuItem)
• 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) Disable()
  • func (item *MenuItem) Enable()
  • func (item *MenuItem) Hide()
  • func (item *MenuItem) IsChecked() bool
  • func (item *MenuItem) IsDisabled() bool
  • 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()

Variables

var (
	SelectedChannel = make(chan *MenuItem)
)

Functions

func AddExistingMenuItem

func AddExistingMenuItem(item *MenuItem)

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(), selectedChannel chan *MenuItem)

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 {

	// Title is the text shown on menu item
	Title string
	// Tooltip is the text shown when pointing to menu item
	Tooltip string
	// Disabled menu item is grayed out and has no effect when clicked
	Disabled bool
	// Checked menu item has a tick before the Title
	Checked bool
	// 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) 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) Hide

func (item *MenuItem) Hide()

Hide hides a menu item

func (*MenuItem) IsChecked

func (item *MenuItem) IsChecked() bool

Checked returns if the menu item has a check mark

func (*MenuItem) IsDisabled

func (item *MenuItem) IsDisabled() bool

Disabled checkes if the menu item is Disabled

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