summaryrefslogtreecommitdiff
path: root/vendor/github.com/getlantern/systray/README.md
blob: c6d11303421dfd6e75bc9e42349b337bbc89c4cb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
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
```go
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")
}

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

```sh
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.

```sh
go get
go run main.go
```

## Credits

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