Gio implements portable immediate mode GUI programs in Go. Gio programs run on all the major platforms: iOS/tvOS, Android, Linux (Wayland/X11), macOS, Windows, FreeBSD, OpenBSD, and experimental support for browsers (Webassembly/WebGL). There is a unikernel port for running Gio programs in virtual machines.
Gio includes an efficient vector renderer based on the Pathfinder project, and an experimental renderer based on the piet-gpu project. Both renderers support Vulkan, Metal, Direct3D 11, and OpenGL ES. For low-end devices there is a CPU fallback that runs on unextended OpenGL ES 2.0.
Text and other shapes are rendered using only their outlines without baking them into texture images, to support efficient animations, transformed drawing and display resolution independence.
This is a screenshot of the Kitchen example. If your browser supports WebAssembly and WebGL, run the example by pressing the run button.
The architecture document is a good introduction to Gio concepts and API.
The examples give a feel of the structure of typical Gio programs.
Jon Strand’s tutorial is an great step-by-step guide to writing Gio programs.
The “Immediate Mode GUI Programming” article compares Gio’s immediate mode design with the traditional retained mode APIs such as the browser DOM.
The layout package implements useful layouts, while the widget and widget/material packages implement common user interface widgets. The gesture package detects common gestures from lower-level input events.
Layouts, widgets and gestures are all implemented in terms of operations.
Gio is designed to work with very few dependencies. It depends only on the platform libraries for window management, input and GPU drawing.
Gio supports the latest released version of Go in module mode. Earlier versions of Go and GOPATH mode might work, but no effort is made to keep them working.
Running Gio programs
go tool to initialize a new module and run the “hello”
$ go mod init example.com $ go run gioui.org/example/hello
should display a simple message in a window.
$ go run gioui.org/example/kitchen
is another example that demonstrates the material design widgets.
Running on mobiles
For Android, iOS, tvOS the
gogio tool can build and package a Gio program for you.
To build an Android .apk file from the
$ go run gioui.org/cmd/gogio -target android gioui.org/example/kitchen
To build for the iOS simulator:
$ go run gioui.org/cmd/gogio -target ios -appid <bundle-id> gioui.org/example/kitchen
See the running on mobile page for more information.
To run a Gio program in a compatible browser, the
gogio tool can output a directory ready to
serve. With the
goexec tool you don’t even need a web server:
$ go run gioui.org/cmd/gogio -target js gioui.org/example/kitchen $ go get github.com/shurcooL/goexec $ goexec 'http.ListenAndServe(":8080", http.FileServer(http.Dir("kitchen")))'
Open http://localhost:8080 in a browser to run the program.
Integration with existing projects
See the integration guide for details on using Gio with existing projects.
Programs using Gio
- godcr, a cross-platform desktop wallet for the Decred cryptocurrency.
- sprig, a client for the Arbor chat system.
- Tailscale, a Tailscale Android client.
- Protonet, a peer-to-peer chat application. GitHub Repo
- Wormhole William, an end-to-end encrypted file transfer application using the Magic Wormhole protocol. GitHub repository.
- Sointu, a modular software synthesizer to easily produce music for 4k intros.
- Photon, a fast RSS reader as light as a photon.
- gio-x extends Gio with features not (yet) available in the core library.
- Immediate Mode GUI Programming
- Gophercon 2019 talk about Gio and Scatter. Slides, Demos.
- Gophercon UK 2019 talk demonstrating a Gio program built from scratch. Slides, Demos.
- Community Calls
File bugs and TODOs through the issue tracker or send an email to ~firstname.lastname@example.org. For general discussion, use the ~email@example.com mailing list or the #gioui Gophers Slack workspace (Need an invite to gophers slack?.
Post patches to the gio-patches list. No Sourcehut account is required and you can post without being subscribed.
You can also use the Sourcehut web-based flow for submitting patches, similar to other source forges. See the contribution guide for more details.
Development of Gio is funded by sponsorships. If you find Gio useful, please consider sponsoring the project on OpenCollective or one or more of its developers directly.