92 lines
4.0 KiB
Markdown
92 lines
4.0 KiB
Markdown
# Zenity dialogs for Golang, Windows and macOS
|
|
|
|
[](https://pkg.go.dev/github.com/ncruces/zenity)
|
|
[](https://goreportcard.com/report/github.com/ncruces/zenity)
|
|
[](https://raw.githack.com/wiki/ncruces/zenity/coverage.html)
|
|
[](https://github.com/avelino/awesome-go)
|
|
|
|
This repo includes:
|
|
- a cross-platform [Go](https://go.dev/) package providing
|
|
[Zenity](https://help.gnome.org/users/zenity/stable/)-like dialogs
|
|
(simple dialogs that interact graphically with the user)
|
|
- a *“port”* of the `zenity` command to both Windows and macOS based on that library.
|
|
|
|
Implemented dialogs:
|
|
* [message](https://github.com/ncruces/zenity/wiki/Message-dialog) (error, info, question, warning)
|
|
* [text entry](https://github.com/ncruces/zenity/wiki/Text-entry-dialog)
|
|
* [list](https://github.com/ncruces/zenity/wiki/List-dialog) (simple)
|
|
* [password](https://github.com/ncruces/zenity/wiki/Password-dialog)
|
|
* [file selection](https://github.com/ncruces/zenity/wiki/File-selection-dialog)
|
|
* [color selection](https://github.com/ncruces/zenity/wiki/Color-selection-dialog)
|
|
* [calendar](https://github.com/ncruces/zenity/wiki/Calendar-dialog)
|
|
* [progress](https://github.com/ncruces/zenity/wiki/Progress-dialog)
|
|
* [notification](https://github.com/ncruces/zenity/wiki/Notification)
|
|
|
|
Behavior on Windows, macOS and other Unixes might differ slightly.
|
|
Some of that is intended (reflecting platform differences),
|
|
other bits are unfortunate limitations.
|
|
|
|
## Installing
|
|
|
|
The Go package:
|
|
|
|
go get github.com/ncruces/zenity@latest
|
|
|
|
The `zenity` command on macOS/WSL using [Homebrew](https://brew.sh/) 🍺:
|
|
|
|
brew install ncruces/tap/zenity
|
|
|
|
The `zenity` command on Windows using [Scoop](https://scoop.sh/) 🍨:
|
|
|
|
scoop install https://ncruces.github.io/scoop/zenity.json
|
|
|
|
The `zenity` command on macOS/Windows, if you have [Go](https://go.dev/):
|
|
|
|
go install github.com/ncruces/zenity/cmd/zenity@latest
|
|
|
|
Or download the [latest release](https://github.com/ncruces/zenity/releases/latest).
|
|
|
|
## Using
|
|
|
|
For the Go package, consult the [documentation](https://pkg.go.dev/github.com/ncruces/zenity#section-documentation)
|
|
and [examples](https://pkg.go.dev/github.com/ncruces/zenity#pkg-examples).
|
|
|
|
The `zenity` command does its best to be compatible with the GNOME version.\
|
|
Consult the [documentation](https://help.gnome.org/users/zenity/stable/)
|
|
and [man page](https://linux.die.net/man/1/zenity) of that command.
|
|
|
|
## Why?
|
|
|
|
#### Benefits of the Go package:
|
|
|
|
* no `cgo` (see [benefits](https://dave.cheney.net/2016/01/18/cgo-is-not-go), mostly cross-compilation)
|
|
* no main loop (or any other threading or initialization requirements)
|
|
* cancelation through [`context`](https://golang.org/pkg/context/)
|
|
* on Windows:
|
|
* no additional dependencies
|
|
* Explorer shell not required
|
|
* works in Server Core
|
|
* Unicode support
|
|
* High DPI (no manifest required)
|
|
* Visual Styles (no manifest required)
|
|
* WSL/Cygwin/MSYS2 [support](https://github.com/ncruces/zenity/wiki/Zenity-for-WSL,-Cygwin,-MSYS2)
|
|
* on macOS:
|
|
* only dependency is `osascript`
|
|
* on other Unixes:
|
|
* wraps either one of `zenity`, `matedialog`, [`qarma`](https://github.com/luebking/qarma)
|
|
|
|
## Zenity wrappers
|
|
|
|
Zenity wrappers for languages other than Go can benefit from our `zenity` command. On Unix (Linux, FreeBSD, etc) they can use the original tool, and on Windows/macOS they may use the command from this repo for portability.
|
|
|
|
Examples:
|
|
- NodeJS [`dialog-gui`](https://github.com/SnurfDev/dialog-gui) by [@SnurfDev](https://github.com/SnurfDev/dialog-gui)
|
|
- Crystal [`zenity.cr`](https://github.com/kojix2/zenity.cr) by [@kojix2](https://github.com/kojix2/)
|
|
|
|
## Credits
|
|
|
|
I'd like to thank all [contributors](https://github.com/ncruces/zenity/graphs/contributors),
|
|
but [@gen2brain](https://github.com/gen2brain) in particular
|
|
for [`dlgs`](https://github.com/gen2brain/dlgs),
|
|
which was instrumental to the Windows port of `zenity`.
|