mirror of https://github.com/gizak/termui.git
067b2c5514 | ||
---|---|---|
_assets | ||
_examples | ||
_scripts | ||
_test | ||
widgets | ||
.gitignore | ||
CHANGELOG.md | ||
LICENSE | ||
Makefile | ||
README.md | ||
alignment.go | ||
block.go | ||
buffer.go | ||
canvas.go | ||
doc.go | ||
events.go | ||
go.mod | ||
go.sum | ||
grid.go | ||
render.go | ||
style.go | ||
symbols.go | ||
symbols_other.go | ||
symbols_windows.go | ||
termbox.go | ||
text_parser.go | ||
theme.go | ||
utils.go |
README.md
termui
termui is a cross-platform and fully-customizable terminal dashboard and widget library built on top of termbox-go. It is inspired by blessed-contrib and 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
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.
Widgets
- BarChart
- Canvas (for drawing braille dots)
- Gauge
- Image
- List
- Paragraph
- PieChart
- Plot (for scatterplots and linecharts)
- Sparkline
- StackedBarChart
- Table
- Tabs
Run an example with go run _examples/{example}.go
or run all of them consecutively with make run-examples
.