Golang terminal dashboard
Go to file
Caleb Bassi 3157ce5f38 Update readme 2019-01-23 23:20:48 -08:00
_assets Refactor README and remove widget screenshots 2019-01-23 23:09:50 -08:00
_examples Refactor README and remove widget screenshots 2019-01-23 23:09:50 -08:00
_scripts The Great Rewrite 2019-01-23 20:16:13 -08:00
_test The Great Rewrite 2019-01-23 20:16:13 -08:00
widgets The Great Rewrite 2019-01-23 20:16:13 -08:00
.gitignore The Great Rewrite 2019-01-23 20:16:13 -08:00
CHANGELOG.md Update changelog dates 2019-01-23 21:10:14 -08:00
LICENSE Initial commit 2015-02-03 09:09:27 -05:00
Makefile The Great Rewrite 2019-01-23 20:16:13 -08:00
README.md Update readme 2019-01-23 23:20:48 -08:00
alignment.go The Great Rewrite 2019-01-23 20:16:13 -08:00
block.go The Great Rewrite 2019-01-23 20:16:13 -08:00
buffer.go The Great Rewrite 2019-01-23 20:16:13 -08:00
canvas.go The Great Rewrite 2019-01-23 20:16:13 -08:00
doc.go Update godoc 2018-11-28 20:38:11 -08:00
events.go The Great Rewrite 2019-01-23 20:16:13 -08:00
go.mod The Great Rewrite 2019-01-23 20:16:13 -08:00
go.sum The Great Rewrite 2019-01-23 20:16:13 -08:00
grid.go The Great Rewrite 2019-01-23 20:16:13 -08:00
render.go The Great Rewrite 2019-01-23 20:16:13 -08:00
style.go The Great Rewrite 2019-01-23 20:16:13 -08:00
symbols.go The Great Rewrite 2019-01-23 20:16:13 -08:00
symbols_other.go The Great Rewrite 2019-01-23 20:16:13 -08:00
symbols_windows.go The Great Rewrite 2019-01-23 20:16:13 -08:00
termbox.go The Great Rewrite 2019-01-23 20:16:13 -08:00
text_parser.go The Great Rewrite 2019-01-23 20:16:13 -08:00
theme.go theme: Set default colors to ColorWhite 2019-01-23 21:36:58 -08:00
utils.go The Great Rewrite 2019-01-23 20:16:13 -08:00

README.md

termui

demo cast under osx 10.10; Terminal.app; Menlo Regular 12pt.)

termui is a cross-platform and fully-customizable terminal dashboard and widget library built on top of termbox-go. It is inspired by blessed-contrib and tui-rs and written purely in Go.

The core components of termui include:

  • built in widget implementations for common use cases
  • utilities to create custom widgets
  • a Grid for relative widget positioning
  • an event system for keyboard, mouse and resizing events
  • colors and styling

Installation

Installing from the master branch is recommended:

go get -u github.com/gizak/termui@master

Note: termui is currently undergoing API changes so make sure to check the changelog when upgrading. If you upgrade and notice something is missing or don't like a change, revert the upgrade and open an issue.

Widgets

Run an example with go run _examples/{example}.go or run all of them consecutively with make run-examples.

Documentation

Uses

License

MIT