Terminal-based user interface toolkit
Go to file
Chris Miller ad59b43801 Get mouse actions rather than just mouse state 2020-01-01 20:18:40 -08:00
.builds Fork tview as cview 2019-12-30 15:18:26 -08:00
demos Fire Selected on list item click 2020-01-01 20:18:40 -08:00
.gitignore Fork tview as cview 2019-12-30 15:18:26 -08:00
CHANGELOG Update CHANGELOG and FORK.md 2020-01-01 19:43:18 -08:00
CONTRIBUTING.md Fork tview as cview 2019-12-30 15:18:26 -08:00
FORK.md Update CHANGELOG and FORK.md 2020-01-01 19:43:18 -08:00
LICENSE Fork tview as cview 2019-12-30 15:18:26 -08:00
README.md Update README.md 2020-01-01 20:14:14 -08:00
ansi.go Handle ansi code 39 and 49 2020-01-01 19:35:05 -08:00
application.go Get mouse actions rather than just mouse state 2020-01-01 20:18:40 -08:00
borders.go Fork tview as cview 2019-12-30 15:18:26 -08:00
box.go Added mouse handling 2020-01-01 20:18:40 -08:00
button.go Get mouse actions rather than just mouse state 2020-01-01 20:18:40 -08:00
checkbox.go Get mouse actions rather than just mouse state 2020-01-01 20:18:40 -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 Get mouse actions rather than just mouse state 2020-01-01 20:18:40 -08:00
flex.go Added mouse handling 2020-01-01 20:18:40 -08:00
focusable.go Fork tview as cview 2019-12-30 15:18:26 -08:00
form.go Added mouse handling 2020-01-01 20:18:40 -08:00
frame.go Added mouse handling 2020-01-01 20:18:40 -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 Added mouse handling 2020-01-01 20:18:40 -08:00
inputfield.go Get mouse actions rather than just mouse state 2020-01-01 20:18:40 -08:00
list.go Get mouse actions rather than just mouse state 2020-01-01 20:18:40 -08:00
modal.go Added mouse handling 2020-01-01 20:18:40 -08:00
pages.go Added mouse handling 2020-01-01 20:18:40 -08:00
primitive.go Added mouse handling 2020-01-01 20:18:40 -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 of presentation demo

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

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: