Golang terminal dashboard
Go to file
Matteo Kloiber 821f8bfd95 Fixes unsafe pointer madness.
`func uiEvt(e termbox.Event) Event` used to change the type of termbox.Event to Event by
using some pointer-cast magic[1], which could cause an overflow if `termbox.Event` changes
its structure.
I'd rather just have `type Event termbox.Event` but that would break backwards compatibility.

Warning: A buffer overflow could cause a serious security issue but it is very unlikely that
anyone could exploit that (though not impossbible). You'd need to push a upstream update to
termbox, which would tweak termbox.Event's structure. Still, this issue should be fixed and
unsafe should never be used.

[1] it used to get the address of termbox.Event and just cast a Event pointer
2015-04-15 13:49:31 +02:00
example Fix example 2015-04-14 17:25:25 +09:00
.gitignore Initial commit 2015-02-03 09:09:27 -05:00
.travis.yml Update travis config 2015-03-20 13:06:29 -04:00
bar.go Fix https://github.com/gizak/termui/issues/18 2015-04-09 16:40:49 -04:00
block_test.go Fix #23 by implementing Block.InnerBounds() and associated test. 2015-04-09 10:19:43 +08:00
block.go Fix https://github.com/gizak/termui/issues/18 2015-04-09 16:40:49 -04:00
box_others.go Add build tags for examples 2015-03-20 16:21:50 -04:00
box_windows.go Add build tags for examples 2015-03-20 16:21:50 -04:00
box.go Fix https://github.com/gizak/termui/issues/10 2015-03-25 18:04:15 -04:00
canvas_test.go Add braille canvas 2015-03-26 18:11:41 -04:00
canvas.go Add braille canvas 2015-03-26 18:11:41 -04:00
chart_others.go Add build tags for examples 2015-03-20 16:21:50 -04:00
chart_windows.go Add build tags for examples 2015-03-20 16:21:50 -04:00
chart.go Fix https://github.com/gizak/termui/issues/9 2015-04-10 10:40:57 -04:00
doc.go Add docs 2015-03-24 17:16:43 -04:00
events_test.go Fixes unsafe pointer madness. 2015-04-15 13:49:31 +02:00
events.go Fixes unsafe pointer madness. 2015-04-15 13:49:31 +02:00
gauge.go Fix https://github.com/gizak/termui/issues/18 2015-04-09 16:40:49 -04:00
grid_test.go Add build tags for examples 2015-03-20 16:21:50 -04:00
grid.go Fix https://github.com/gizak/termui/issues/26 2015-04-10 09:57:34 -04:00
helper_test.go Fix https://github.com/gizak/termui/issues/10 2015-03-25 18:04:15 -04:00
helper.go Fix https://github.com/gizak/termui/issues/10 2015-03-25 18:04:15 -04:00
LICENSE Initial commit 2015-02-03 09:09:27 -05:00
list.go Fix https://github.com/gizak/termui/issues/18 2015-04-09 16:40:49 -04:00
p.go Fix https://github.com/gizak/termui/issues/18 2015-04-09 16:40:49 -04:00
point.go Add docs 2015-03-24 17:16:43 -04:00
README.md Fix https://github.com/gizak/termui/issues/13 2015-03-28 12:02:33 -04:00
render.go Add Event 2015-04-08 12:06:47 -04:00
sparkline.go Fix https://github.com/gizak/termui/issues/18 2015-04-09 16:40:49 -04:00
theme.go Add build tags for examples 2015-03-20 16:21:50 -04:00

termui Build Status Doc Status


Go terminal dashboard. Inspired by blessed-contrib, but purely in Go.

Cross-platform, easy to compile, and fully-customizable.

Demo: (cast under osx 10.10; Terminal.app; Menlo Regular 12pt.)

demo

Grid layout:

Expressive syntax, using 12 columns grid system

	import ui "github.com/gizak/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)

demo code:

grid

Installation

go get github.com/gizak/termui

Usage

Each component's layout is a bit like HTML block (box model), which has border and padding.

The Border property can be chosen to hide or display (with its border label), when it comes to display, the label takes 1 padding space (i.e. in css: padding: 1;, innerHeight and innerWidth therefore shrunk by 1).

	import ui "github.com/gizak/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.Border.Label = "Text Box"
		p.Border.FgColor = ui.ColorCyan

		g := ui.NewGauge()
		g.Percent = 50
		g.Width = 50
		g.Height = 3
		g.Y = 11
		g.Border.Label = "Gauge"
		g.BarColor = ui.ColorRed
		g.Border.FgColor = ui.ColorWhite
		g.Border.LabelFgColor = ui.ColorCyan

		ui.Render(p, g)

		// 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).

Themes

All colors in all components can be changed at any time, while there provides some predefined color schemes:

// for now there are only two themes: default and helloworld
termui.UseTheme("helloworld")

// create components...

The default theme's settings depend on the user's terminal color scheme, which is saying if your terminal default font color is white and background is white, it will be like:

default

The helloworld color scheme drops in some colors!

helloworld

Widgets

Par

demo code

par

List

demo code

list

Gauge

demo code

gauge

Line Chart

demo code

linechart

Bar Chart

demo code

barchart

Sparklines

demo code

sparklines

GoDoc

godoc

TODO

  • Grid layout
  • Event system
  • Canvas widget
  • Refine APIs
  • Focusable widgets

License

This library is under the MIT License