Terminal-based user interface toolkit
 
 
Go to file
Sean Smith 9aa08ad7c7 Handle ansi code 39 and 49
39 is apparently the "default foreground color"
49 is apparently the "default background color"
2020-01-01 19:35:05 -08:00
.builds Fork tview as cview 2019-12-30 15:18:26 -08:00
demos Fork tview as cview 2019-12-30 15:18:26 -08:00
.gitignore Fork tview as cview 2019-12-30 15:18:26 -08:00
CHANGELOG Add CHANGELOG 2019-12-30 18:01:35 -08:00
CONTRIBUTING.md Fork tview as cview 2019-12-30 15:18:26 -08:00
FORK.md Update FORK.md 2020-01-01 19:30:03 -08:00
LICENSE Fork tview as cview 2019-12-30 15:18:26 -08:00
README.md Fork tview as cview 2019-12-30 15:18:26 -08:00
ansi.go Handle ansi code 39 and 49 2020-01-01 19:35:05 -08:00
application.go Throttle resize event callbacks 2020-01-01 08:37:50 -08:00
borders.go Fork tview as cview 2019-12-30 15:18:26 -08:00
box.go Fork tview as cview 2019-12-30 15:18:26 -08:00
button.go Fork tview as cview 2019-12-30 15:18:26 -08:00
checkbox.go Fork tview as cview 2019-12-30 15:18:26 -08:00
cview.gif Fork tview as cview 2019-12-30 15:18:26 -08:00
doc.go Fork tview as cview 2019-12-30 15:18:26 -08:00
dropdown.go Fork tview as cview 2019-12-30 15:18:26 -08:00
flex.go Fork tview as cview 2019-12-30 15:18:26 -08:00
focusable.go Fork tview as cview 2019-12-30 15:18:26 -08:00
form.go Fork tview as cview 2019-12-30 15:18:26 -08:00
frame.go Fork tview as cview 2019-12-30 15:18:26 -08:00
go.mod Fork tview as cview 2019-12-30 15:18:26 -08:00
go.sum Fork tview as cview 2019-12-30 15:18:26 -08:00
grid.go Fork tview as cview 2019-12-30 15:18:26 -08:00
inputfield.go Fork tview as cview 2019-12-30 15:18:26 -08:00
list.go Fork tview as cview 2019-12-30 15:18:26 -08:00
modal.go Fork tview as cview 2019-12-30 15:18:26 -08:00
pages.go Fork tview as cview 2019-12-30 15:18:26 -08:00
primitive.go Fork tview as cview 2019-12-30 15:18:26 -08:00
semigraphics.go Fork tview as cview 2019-12-30 15:18:26 -08:00
styles.go Fork tview as cview 2019-12-30 15:18:26 -08:00
table.go Fork tview as cview 2019-12-30 15:18:26 -08:00
textview.go Fork tview as cview 2019-12-30 15:18:26 -08:00
treeview.go Fork tview as cview 2019-12-30 15:18:26 -08:00
util.go Fixed TextView's reset [-] setting the wrong color 2020-01-01 19:28:02 -08:00

README.md

Terminal-based user interface toolkit

GoDoc builds.sr.ht status

This package is a fork of tview. It allows the creation of rich terminal-based user interfaces.

Screenshot

Available widgets:

  • Input forms (including input/password fields, drop-down selections, checkboxes, and buttons)
  • Navigable multi-color text views
  • Sophisticated navigable table views
  • Flexible tree views
  • Selectable lists
  • Grid, Flexbox and page layouts
  • Modal message windows
  • An application wrapper

Widgets may be customized and extended to suit any application.

Installation

go get git.sr.ht/~tslocum/cview@latest

Hello World

This basic example creates a box titled "Hello, World!" and displays it in your terminal:

package main

import (
	"git.sr.ht/~tslocum/cview"
)

func main() {
	box := cview.NewBox().SetBorder(true).SetTitle("Hello, world!")
	if err := cview.NewApplication().SetRoot(box, true).Run(); err != nil {
		panic(err)
	}
}

Examples are available in the "demos" subdirectory.

For a presentation highlighting the features of this package, compile and run the program in the "demos/presentation" subdirectory.

Documentation

Package documentation is available on godoc.

Dependencies

This package is based on github.com/gdamore/tcell (and its dependencies) and github.com/rivo/uniseg.

Support

CONTRIBUTING.md describes how to share issues, suggestions and patches (pull requests).

cview has two mailing lists: