github.com/gizak/termui

v3.1.0+incompatible
Source
Go

Version published: 6 years ago

Created: 8 years ago

Source

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.

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

Go modules

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.

Dep

Add with dep ensure -add github.com/gizak/termui. With Dep, /v3 should not be included in the import statements.

Hello World

package main

import (
	"log"

	ui "github.com/gizak/termui/v3"
	"github.com/gizak/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

wiki

Uses

License

MIT

FAQs

What is github.com/gizak/termui?

Package last updated on 15 Jul 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install