Terminal-based user interface toolkit
 
 
Go to file
Trevor Slocum 5f880bc2c7 Migrate to GitLab 2020-01-22 15:28:19 -08:00
demos Migrate to GitLab 2020-01-22 15:28:19 -08:00
.gitignore Fork tview as cview 2019-12-30 15:18:26 -08:00
.gitlab-ci.yml Migrate to GitLab 2020-01-22 15:28:19 -08:00
CHANGELOG Add documentation for GetChildren methods 2020-01-16 22:34:51 -08:00
CONTRIBUTING.md Migrate to GitLab 2020-01-22 15:28:19 -08:00
FORK.md Migrate to GitLab 2020-01-22 15:28:19 -08:00
LICENSE Fork tview as cview 2019-12-30 15:18:26 -08:00
README.md Migrate to GitLab 2020-01-22 15:28:19 -08:00
ansi.go ANSI parser now also handles SGR 39 and 49. Fixes #347 2020-01-08 16:31:52 -08:00
application.go Add documentation for GetChildren methods 2020-01-16 22:34:51 -08:00
borders.go Fork tview as cview 2019-12-30 15:18:26 -08:00
box.go Migrate to GitLab 2020-01-22 15:28:19 -08:00
button.go Migrate to GitLab 2020-01-22 15:28:19 -08:00
checkbox.go Migrate to GitLab 2020-01-22 15:28:19 -08:00
cview.gif Fork tview as cview 2019-12-30 15:18:26 -08:00
doc.go Migrate to GitLab 2020-01-22 15:28:19 -08:00
doc_test.go Migrate to GitLab 2020-01-22 15:28:19 -08:00
dropdown.go Migrate to GitLab 2020-01-22 15:28:19 -08:00
events.go Add documentation for GetChildren methods 2020-01-16 22:34:51 -08:00
flex.go Migrate to GitLab 2020-01-22 15:28:19 -08:00
focusable.go Fork tview as cview 2019-12-30 15:18:26 -08:00
form.go Migrate to GitLab 2020-01-22 15:28:19 -08:00
frame.go Migrate to GitLab 2020-01-22 15:28:19 -08:00
go.mod Migrate to GitLab 2020-01-22 15:28:19 -08:00
go.sum Update dependencies 2020-01-04 21:49:02 -08:00
grid.go Migrate to GitLab 2020-01-22 15:28:19 -08:00
inputfield.go Migrate to GitLab 2020-01-22 15:28:19 -08:00
list.go Migrate to GitLab 2020-01-22 15:28:19 -08:00
modal.go Migrate to GitLab 2020-01-22 15:28:19 -08:00
pages.go Migrate to GitLab 2020-01-22 15:28:19 -08:00
primitive.go Add documentation for GetChildren methods 2020-01-16 22:34:51 -08:00
progressbar.go Add ProgressBar widget 2020-01-16 16:53:51 -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 Migrate to GitLab 2020-01-22 15:28:19 -08:00
textview.go Migrate to GitLab 2020-01-22 15:28:19 -08:00
treeview.go Migrate to GitLab 2020-01-22 15:28:19 -08:00
util.go ANSI parser now also handles SGR 39 and 49. Fixes #347 2020-01-08 16:31:52 -08:00

README.md

cview

GoDoc CI status Donate

Terminal-based user interface toolkit

This package is a fork of tview. See FORK.md for more information.

Demo

Try the demo: ssh cview.rocketnine.space -p 20000

Recording of presentation demo

Features

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.

Mouse support is available.

Installation

go get gitlab.com/tslocum/cview

Hello World

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

package main

import (
	"gitlab.com/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.

An introduction tutorial is also available.

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).