mirror of https://github.com/gizak/termui.git
3.1 KiB
3.1 KiB
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.
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 := <-ui.PollEvent()
if e.Type == ui.KeyboardEvent {
return
}
}
}
Widgets
Click image to see the corresponding demo codes.
Examples
Examples can be found in _examples. Run with go run _examples/...
or run all of them consecutively with ./scripts/run_examples.py
.
Documentation
Uses
Related Works
License
This library is under the MIT License