2018-11-28 20:15:29 -07:00
# termui
2015-03-20 19:11:58 -06:00
2019-01-24 00:09:50 -07:00
[<img src="./_assets/demo.gif" alt="demo cast under osx 10.10; Terminal.app; Menlo Regular 12pt.)" width="100%"> ](./_examples/demo.go )
2015-06-23 13:11:22 -06:00
2019-01-24 00:20:48 -07:00
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.
2019-01-28 02:13:33 -07:00
## Features
2019-01-24 00:20:48 -07:00
2019-01-28 02:13:33 -07:00
- Built in widget implementations for common use cases
- Utilities to create custom widgets
- A grid layout for relative widget positioning
- Mouse support
- Event handling for keyboard, mouse and resizing events
- Colors and styling
## Hello World
```go
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
}
}
}
```
2018-11-28 22:13:29 -07:00
2015-10-27 13:24:29 -06:00
## Installation
2015-03-15 13:56:38 -06:00
2019-01-27 23:37:22 -07:00
Installing from the master branch is recommended. termui has been completely reworked since the latest release, and the latest release also doesn't support Go modules.
2015-03-20 06:24:48 -06:00
2018-09-06 17:55:27 -06:00
```bash
2018-11-28 20:15:29 -07:00
go get -u github.com/gizak/termui@master
2018-09-06 17:55:27 -06:00
```
2015-03-20 06:24:48 -06:00
2019-01-23 21:12:10 -07:00
**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.
2019-01-24 00:09:50 -07:00
## Widgets
2015-02-08 10:00:00 -07:00
2019-01-24 00:09:50 -07:00
- [BarChart ](./_examples/barchart.go )
2019-01-25 05:14:49 -07:00
- [Canvas ](./_examples/canvas.go ) (for drawing braille dots)
2019-01-24 00:09:50 -07:00
- [Gauge ](./_examples/gauge.go )
2019-01-24 09:42:13 -07:00
- [Image ](./_examples/image.go )
2019-01-24 00:09:50 -07:00
- [List ](./_examples/list.go )
- [Paragraph ](./_examples/paragraph.go )
- [PieChart ](./_examples/piechart.go )
2019-01-25 05:14:49 -07:00
- [Plot ](./_examples/plot.go ) (for scatterplots and linecharts)
2019-01-24 00:09:50 -07:00
- [Sparkline ](./_examples/sparkline.go )
- [StackedBarChart ](./_examples/stacked_barchart.go )
- [Table ](./_examples/table.go )
- [Tabs ](./_examples/tabs.go )
2015-02-08 10:00:00 -07:00
2019-01-24 00:09:50 -07:00
Run an example with `go run _examples/{example}.go` or run all of them consecutively with `make run-examples` .
2018-11-28 21:12:36 -07:00
2019-01-24 00:09:50 -07:00
## Documentation
2018-11-28 20:15:29 -07:00
2019-01-23 21:12:10 -07:00
- [wiki ](https://github.com/gizak/termui/wiki )
2015-02-08 10:00:00 -07:00
2018-11-28 20:15:29 -07:00
## Uses
2015-02-08 10:00:00 -07:00
2019-02-01 22:44:55 -07:00
- [dockdash ](https://github.com/byrnedo/dockdash )
- [expvarmon ](https://github.com/divan/expvarmon )
2019-01-31 23:04:50 -07:00
- [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 )
2015-03-13 11:20:17 -06:00
2018-11-28 20:15:29 -07:00
## Related Works
2015-03-13 11:20:17 -06:00
2018-11-28 20:15:29 -07:00
- [blessed-contrib ](https://github.com/yaronn/blessed-contrib )
- [gocui ](https://github.com/jroimartin/gocui )
2019-01-24 00:23:37 -07:00
- [tui-rs ](https://github.com/fdehau/tui-rs )
2015-10-27 13:24:29 -06:00
2015-02-08 10:00:00 -07:00
## License
2018-09-06 17:55:27 -06:00
2019-01-23 21:12:10 -07:00
[MIT ](http://opensource.org/licenses/MIT )