| .. | ||
| .gitignore | ||
| alignment.go | ||
| attributes.go | ||
| block.go | ||
| buffer.go | ||
| canvas.go | ||
| CHANGELOG.md | ||
| doc.go | ||
| events.go | ||
| go.mod | ||
| go.sum | ||
| grid.go | ||
| init.go | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| render.go | ||
| symbols_other.go | ||
| symbols_windows.go | ||
| symbols.go | ||
| text_parser.go | ||
| theme.go | ||
| utils.go | ||
termui
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.
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 (
ui "github.com/gizak/termui"
"github.com/gizak/termui/widgets"
)
func main() {
if err := ui.Init(); err != nil {
panic(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.
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.