termui/README.md
2019-01-24 08:59:46 -08:00

2.1 KiB

termui

demo cast under osx 10.10; Terminal.app; Menlo Regular 12pt.)

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

Run an example with go run _examples/{example}.go or run all of them consecutively with make run-examples.

Documentation

Uses

License

MIT