Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ncruces/zenity

Zenity dialogs for Golang, Windows, macOS
https://github.com/ncruces/zenity

macos no-cgo windows zenity

Last synced: about 2 months ago
JSON representation

Zenity dialogs for Golang, Windows, macOS

Host: GitHub
URL: https://github.com/ncruces/zenity
Owner: ncruces
License: mit
Created: 2019-12-10T10:51:20.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2024-06-26T17:33:38.000Z (3 months ago)
Last Synced: 2024-06-26T22:08:02.239Z (3 months ago)
Topics: macos, no-cgo, windows, zenity
Language: Go
Homepage: https://pkg.go.dev/github.com/ncruces/zenity
Size: 604 KB
Stars: 672
Watchers: 6
Forks: 35
Open Issues: 1
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-go - zenity - Cross-platform Go library and CLI to create simple dialogs that interact graphically with the user. (GUI / Search and Analytic Databases)
awesomeLibrary - zenity - Zenity dialogs for Golang, Windows, macOS. (语言资源库 / go)
my-awesome - ncruces/zenity - cgo,windows,zenity pushed_at:2024-09 star:0.7k fork:0.0k Zenity dialogs for Golang, Windows, macOS (Go)

README

        # Zenity dialogs for Golang, Windows and macOS

[![Go Reference](https://pkg.go.dev/badge/image)](https://pkg.go.dev/github.com/ncruces/zenity)

[![Go Report](https://goreportcard.com/badge/github.com/ncruces/zenity)](https://goreportcard.com/report/github.com/ncruces/zenity)

[![Go Coverage](https://github.com/ncruces/zenity/wiki/coverage.svg)](https://raw.githack.com/wiki/ncruces/zenity/coverage.html)

[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](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`.