Golang terminal dashboard

Go to file

Caleb Bassi 0e17689956 Update changelog dates		2019-01-23 21:10:14 -08:00
_assets	The Great Rewrite	2019-01-23 20:16:13 -08:00
_examples	The Great Rewrite	2019-01-23 20:16:13 -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
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
CHANGELOG.md	Update changelog dates	2019-01-23 21:10:14 -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
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	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_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
symbols.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	The Great Rewrite	2019-01-23 20:16:13 -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 written purely in Go.

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.

Usage

Hello World

package main

import (
	"log"

	ui "github.com/gizak/termui"
	"github.com/gizak/termui/widgets"
)

func main() {
	if err := ui.Init(); err != nil {
		log.Fatalf("failed to initialize termui: %v", err)
	}
	defer ui.Close()

	p := widgets.NewParagraph()
	p.Text = "Hello World!"
	p.SetRect(0, 0, 25, 5)

	ui.Render(p)

	for e := range ui.PollEvents() {
		if e.Type == ui.KeyboardEvent {
			break
		}
	}
}