Categorygithub.com/thomasf/systray
modulepackage
0.0.0-20160822131811-a49a016dd2d7
Repository: https://github.com/thomasf/systray.git
Documentation: pkg.go.dev

# README

Package systray is a cross platfrom Go library to place an icon and menu in the notification area. Tested on Windows 8/10, Mac OSX 10.11 and Ubuntu 16.04.

This is a fork

This is a fork of https://github.com/getlantern/systray which focuses on cross compilation or mingw directly in windows instead of a precompiled windows dll file which is used in the upstream project.

Systray can be cross compiled for Windows (using http://www.mingw.org/ ) and OSX (using https://github.com/tpoechtrager/osxcross ) from ubuntu using or similar systems.

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

Mingw is needed to compile under windows.

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

# Packages

No description provided by the author

# Functions

Add menu item with designated title and tooltip, returning a channel that notifies whenever that menu item has been clicked.
Quit the systray.
Run initializes GUI and starts the event loop, then invokes the onReady callback.

# Structs

MenuItem is used to keep track each menu item of systray Don't create it directly, use the one systray.AddMenuItem() returned.