mirror of
https://github.com/nkanaev/yarr.git
synced 2026-04-30 22:37:42 +00:00
switch to fyne.io/systray
This commit is contained in:
nkanaev
147
vendor/fyne.io/systray/README.md
generated
vendored
Normal file
147
vendor/fyne.io/systray/README.md
generated
vendored
Normal file
@@ -0,0 +1,147 @@
|
||||
# Systray
|
||||
|
||||
systray is a cross-platform Go library to place an icon and menu in the notification area.
|
||||
This repository is a fork of [getlantern/systray](https://github.com/getlantern/systray)
|
||||
removing the GTK dependency and support for legacy linux system tray.
|
||||
|
||||
## Features
|
||||
|
||||
* Supported on Windows, macOS, Linux and many BSD systems
|
||||
* Menu items can be checked and/or disabled
|
||||
* Methods may be called from any Goroutine
|
||||
|
||||
## API
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import "fyne.io/systray"
|
||||
import "fyne.io/systray/example/icon"
|
||||
|
||||
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.
|
||||
mQuit.SetIcon(icon.Data)
|
||||
}
|
||||
|
||||
func onExit() {
|
||||
// clean up here
|
||||
}
|
||||
```
|
||||
|
||||
### Running in a Fyne app
|
||||
|
||||
This repository is designed to allow any toolkit to integrate system tray without any additional dependencies.
|
||||
It is maintained by the Fyne team, but if you are using Fyne there is an even easier to use API in the main repository that wraps this project.
|
||||
|
||||
In your app you can use a standard `fyne.Menu` structure and pass it to `SetSystemTrayMenu` when your app is a desktop app, as follows:
|
||||
|
||||
```go
|
||||
menu := fyne.NewMenu("MyApp",
|
||||
fyne.NewMenuItem("Show", func() {
|
||||
log.Println("Tapped show")
|
||||
}))
|
||||
|
||||
if desk, ok := myApp.(desktop.App); ok {
|
||||
desk.SetSystemTrayMenu(menu)
|
||||
}
|
||||
```
|
||||
|
||||
You can find out more in the toolkit documentation:
|
||||
[System Tray Menu](https://developer.fyne.io/explore/systray).
|
||||
|
||||
### Run in another toolkit
|
||||
|
||||
Most graphical toolkits will grab the main loop so the `Run` code above is not possible.
|
||||
For this reason there is another entry point `RunWithExternalLoop`.
|
||||
This function of the library returns a start and end function that should be called
|
||||
when the application has started and will end, to loop in appropriate features.
|
||||
|
||||
See [full API](https://pkg.go.dev/fyne.io/systray?tab=doc) as well as [CHANGELOG](https://github.com/fyne-io/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 or Linux:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/fyne-io/systray
|
||||
cd systray/example
|
||||
go run .
|
||||
```
|
||||
|
||||
On Windows, you should follow the instructions above, but use the followign run command:
|
||||
|
||||
```
|
||||
go run -ldflags "-H=windowsgui" .
|
||||
```
|
||||
|
||||
Now look for *Awesome App* in your menu bar!
|
||||
|
||||
|
||||
|
||||
## Platform notes
|
||||
|
||||
### Linux/BSD
|
||||
|
||||
This implementation uses DBus to communicate through the SystemNotifier/AppIndicator spec, older tray implementations may not load the icon.
|
||||
|
||||
If you are running an older desktop environment, or system tray provider, you may require a proxy app which can convert the new DBus calls to the old format.
|
||||
The recommended tool for Gnome based trays is [snixembed](https://git.sr.ht/~steef/snixembed), others are available.
|
||||
Search for "StatusNotifierItems XEmbedded" in your package manager.
|
||||
|
||||
### Windows
|
||||
|
||||
* To avoid opening a console at application startup, use "fyne package" for your app or manually 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 use "fyne package" or add folders with the following minimal structure and assets:
|
||||
|
||||
```
|
||||
SystrayApp.app/
|
||||
Contents/
|
||||
Info.plist
|
||||
MacOS/
|
||||
go-executable
|
||||
Resources/
|
||||
SystrayApp.icns
|
||||
```
|
||||
|
||||
If bundling manually, you may want to add one or both of the following to your Info.plist:
|
||||
|
||||
```xml
|
||||
<!-- avoid having a blurry icon and text -->
|
||||
<key>NSHighResolutionCapable</key>
|
||||
<string>True</string>
|
||||
|
||||
<!-- avoid showing the app on the Dock -->
|
||||
<key>LSUIElement</key>
|
||||
<string>1</string>
|
||||
```
|
||||
|
||||
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/getlantern/systray
|
||||
- https://github.com/xilp/systray
|
||||
- https://github.com/cratonica/trayhost
|
||||
Reference in New Issue
Block a user