Terminal-based user interface toolkit
Go to file
Trevor Slocum 0cb152db2b Document ANSI SGR code fix
Resolves #18.
2020-06-09 14:56:10 -07:00
demos Fix mutex usage in List.MouseHandler 2020-05-08 16:12:48 -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 Document ANSI SGR code fix 2020-06-09 14:56:10 -07:00
CONTRIBUTING.md Migrate docs to docs.rocketnine.space 2020-02-06 16:06:47 -08:00
FORK.md Link to relevant functions in FORK.md 2020-05-26 15:28:31 -07:00
LICENSE Document ANSI SGR code fix 2020-06-09 14:56: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 Add Application.SetBeforeFocusFunc and Application.SetAfterFocusFunc 2020-04-24 15:05:21 -07:00
borders.go Fork tview as cview 2019-12-30 15:18:26 -08:00
box.go Add Box.SetBackgroundTransparent 2020-05-24 09:36:17 -07:00
box_test.go Add comments to tests 2020-04-28 14:58:37 -07:00
button.go Split up shortcuts into primary and secondary 2020-05-18 20:06:54 -07:00
button_test.go Add comments to tests 2020-04-28 14:58:37 -07:00
checkbox.go Use Keys shortcuts with Button, CheckBox, Grid and Table 2020-05-18 19:49:25 -07:00
checkbox_test.go Add comments to tests 2020-04-28 14:58:37 -07:00
contextmenu.go Add Box.ShowFocus 2020-05-09 17:52:17 -07:00
cview.gif Fork tview as cview 2019-12-30 15:18:26 -08:00
doc.go Link to relevant functions in FORK.md 2020-05-26 15:28:31 -07:00
doc_test.go Do not handle double clicks by default 2020-04-14 09:46:24 -07:00
dropdown.go Remove wiki references 2020-04-26 16:59:33 -07:00
flex.go Fix default background transparency of Flex and Grid 2020-05-24 21:40:34 -07:00
focusable.go Fork tview as cview 2019-12-30 15:18:26 -08:00
form.go Remove wiki references 2020-04-26 16:59:33 -07:00
frame.go Remove wiki references 2020-04-26 16:59:33 -07:00
go.mod Fix default background transparency of Flex and Grid 2020-05-24 21:40:34 -07:00
go.sum Fix default background transparency of Flex and Grid 2020-05-24 21:40:34 -07:00
grid.go Fix default background transparency of Flex and Grid 2020-05-24 21:40:34 -07:00
inputfield.go Remove wiki references 2020-04-26 16:59:33 -07:00
keys.go Split up shortcuts into primary and secondary 2020-05-18 20:06:54 -07:00
list.go Fix negative List offset and DropDown selection 2020-06-02 15:51:03 -07:00
list_test.go Add comments to tests 2020-04-28 14:58:37 -07:00
modal.go Remove wiki references 2020-04-26 16:59:33 -07:00
pages.go Remove wiki references 2020-04-26 16:59:33 -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
progressbar_test.go Add comments to tests 2020-04-28 14:58:37 -07:00
semigraphics.go Fork tview as cview 2019-12-30 15:18:26 -08:00
styles.go Add Keys to allow default keybindings to be modified 2020-05-15 16:17:41 -07:00
table.go Split up shortcuts into primary and secondary 2020-05-18 20:06:54 -07:00
textview.go Bugfixes in ANSI escape sequence handling as well as TextView, fixes #320, fixes #344 2020-06-09 14:52:59 -07:00
textview_test.go Reduce logging severity in TextView tests 2020-05-26 09:06:57 -07:00
treeview.go Split up shortcuts into primary and secondary 2020-05-18 20:06:54 -07:00
treeview_test.go Add comments to tests 2020-04-28 14:58:37 -07:00
util.go Rename matchesKeys to HitShortcut 2020-05-17 10:14:17 -07:00
util_test.go Clean up tests 2020-04-28 07:57:37 -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).