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.
 
 
Tryffel 9347d1b2c8 Add 'j k G g' shortcuts for moving inside list 2 years ago
demos Rename CheckBox 2 years ago
.gitignore Fork tview as cview 2 years ago
.gitlab-ci.yml Update CI script 2 years ago
CHANGELOG Add List.GetOffset and List.SetOffset 2 years ago
CONTRIBUTING.md Migrate docs to docs.rocketnine.space 2 years ago
FORK.md Do not handle double clicks by default 2 years ago
LICENSE Specify merged commits in LICENSE 2 years ago
README.md Add ContextMenu 2 years ago
ansi.go ANSI parser now also handles SGR 39 and 49. Fixes #347 2 years ago
application.go Add Application.SetBeforeFocusFunc and Application.SetAfterFocusFunc 2 years ago
borders.go Fork tview as cview 2 years ago
box.go Remove wiki references 2 years ago
box_test.go Add comments to tests 2 years ago
button.go Remove wiki references 2 years ago
button_test.go Add comments to tests 2 years ago
checkbox.go Remove wiki references 2 years ago
checkbox_test.go Add comments to tests 2 years ago
contextmenu.go Add ContextMenu 2 years ago
cview.gif Fork tview as cview 2 years ago
doc.go Rename CheckBox 2 years ago
doc_test.go Do not handle double clicks by default 2 years ago
dropdown.go Remove wiki references 2 years ago
flex.go Remove wiki references 2 years ago
focusable.go Fork tview as cview 2 years ago
form.go Remove wiki references 2 years ago
frame.go Remove wiki references 2 years ago
go.mod Add Application.SetBeforeFocusFunc and Application.SetAfterFocusFunc 2 years ago
go.sum Add Application.SetBeforeFocusFunc and Application.SetAfterFocusFunc 2 years ago
grid.go Remove wiki references 2 years ago
inputfield.go Remove wiki references 2 years ago
list.go Add 'j k G g' shortcuts for moving inside list 2 years ago
list_test.go Add comments to tests 2 years ago
modal.go Remove wiki references 2 years ago
pages.go Remove wiki references 2 years ago
primitive.go Merge pull request #422 from rivo/mouse 2 years ago
progressbar.go Make ProgressBar fields private 2 years ago
progressbar_test.go Add comments to tests 2 years ago
semigraphics.go Fork tview as cview 2 years ago
styles.go Add ContextMenu 2 years ago
table.go Remove wiki references 2 years ago
textview.go Remove wiki references 2 years ago
textview_test.go Clean up tests 2 years ago
treeview.go Remove wiki references 2 years ago
treeview_test.go Add comments to tests 2 years ago
util.go Fix scroll bar background color 2 years ago
util_test.go Clean up tests 2 years ago

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