Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/google/gxui
An experimental Go cross platform UI library.
https://github.com/google/gxui
Last synced: about 2 months ago
JSON representation
An experimental Go cross platform UI library.
- Host: GitHub
- URL: https://github.com/google/gxui
- Owner: google
- License: bsd-3-clause
- Archived: true
- Created: 2015-03-16T17:12:37.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-11-23T11:56:43.000Z (almost 4 years ago)
- Last Synced: 2024-09-20T19:01:45.247Z (about 2 months ago)
- Language: Go
- Homepage:
- Size: 1.58 MB
- Stars: 4,438
- Watchers: 313
- Forks: 299
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
GXUI - A Go cross platform UI library.
=======
[](https://gitter.im/google/gxui?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://travis-ci.org/google/gxui) [](https://godoc.org/github.com/google/gxui)
Notice:
---
Unfortunately due to a shortage of hours in a day, GXUI is no longer maintained.
If you're looking for a GUI library for your next Go project, [check out these alternatives](https://github.com/avelino/awesome-go#gui).
Disclaimer
---
The code is mostly undocumented, and is certainly **not idiomatic Go**.
This is not an official Google product (experimental or otherwise), it is just code that happens to be owned by Google.
Dependencies
---
### Linux:
In order to build GXUI on linux, you will need the following packages installed:
sudo apt-get install libxi-dev libxcursor-dev libxrandr-dev libxinerama-dev mesa-common-dev libgl1-mesa-dev libxxf86vm-dev
### Common:
After setting up ```GOPATH``` (see [Go documentation](https://golang.org/doc/code.html)), you can then fetch the GXUI library and its dependencies:
go get -u github.com/google/gxui/...
Samples
---
Samples can be found in [`gxui/samples`](https://github.com/google/gxui/tree/master/samples).
To build all samples run:
go install github.com/google/gxui/samples/...
And they will be built into ```GOPATH/bin```.
If you add ```GOPATH/bin``` to your PATH, you can simply type the name of a sample to run it. For example: ```image_viewer```.
Web
---
gxui code is cross platform and can be compiled using GopherJS to JavaScript, allowing it to run in browsers with WebGL support. To do so, you'll need the [GopherJS compiler](https://github.com/gopherjs/gopherjs) and some additional dependencies:
go get -u github.com/gopherjs/gopherjs
go get -u -d -tags=js github.com/google/gxui/...
Afterwards, you can try the samples by running `gopherjs serve` command and opening in a browser.
Fonts
---
Many of the samples require a font to render text. The dark theme (and currently the only theme) uses `Roboto`.
This is built into the gxfont package.
Make sure to mention this font in any notices file distributed with your application.
Contributing
---
GXUI was written by a couple of Googlers as an experiment and is now unmaintained.
Contributions, however small, will require the author to have signed the [Google Individual Contributor License Agreement](https://developers.google.com/open-source/cla/individual?csw=1).
The CLA is necessary mainly because you own the copyright to your changes, even after your contribution becomes part of our codebase, so we need your permission to use and distribute your code. We also need to be sure of various other things—for instance that you'll tell us if you know that your code infringes on other people's patents. You don't have to sign the CLA until after you've submitted your code for review and a member has approved it, but you must do it before we can put your code into our codebase. Before you start working on a larger contribution, you should get in touch with us first through the issue tracker with your idea so that we can help out and possibly guide you. Coordinating up front makes it much easier to avoid frustration later on.