Golang terminal dashboard
Go to file
2018-12-28 13:07:47 -08:00
_examples Update readme; add hello_world.go 2018-11-29 15:52:53 -08:00
scripts Misc 2018-11-28 21:50:10 -08:00
test Build ignore test/log_events.go 2018-12-28 13:07:47 -08:00
.gitignore Remove panicparse 2018-09-06 13:57:56 -07:00
.travis.yml Update travis config 2015-03-20 13:06:29 -04:00
barchart.go Minor refactor 2018-09-06 14:48:09 -07:00
block_common.go Update copyright 2017-01-14 01:07:43 -05:00
block_test.go Minor refactor 2018-09-06 14:48:09 -07:00
block_windows.go add missing characters 2017-07-17 19:24:37 +09:00
block.go Minor refactor 2018-09-06 14:48:09 -07:00
buffer_test.go Update copyright 2017-01-14 01:07:43 -05:00
buffer.go Update copyright 2017-01-14 01:07:43 -05:00
canvas_test.go Misc 2018-11-28 21:50:10 -08:00
canvas.go Update copyright 2017-01-14 01:07:43 -05:00
CHANGELOG.md Fix and rename PollEvents 2018-11-29 15:19:07 -08:00
doc.go Update godoc 2018-11-28 20:38:11 -08:00
events_test.go Update copyright 2017-01-14 01:07:43 -05:00
events.go Fix and rename PollEvents 2018-11-29 15:19:07 -08:00
gauge.go Minor refactor 2018-09-06 14:48:09 -07:00
go.mod Migrate from dep to vgo 2018-11-22 13:02:44 -08:00
go.sum Migrate from dep to vgo 2018-11-22 13:02:44 -08:00
grid_test.go Update copyright 2017-01-14 01:07:43 -05:00
grid.go spelling: implements 2016-03-14 05:47:25 +00:00
LICENSE Initial commit 2015-02-03 09:09:27 -05:00
linechart_others.go Update copyright 2017-01-14 01:07:43 -05:00
linechart_windows.go Update copyright 2017-01-14 01:07:43 -05:00
linechart.go Minor refactor 2018-09-06 14:48:09 -07:00
list.go Minor refactor 2018-09-06 14:48:09 -07:00
paragraph_test.go Fix par_test file name 2018-12-01 20:23:24 -08:00
paragraph.go Rename Par to Paragraph 2018-11-28 18:25:38 -08:00
piechart.go Cleanup piechart 2018-08-16 20:22:32 -07:00
position_test.go Rename files 2018-12-03 15:03:44 -08:00
position.go Rename files 2018-12-03 15:03:44 -08:00
README.md Update readme; add hello_world.go 2018-11-29 15:52:53 -08:00
render.go Rework events (again) 2018-11-28 18:19:34 -08:00
sparkline.go Minor refactor 2018-09-06 14:48:09 -07:00
stacked_barchart.go Rename files 2018-12-03 15:03:44 -08:00
table.go Minor refactor 2018-09-06 14:48:09 -07:00
tabpane.go Refactor tabpane 2018-11-29 09:41:29 -08:00
textbuilder_test.go Update copyright 2017-01-14 01:07:43 -05:00
textbuilder.go 256 color support 2018-08-16 19:02:36 -07:00
theme_test.go Update copyright 2017-01-14 01:07:43 -05:00
theme.go Minor refactor 2018-09-06 14:48:09 -07:00
utils_test.go Rename files 2018-12-03 15:03:44 -08:00
utils.go Rename files 2018-12-03 15:03:44 -08:00
widget.go Rework event system 2018-09-06 16:43:11 -07:00

termui

Build Status Doc Status

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

termui is a cross-platform, easy-to-compile, and fully-customizable terminal dashboard built on top of termbox-go. It is inspired by blessed-contrib and written purely in Go.

termui is currently undergoing some API changes so make sure to check the changelog when upgrading

Installation

Installing from the master branch is recommended:

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

Usage

Hello World

package main

import ui "github.com/gizak/termui"

func main() {
	err := ui.Init()
	if err != nil {
		panic(err)
	}
	defer ui.Close()

	p := ui.NewParagraph("Hello World!")
	p.Width = 25
	p.Height = 5
	ui.Render(p)

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

Widgets

Click image to see the corresponding demo codes.

barchart gauge linechart list paragraph sparklines stackedbarchart table

Examples

Examples can be found in _examples. Run with go run _examples/... or run all of them consecutively with ./scripts/run_examples.py.

Documentation

  • godoc for code documentation
  • wiki for general information

Uses

License

This library is under the MIT License