Golang terminal dashboard
Go to file
2019-02-04 20:16:27 -08:00
_assets
_examples Merge pull request #222 from ryanlewis/master 2019-02-01 21:21:45 -08:00
_scripts
_test
widgets Merge pull request #222 from ryanlewis/master 2019-02-01 21:21:45 -08:00
.gitignore
alignment.go
block.go
buffer.go
canvas.go Refactor canvas into seperate repo 2019-01-26 05:19:45 -08:00
CHANGELOG.md
doc.go
events.go Refactor events.go 2019-01-25 03:41:35 -08:00
go.mod Add scrolling to List widget 2019-01-26 22:32:08 -08:00
go.sum Add scrolling to List widget 2019-01-26 22:32:08 -08:00
grid.go Improve/add comments 2019-02-01 22:16:02 -08:00
LICENSE
Makefile
README.md Update README 2019-02-04 20:16:27 -08:00
render.go
style.go Improve/add comments 2019-02-01 22:16:02 -08:00
symbols_other.go
symbols_windows.go
symbols.go Add scrolling to List widget 2019-01-26 22:32:08 -08:00
termbox.go
text_parser.go Improve/add comments 2019-02-01 22:16:02 -08:00
theme.go Improve/add comments 2019-02-01 22:16:02 -08:00
utils.go Added a floor function for scrolling. 2019-02-01 14:09:51 +00:00

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

  • Built in widget implementations for common use cases
  • Utilities to create custom widgets
  • A grid layout for relative widget positioning
  • Mouse support
  • Event handling for keyboard, mouse and resizing events
  • Colors and styling

Installation

Installing from the master branch is recommended since termui has been completely reworked since the latest release and because the latest release doesn't support Go modules.

Do note that termui is still undergoing breaking changes so make sure to check the changelog when upgrading.

go get -u github.com/gizak/termui@master

Hello World

package main

import (
	"log"

	ui "github.com/gizak/termui"
	"github.com/gizak/termui/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 all of them consecutively with make run-examples.

Documentation

Uses

License

MIT