Golang terminal dashboard (evacuated from NSA/Microsoft Github)

anonymous af568e536b nitpick who maintains пре 5 година
_docs 91b776e7aa packaging пре 6 година
_example 8d977ebe58 typo? пре 5 година
_test de04c28ea9 no longer build test by default, minor tweaks пре 6 година
debian af568e536b nitpick who maintains пре 5 година
debug 1fd509e58d Fix https://github.com/gizak/termui/issues/97 пре 7 година
extra 91b776e7aa packaging пре 6 година
.travis.yml bffab774f5 Update travis config пре 9 година
LICENSE fff745a9a0 Initial commit пре 9 година
README.md 91b776e7aa packaging пре 6 година
barchart.go ba69a564f2 Fix a couple small typos пре 7 година
block.go d921faeffe Update copyright пре 7 година
block_common.go d921faeffe Update copyright пре 7 година
block_test.go d921faeffe Update copyright пре 7 година
block_windows.go 6d9a109edf add missing characters пре 7 година
buffer.go d921faeffe Update copyright пре 7 година
buffer_test.go d921faeffe Update copyright пре 7 година
canvas.go d921faeffe Update copyright пре 7 година
canvas_test.go d921faeffe Update copyright пре 7 година
config.py d921faeffe Update copyright пре 7 година
doc.go d22d4fac69 de-githubbing пре 5 година
events.go 3b3aa549db expose ResetHandlers пре 7 година
events_test.go d921faeffe Update copyright пре 7 година
gauge.go d921faeffe Update copyright пре 7 година
glide.yaml 91b776e7aa packaging пре 6 година
grid.go d22d4fac69 de-githubbing пре 5 година
grid_test.go d921faeffe Update copyright пре 7 година
helper.go ba69a564f2 Fix a couple small typos пре 7 година
helper_test.go d921faeffe Update copyright пре 7 година
linechart.go 0f42a2ee00 Merge branch 'martinlindhe-linechart-auto-height' пре 7 година
linechart_others.go d921faeffe Update copyright пре 7 година
linechart_windows.go d921faeffe Update copyright пре 7 година
list.go d22d4fac69 de-githubbing пре 5 година
mbarchart.go 23118e571a spelling: previous пре 8 година
mkdocs.yml 91b776e7aa packaging пре 6 година
par.go d921faeffe Update copyright пре 7 година
par_test.go d921faeffe Update copyright пре 7 година
pos.go d921faeffe Update copyright пре 7 година
pos_test.go d921faeffe Update copyright пре 7 година
render.go 8ae812e738 building, but empty debian package пре 6 година
sparkline.go 6b3d91f8d1 spelling: sparklines пре 8 година
table.go d921faeffe Update copyright пре 7 година
textbuilder.go d921faeffe Update copyright пре 7 година
textbuilder_test.go d921faeffe Update copyright пре 7 година
theme.go d921faeffe Update copyright пре 7 година
theme_test.go d921faeffe Update copyright пре 7 година
widget.go d921faeffe Update copyright пре 7 година

README.md

termui

termui is a cross-platform, easy-to-compile, and fully-customizable terminal dashboard. It is inspired by blessed-contrib, but purely in Go. It used to be hosted on github.

Layout

To use termui, the very first thing you may want to know is how to manage layout. termui offers two ways of doing this, known as absolute layout and grid layout.

Absolute layout

Each widget has an underlying block structure which basically is a box model. It has border, label and padding properties. A border of a widget can be chosen to hide or display (with its border label), you can pick a different front/back colour for the border as well. To display such a widget at a specific location in terminal window, you need to assign .X, .Y, .Height, .Width values for each widget before sending it to .Render. Let's demonstrate these by a code snippet:

	import ui "notabug.org/themusicgod1/termui" // <- ui shortcut, optional

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

		p := ui.NewPar(":PRESS q TO QUIT DEMO")
		p.Height = 3
		p.Width = 50
		p.TextFgColor = ui.ColorWhite
		p.BorderLabel = "Text Box"
		p.BorderFg = ui.ColorCyan

		g := ui.NewGauge()
		g.Percent = 50
		g.Width = 50
		g.Height = 3
		g.Y = 11
		g.BorderLabel = "Gauge"
		g.BarColor = ui.ColorRed
		g.BorderFg = ui.ColorWhite
		g.BorderLabelFg = ui.ColorCyan

		ui.Render(p, g) // feel free to call Render, it's async and non-block

		// event handler...
	}

Note that components can be overlapped (I'd rather call this a feature...), Render(rs ...Renderer) renders its args from left to right (i.e. each component's weight is arising from left to right).

Grid layout:

grid

Grid layout uses 12 columns grid system with expressive syntax. To use Grid, all we need to do is build a widget tree consisting of Rows and Cols (Actually a Col is also a Row but with a widget endpoint attached).

	import ui "notabug.org/themusicgod1/termui"
	// init and create widgets...

	// build
	ui.Body.AddRows(
		ui.NewRow(
			ui.NewCol(6, 0, widget0),
			ui.NewCol(6, 0, widget1)),
		ui.NewRow(
			ui.NewCol(3, 0, widget2),
			ui.NewCol(3, 0, widget30, widget31, widget32),
			ui.NewCol(6, 0, widget4)))

	// calculate layout
	ui.Body.Align()

	ui.Render(ui.Body)

Events

termui ships with a http-like event mux handling system. All events are channeled up from different sources (typing, click, windows resize, custom event) and then encoded as universal Event object. Event.Path indicates the event type and Event.Data stores the event data struct. Add a handler to a certain event is easy as below:

	// handle key q pressing
	ui.Handle("/sys/kbd/q", func(ui.Event) {
		// press q to quit
		ui.StopLoop()
	})

	ui.Handle("/sys/kbd/C-x", func(ui.Event) {
		// handle Ctrl + x combination
	})

	ui.Handle("/sys/kbd", func(ui.Event) {
		// handle all other key pressing
	})

	// handle a 1s timer
	ui.Handle("/timer/1s", func(e ui.Event) {
		t := e.Data.(ui.EvtTimer)
		// t is a EvtTimer
		if t.Count%2 ==0 {
			// do something
		}
	})

	ui.Loop() // block until StopLoop is called

Widgets

Click image to see the corresponding demo codes.

par list gauge linechart barchart barchart sparklines table

License

This library is under the MIT License