Terminal-based user interface toolkit
Go to file
Trevor Slocum d2f2938ea0 Update presentation demo 2020-04-03 08:01:21 -07:00
demos Update presentation demo 2020-04-03 08:01:21 -07:00
.gitignore Fork tview as cview 2019-12-30 15:18:26 -08:00
.gitlab-ci.yml Update CI script 2020-01-28 07:10:28 -08:00
CHANGELOG Update presentation demo cover text 2020-04-01 08:42:30 -07:00
CONTRIBUTING.md Migrate docs to docs.rocketnine.space 2020-02-06 16:06:47 -08:00
FORK.md Make cview thread-safe 2020-03-25 14:32:57 +00:00
LICENSE Specify merged commits in LICENSE 2020-03-31 09:51:12 -07:00
README.md Make cview thread-safe 2020-03-25 14:32:57 +00:00
ansi.go ANSI parser now also handles SGR 39 and 49. Fixes #347 2020-01-08 16:31:52 -08:00
application.go Update presentation demo cover text 2020-04-01 08:42:30 -07:00
borders.go Fork tview as cview 2019-12-30 15:18:26 -08:00
box.go Update presentation demo 2020-04-03 08:01:21 -07:00
button.go Merge pull request #422 from rivo/mouse 2020-03-30 10:22:55 -07:00
checkbox.go Merge pull request #422 from rivo/mouse 2020-03-30 10:22:55 -07:00
cview.gif Fork tview as cview 2019-12-30 15:18:26 -08:00
doc.go Merge pull request #422 from rivo/mouse 2020-03-30 10:22:55 -07:00
doc_test.go Merge pull request #422 from rivo/mouse 2020-03-30 10:22:55 -07:00
dropdown.go Merge pull request #422 from rivo/mouse 2020-03-30 10:22:55 -07:00
flex.go Merge pull request #422 from rivo/mouse 2020-03-30 10:22:55 -07:00
focusable.go Fork tview as cview 2019-12-30 15:18:26 -08:00
form.go Merge pull request #422 from rivo/mouse 2020-03-30 10:22:55 -07:00
frame.go Merge pull request #422 from rivo/mouse 2020-03-30 10:22:55 -07:00
go.mod Make ProgressBar fields private 2020-03-27 12:54:05 -07:00
go.sum Make ProgressBar fields private 2020-03-27 12:54:05 -07:00
grid.go Merge pull request #422 from rivo/mouse 2020-03-30 10:22:55 -07:00
inputfield.go Merge pull request #422 from rivo/mouse 2020-03-30 10:22:55 -07:00
list.go Merge pull request #422 from rivo/mouse 2020-03-30 10:22:55 -07:00
modal.go Merge pull request #422 from rivo/mouse 2020-03-30 10:22:55 -07:00
pages.go Merge pull request #422 from rivo/mouse 2020-03-30 10:22:55 -07:00
primitive.go Merge pull request #422 from rivo/mouse 2020-03-30 10:22:55 -07:00
progressbar.go Make ProgressBar fields private 2020-03-27 12:54:05 -07:00
semigraphics.go Fork tview as cview 2019-12-30 15:18:26 -08:00
styles.go Add scroll bar to List, DropDown, Table and TreeView 2020-02-01 07:27:15 -08:00
table.go Merge pull request #422 from rivo/mouse 2020-03-30 10:22:55 -07:00
textview.go Expand click area of presentation demo tabs 2020-04-01 08:59:06 -07:00
treeview.go Merge pull request #422 from rivo/mouse 2020-03-30 10:22:55 -07:00
util.go Fix applying ScrollBarAlways to List 2020-02-24 08:06:04 -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

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
  • Horizontal and vertical progress bars
  • 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 via godoc and 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 via 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).