Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/getlantern/systray
a cross platfrom Go library to place an icon and menu in the notification area
https://github.com/getlantern/systray
Last synced: 5 days ago
JSON representation
a cross platfrom Go library to place an icon and menu in the notification area
- Host: GitHub
- URL: https://github.com/getlantern/systray
- Owner: getlantern
- License: apache-2.0
- Created: 2014-11-12T03:41:57.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-07-03T04:41:06.000Z (7 months ago)
- Last Synced: 2025-01-14T07:06:57.219Z (12 days ago)
- Language: Go
- Homepage:
- Size: 52.5 MB
- Stars: 3,376
- Watchers: 67
- Forks: 468
- Open Issues: 109
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - systray - Cross platform Go library to place an icon and menu in the notification area. (GUI / Search and Analytic Databases)
- stars - getlantern/systray
- awesome-repositories - getlantern/systray - a cross platfrom Go library to place an icon and menu in the notification area (Go)
- go-awesome - systray - Cross-platform support for menu bar management (Open source library / Desktop Development)
- awesome-go - systray - a cross platfrom Go library to place an icon and menu in the notification area - ★ 551 (GUI)
- awesome-go - systray - Cross platform Go library to place an icon and menu in the notification area. Stars:`3.4K`. (GUI / Search and Analytic Databases)
- awesome-go - systray - 用于创建系统通知区域图标的跨平台库。 (常用的GUI开发库 / 交互工具)
README
# systray
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
* Most functions may be called from any goroutine
## API
```go
func 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 and Windows.
mQuit.SetIcon(icon.Data)
}
func onExit() {
// clean up here
}
```
See [](https://pkg.go.dev/github.com/getlantern/systray) as well as [CHANGELOG](https://github.com/getlantern/systray/tree/master/CHANGELOG.md).
Note: this package requires cgo, so make sure you set `CGO_ENABLED=1` before building.
## Try the example app!
Have go v1.12+ or higher installed? Here's an example to get started on macOS:
```sh
git clone https://github.com/getlantern/systray
cd systray/example
env GO111MODULE=on go build
./example
```
On Windows, you should build like this:
```
env GO111MODULE=on go build -ldflags "-H=windowsgui"
```
Now look for *Awesome App* in your menu bar!
## The Webview example
The code under `webview_example` is to demostrate how it can co-exist with other UI elements. Note that the example doesn't work on macOS versions older than 10.15 Catalina.
## Platform notes
### Linux
* Building apps requires gcc as well as the `gtk3` and `libayatana-appindicator3` development headers to be installed. For Debian or Ubuntu, you may install these using:
```sh
sudo apt-get install gcc libgtk-3-dev libayatana-appindicator3-dev
```
On Linux Mint, `libxapp-dev` is also required.
If you need to support the older `libappindicator3` library instead, you can pass the build flag `legacy_appindicator`
when building. For example:
```
go build -tags=legacy_appindicator
```
To build `webview_example`, you also need to install `libwebkit2gtk-4.0-dev` and remove `webview_example/rsrc.syso` which is required on Windows.
### Windows
* To avoid opening a console at application startup, use these compile flags:
```sh
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
```
When running as an app bundle, you may want to add one or both of the following to your Info.plist:
```xml
NSHighResolutionCapable
True
LSUIElement
1
```
Consult the [Official Apple Documentation here](https://developer.apple.com/library/archive/documentation/CoreFoundation/Conceptual/CFBundles/BundleTypes/BundleTypes.html#//apple_ref/doc/uid/10000123i-CH101-SW1).
On macOS, it's possible to set the underlying
[`NSStatusItemBehavior`](https://developer.apple.com/documentation/appkit/nsstatusitembehavior?language=objc)
with `systray.SetRemovalAllowed(true)`. When enabled, the user can cmd-drag the
icon off the menu bar.
## Credits
- https://github.com/xilp/systray
- https://github.com/cratonica/trayhost