Terminal-based user interface toolkit
Go to file
Trevor Slocum 624a3fae3c Use updated tcell mouse buttons 2020-08-31 08:44:33 -07:00
demos Upgrade tcell to v2 2020-08-30 08:37:17 -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 Expose strikethrough support 2020-08-31 07:50:10 -07:00
CONTRIBUTING.md Migrate docs to docs.rocketnine.space 2020-02-06 16:06:47 -08:00
DESIGN.md Use sync.RWMutex in all widgets 2020-08-02 10:06:34 -07:00
FORK.md FORK.md - Terminal colors and mouse merged upstream 2020-07-13 03:56:45 +00:00
LICENSE Document TextView.GetText and GetRegionText fix 2020-07-13 14:47:10 -07:00
README.md Add ContextMenu 2020-04-18 20:00:36 -07:00
ansi.go Bugfixes in ANSI escape sequence handling as well as TextView, fixes #320, fixes #344 2020-06-09 14:52:59 -07:00
application.go Use updated tcell mouse buttons 2020-08-31 08:44:33 -07:00
borders.go Fork tview as cview 2019-12-30 15:18:26 -08:00
box.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
box_test.go Add comments to tests 2020-04-28 14:58:37 -07:00
button.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
button_test.go Add comments to tests 2020-04-28 14:58:37 -07:00
checkbox.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
checkbox_test.go Add comments to tests 2020-04-28 14:58:37 -07:00
contextmenu.go Position ContextMenu on selected item when negative coordinates are provided 2020-08-11 15:31:18 -07:00
cview.gif Fork tview as cview 2019-12-30 15:18:26 -08:00
doc.go Expose strikethrough support 2020-08-31 07:50:10 -07:00
doc_test.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
dropdown.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
flex.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
focusable.go Fork tview as cview 2019-12-30 15:18:26 -08:00
form.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
frame.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
go.mod Expose strikethrough support 2020-08-31 07:50:10 -07:00
go.sum Expose strikethrough support 2020-08-31 07:50:10 -07:00
grid.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
inputfield.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
keys.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
list.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
list_test.go Add comments to tests 2020-04-28 14:58:37 -07:00
modal.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
pages.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
primitive.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
progressbar.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
progressbar_test.go Add comments to tests 2020-04-28 14:58:37 -07:00
semigraphics.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
styles.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
table.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
textview.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
textview_test.go Reduce logging severity in TextView tests 2020-05-26 09:06:57 -07:00
treeview.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
treeview_test.go Add comments to tests 2020-04-28 14:58:37 -07:00
util.go Expose strikethrough support 2020-08-31 07:50:10 -07:00
util_test.go Upgrade tcell to v2 2020-08-30 08:37:17 -07: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 with context menus
  • 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).