gotop/vendor/github.com/gizak/termui
Caleb Bassi c48984563e Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -08:00
..
.gitignore Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -08:00
CHANGELOG.md Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -08:00
LICENSE Add go vendor 2019-01-14 20:19:17 -08:00
Makefile Add go vendor 2019-01-14 20:19:17 -08:00
README.md Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -08:00
alignment.go Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -08:00
block.go Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -08:00
buffer.go Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -08:00
canvas.go Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -08:00
doc.go Add go vendor 2019-01-14 20:19:17 -08:00
events.go Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -08:00
go.mod Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -08:00
go.sum Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -08:00
grid.go Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -08:00
render.go Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -08:00
style.go Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -08:00
symbols.go Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -08:00
symbols_other.go Add go vendor 2019-01-14 20:19:17 -08:00
symbols_windows.go Add go vendor 2019-01-14 20:19:17 -08:00
termbox.go Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -08:00
text_parser.go Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -08:00
theme.go Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -08:00
utils.go Switch to master branch of gizak/termui after its update 2019-01-23 21:23:35 -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
		}
	}
}

Widgets

Click image to see the corresponding demo codes.

barchart gauge linechart list paragraph sparkline stacked_barchart table

Examples

Examples can be found in _examples. Run an example with go run _examples/{example}.go or run all of them consecutively with make run-examples.

Documentation

Uses

License

MIT