99 lines
2.8 KiB
Markdown
99 lines
2.8 KiB
Markdown
# termui
|
|
|
|
[<img src="./_assets/demo.gif" alt="demo cast under osx 10.10; Terminal.app; Menlo Regular 12pt.)" width="100%">](./_examples/demo.go)
|
|
|
|
termui is a cross-platform and fully-customizable terminal dashboard and widget library built on top of [termbox-go](https://github.com/nsf/termbox-go). It is inspired by [blessed-contrib](https://github.com/yaronn/blessed-contrib) and [tui-rs](https://github.com/fdehau/tui-rs) and written purely in Go.
|
|
|
|
## Features
|
|
|
|
- Several premade widgets for common use cases
|
|
- Easily create custom widgets
|
|
- Position widgets either in a relative grid or with absolute coordinates
|
|
- Keyboard, mouse, and terminal resizing events
|
|
- Colors and styling
|
|
|
|
## Installation
|
|
|
|
### Go modules
|
|
|
|
It is not necessary to `go get` termui, since Go will automatically manage any imported dependencies for you. Do note that you have to include `/v3` in the import statements as shown in the 'Hello World' example below.
|
|
|
|
### Dep
|
|
|
|
Add with `dep ensure -add github.com/gizak/termui`. With Dep, `/v3` should *not* be included in the import statements.
|
|
|
|
## Hello World
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"log"
|
|
|
|
ui "github.com/gizak/termui/v3"
|
|
"github.com/gizak/termui/v3/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
|
|
|
|
- [BarChart](./_examples/barchart.go)
|
|
- [Canvas](./_examples/canvas.go) (for drawing braille dots)
|
|
- [Gauge](./_examples/gauge.go)
|
|
- [Image](./_examples/image.go)
|
|
- [List](./_examples/list.go)
|
|
- [Tree](./_examples/tree.go)
|
|
- [Paragraph](./_examples/paragraph.go)
|
|
- [PieChart](./_examples/piechart.go)
|
|
- [Plot](./_examples/plot.go) (for scatterplots and linecharts)
|
|
- [Sparkline](./_examples/sparkline.go)
|
|
- [StackedBarChart](./_examples/stacked_barchart.go)
|
|
- [Table](./_examples/table.go)
|
|
- [Tabs](./_examples/tabs.go)
|
|
|
|
Run an example with `go run _examples/{example}.go` or run each example consecutively with `make run-examples`.
|
|
|
|
## Documentation
|
|
|
|
- [wiki](https://github.com/gizak/termui/wiki)
|
|
|
|
## Uses
|
|
|
|
- [dockdash](https://github.com/byrnedo/dockdash)
|
|
- [expvarmon](https://github.com/divan/expvarmon)
|
|
- [go-ethereum/monitorcmd](https://github.com/ethereum/go-ethereum/blob/master/cmd/geth/monitorcmd.go)
|
|
- [go-jira-ui](https://github.com/mikepea/go-jira-ui)
|
|
- [gotop](https://github.com/cjbassi/gotop)
|
|
- [termeter](https://github.com/atsaki/termeter)
|
|
|
|
## Related Works
|
|
|
|
- [blessed-contrib](https://github.com/yaronn/blessed-contrib)
|
|
- [gocui](https://github.com/jroimartin/gocui)
|
|
- [termdash](https://github.com/mum4k/termdash)
|
|
- [tui-rs](https://github.com/fdehau/tui-rs)
|
|
- [tview](https://github.com/rivo/tview)
|
|
|
|
## License
|
|
|
|
[MIT](http://opensource.org/licenses/MIT)
|