Unison

A unified graphical user experience toolkit for Go desktop applications. macOS, Windows, and Linux are supported.

Required setup

Unison is built upon glfw. As such, it requires some setup prior to being able to build correctly:

On macOS, you need Xcode or Command Line Tools for Xcode (xcode-select --install) for required headers and libraries.
On Ubuntu/Debian-like Linux distributions, you need libgl1-mesa-dev and xorg-dev packages.
On CentOS/Fedora-like Linux distributions, you need libX11-devel libXcursor-devel libXrandr-devel libXinerama-devel mesa-libGL-devel libXi-devel libXxf86vm-devel packages.
On Windows, you need https://jmeubank.github.io/tdm-gcc/download/ as well as https://git-scm.com for its bash shell.
See compilation dependencies for full details.

This version of Unison was built using Go 1.21. It has been compiled under many earlier versions of Go in the past, but only Go 1.21+ will be considered as I make further changes.

Example

An example application can be found in the example directory:

go run example/main.go

Notes

Unison was developed with the needs of my personal projects in mind, so may not be a good fit for your particular needs. I'm open to suggestions on ways to improve the code and will happily consider Pull Requests with bug fixes or feature additions.

Compatibility

Unison is very much a work in progress. As such, it is likely to have breaking changes. To reflect this, a version number of 0.x.x will be in use until such time that I'm comfortable locking things down to ensure compatibility between releases. Please keep this in mind when making the decision to use Unison in your own code.

Look & Feel

Unison defines its own look and feel for widgets and will likely be adjusted over time. This was done to provide as much consistency as possible between all supported platforms. It also side-steps issues where a given platform itself has no or poorly defined standards. Colors, fonts, spacing, how the widgets behave, and more are customizable, so if you are feeling particularly ambitious, you could create your own theming that matches a given platform.

Organization

There are a large number of Go source files in a single, top-level package. Unison didn't start out this way, but user experience code tends to need to have its tentacles in many places, and the logical separations I made kept hindering the ability to do things. Ultimately, I made the decision to collapse nearly everything into a single package to simplify development and greatly reduce the overall complexity of things.

Name		Name	Last commit message	Last commit date
Latest commit History 547 Commits
.github		.github
.vscode		.vscode
enums		enums
example		example
gen		gen
internal		internal
printing		printing
resources		resources
.gitattributes		.gitattributes
.gitignore		.gitignore
.golangci.yml		.golangci.yml
LICENSE		LICENSE
README.md		README.md
action.go		action.go
aliases.go		aliases.go
app.go		app.go
app_darwin.go		app_darwin.go
app_linux.go		app_linux.go
app_windows.go		app_windows.go
border.go		border.go
build.sh		build.sh
button.go		button.go
canvas.go		canvas.go
cell_factory.go		cell_factory.go
check_box.go		check_box.go
clipboard.go		clipboard.go
color.go		color.go
color_filter.go		color_filter.go
color_test.go		color_test.go
compound_border.go		compound_border.go
console.go		console.go
console_other.go		console_other.go
console_windows.go		console_windows.go
cursor.go		cursor.go
dialog.go		dialog.go
dialog_button_info.go		dialog_button_info.go
display.go		display.go
dock.go		dock.go
dock_container.go		dock_container.go
dock_container_content.go		dock_container_content.go
dock_header.go		dock_header.go
dock_layout.go		dock_layout.go
dock_state.go		dock_state.go
dock_tab.go		dock_tab.go
drawable.go		drawable.go
dynamic_color.go		dynamic_color.go
dynamic_font.go		dynamic_font.go
empty_border.go		empty_border.go
field.go		field.go
file_dialog.go		file_dialog.go
flex_layout.go		flex_layout.go
flow_layout.go		flow_layout.go
font.go		font.go
font_descriptor.go		font_descriptor.go
font_face.go		font_face.go
font_face_descriptor.go		font_face_descriptor.go
font_family.go		font_family.go
go.mod		go.mod
go.sum		go.sum
gradient.go		gradient.go
group.go		group.go
group_panel.go		group_panel.go
helpers.go		helpers.go
image.go		image.go
image_filter.go		image_filter.go
images.go		images.go
indirect_color.go		indirect_color.go
indirect_font.go		indirect_font.go
ink.go		ink.go
input_callbacks.go		input_callbacks.go
key_binding.go		key_binding.go
keys.go		keys.go
label.go		label.go
layout.go		layout.go
line_border.go		line_border.go
link.go		link.go
list.go		list.go
markdown.go		markdown.go
mask_filter.go		mask_filter.go
menu.go		menu.go
menu_bar.go		menu_bar.go
menu_bar_darwin.go		menu_bar_darwin.go
menu_bar_other.go		menu_bar_other.go
menu_darwin.go		menu_darwin.go
menu_factory.go		menu_factory.go
menu_factory_darwin.go		menu_factory_darwin.go
menu_factory_other.go		menu_factory_other.go
menu_item.go		menu_item.go
menu_item_darwin.go		menu_item_darwin.go
modifiers.go		modifiers.go
modifiers_darwin.go		modifiers_darwin.go
modifiers_other.go		modifiers_other.go
numeric_field.go		numeric_field.go
open_dialog.go		open_dialog.go
open_dialog_darwin.go		open_dialog_darwin.go
open_dialog_linux.go		open_dialog_linux.go
open_dialog_windows.go		open_dialog_windows.go
paint.go		paint.go
panel.go		panel.go
path.go		path.go

License

richardwilkes/unison

Folders and files

Latest commit

History