Terminal-based user interface toolkit
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Trevor Slocum b61132eddf Fork tview as cview 3 years ago
.builds Fork tview as cview 3 years ago
demos Fork tview as cview 3 years ago
.gitignore Fork tview as cview 3 years ago
CONTRIBUTING.md Fork tview as cview 3 years ago
FORK.md Fork tview as cview 3 years ago
LICENSE Fork tview as cview 3 years ago
README.md Fork tview as cview 3 years ago
ansi.go Fork tview as cview 3 years ago
application.go Fork tview as cview 3 years ago
borders.go Fork tview as cview 3 years ago
box.go Fork tview as cview 3 years ago
button.go Fork tview as cview 3 years ago
checkbox.go Fork tview as cview 3 years ago
cview.gif Fork tview as cview 3 years ago
doc.go Fork tview as cview 3 years ago
dropdown.go Fork tview as cview 3 years ago
flex.go Fork tview as cview 3 years ago
focusable.go Fork tview as cview 3 years ago
form.go Fork tview as cview 3 years ago
frame.go Fork tview as cview 3 years ago
go.mod Fork tview as cview 3 years ago
go.sum Fork tview as cview 3 years ago
grid.go Fork tview as cview 3 years ago
inputfield.go Fork tview as cview 3 years ago
list.go Fork tview as cview 3 years ago
modal.go Fork tview as cview 3 years ago
pages.go Fork tview as cview 3 years ago
primitive.go Fork tview as cview 3 years ago
semigraphics.go Fork tview as cview 3 years ago
styles.go Fork tview as cview 3 years ago
table.go Fork tview as cview 3 years ago
textview.go Fork tview as cview 3 years ago
treeview.go Fork tview as cview 3 years ago
util.go Fork tview as cview 3 years ago

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: