termui/README.md

62 lines
2.1 KiB
Markdown
Raw Normal View History

2018-11-28 20:15:29 -07:00
# termui
[<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.
The core components of termui include:
- built in widget implementations for common use cases
- utilities to create custom widgets
- a Grid for relative widget positioning
- an event system for keyboard, mouse and resizing events
- colors and styling
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
2018-11-28 22:44:42 -07:00
Installing from the master branch is recommended:
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.
## Widgets
2015-02-08 10:00:00 -07:00
- [BarChart](./_examples/barchart.go)
- [Canvas](./_examples/canvas.go)
- [Gauge](./_examples/gauge.go)
2019-01-24 09:42:13 -07:00
- [Image](./_examples/image.go)
- [List](./_examples/list.go)
- [Paragraph](./_examples/paragraph.go)
- [PieChart](./_examples/piechart.go)
- [Plot](./_examples/plot.go)
- [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
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
## 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-01-23 21:12:10 -07:00
- [cjbassi/gotop](https://github.com/cjbassi/gotop)
2019-01-24 00:28:19 -07:00
- [ethereum/go-ethereum/monitorcmd](https://github.com/ethereum/go-ethereum/blob/master/cmd/geth/monitorcmd.go)
2019-01-24 00:23:37 -07:00
- [mikepea/go-jira-ui](https://github.com/mikepea/go-jira-ui)
2018-11-28 20:15:29 -07:00
## Related Works
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)