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.

This is a fork of the original project on GitHub.

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

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.

Hello World

package main

import (
	"log"

	ui "git.tebibyte.media/sashakoshka/termui/v3"
	"git.tebibyte.media/sashakoshka/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
• Canvas (for drawing braille dots)
• Gauge
• Image
• List
• Tree
• Paragraph
• PieChart
• Plot (for scatterplots and linecharts)
• Sparkline
• StackedBarChart
• Table
• Tabs

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

Documentation

TODO

Related Works

• blessed-contrib
• gocui
• termdash
• tui-rs
• tview

License

GPLv3