gotop/vendor/github.com/gizak/termui/v3
Caleb Bassi 96535ccadd Upgrade termui to v3 2019-03-07 23:15:41 -08:00
..
.gitignore Upgrade termui to v3 2019-03-07 23:15:41 -08:00
CHANGELOG.md Upgrade termui to v3 2019-03-07 23:15:41 -08:00
LICENSE Upgrade termui to v3 2019-03-07 23:15:41 -08:00
Makefile Upgrade termui to v3 2019-03-07 23:15:41 -08:00
README.md Upgrade termui to v3 2019-03-07 23:15:41 -08:00
alignment.go Upgrade termui to v3 2019-03-07 23:15:41 -08:00
backend.go Upgrade termui to v3 2019-03-07 23:15:41 -08:00
block.go Upgrade termui to v3 2019-03-07 23:15:41 -08:00
buffer.go Upgrade termui to v3 2019-03-07 23:15:41 -08:00
canvas.go Upgrade termui to v3 2019-03-07 23:15:41 -08:00
doc.go Upgrade termui to v3 2019-03-07 23:15:41 -08:00
events.go Upgrade termui to v3 2019-03-07 23:15:41 -08:00
go.mod Upgrade termui to v3 2019-03-07 23:15:41 -08:00
go.sum Upgrade termui to v3 2019-03-07 23:15:41 -08:00
grid.go Upgrade termui to v3 2019-03-07 23:15:41 -08:00
render.go Upgrade termui to v3 2019-03-07 23:15:41 -08:00
style.go Upgrade termui to v3 2019-03-07 23:15:41 -08:00
style_parser.go Upgrade termui to v3 2019-03-07 23:15:41 -08:00
symbols.go Upgrade termui to v3 2019-03-07 23:15:41 -08:00
symbols_other.go Upgrade termui to v3 2019-03-07 23:15:41 -08:00
symbols_windows.go Upgrade termui to v3 2019-03-07 23:15:41 -08:00
theme.go Upgrade termui to v3 2019-03-07 23:15:41 -08:00
utils.go Upgrade termui to v3 2019-03-07 23:15:41 -08:00

README.md

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.

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

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

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

Documentation

Uses

License

MIT