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.
 
 
Trevor Slocum 357a49e9e7 Do not set focus-related style attributes by default 2 years ago
demos Add Window and WindowManager 2 years ago
.gitignore Fork tview as cview 3 years ago
.gitlab-ci.yml chore: Add makefile and use in `gitlab-ci.yml` 2 years ago
CHANGELOG Add Window and WindowManager 2 years ago
CONTRIBUTING.md Migrate docs to docs.rocketnine.space 3 years ago
DESIGN.md Do not set focus-related style attributes by default 2 years ago
FORK.md Add TextView.SetReindexBuffer 2 years ago
LICENSE Document TextView.GetText and GetRegionText fix 2 years ago
Makefile chore: Add makefile and use in `gitlab-ci.yml` 2 years ago
README.md Add Window and WindowManager 2 years ago
ansi.go Bugfixes in ANSI escape sequence handling as well as TextView, fixes #320, fixes #344 2 years ago
application.go Use updated tcell mouse buttons 2 years ago
borders.go Fork tview as cview 3 years ago
box.go Do not set focus-related style attributes by default 2 years ago
box_test.go Add comments to tests 2 years ago
button.go feat(FormItems): Allow specifying colors for focused state 2 years ago
button_test.go Add comments to tests 2 years ago
checkbox.go Do not set focus-related style attributes by default 2 years ago
checkbox_test.go Add comments to tests 2 years ago
contextmenu.go feat(List): Expose `ListItem` 2 years ago
cview.gif Fork tview as cview 3 years ago
doc.go Add WindowManager requirement to Window docs 2 years ago
doc_test.go Upgrade tcell to v2 2 years ago
dropdown.go Do not set focus-related style attributes by default 2 years ago
flex.go Document changes submitted by Andreas Bieber 2 years ago
focusable.go Fork tview as cview 3 years ago
form.go Do not set focus-related style attributes by default 2 years ago
frame.go Upgrade tcell to v2 2 years ago
go.mod Fix FormItem.SetAttributes race condition 2 years ago
go.sum Fix FormItem.SetAttributes race condition 2 years ago
grid.go Upgrade tcell to v2 2 years ago
inputfield.go Do not set focus-related style attributes by default 2 years ago
keys.go Upgrade tcell to v2 2 years ago
list.go Update List scroll bar cursor when view offset changes (rather than selected item) 2 years ago
list_test.go feat(List): Expose `ListItem` 2 years ago
modal.go Upgrade tcell to v2 2 years ago
pages.go Upgrade tcell to v2 2 years ago
primitive.go Upgrade tcell to v2 2 years ago
progressbar.go Upgrade tcell to v2 2 years ago
progressbar_test.go Add comments to tests 2 years ago
semigraphics.go Upgrade tcell to v2 2 years ago
styles.go Add Window and WindowManager 2 years ago
table.go Resolve lint warnings 2 years ago
textview.go Add WindowManager requirement to Window docs 2 years ago
textview_test.go Reduce logging severity in TextView tests 2 years ago
treeview.go fix(treeview): Use `scrollBarColor` 2 years ago
treeview_test.go Add comments to tests 2 years ago
util.go Do not set focus-related style attributes by default 2 years ago
util_test.go Upgrade tcell to v2 2 years ago
window.go Add WindowManager requirement to Window docs 2 years ago
windowmanager.go Add Window and WindowManager 2 years ago

README.md

cview - Terminal-based user interface toolkit

GoDoc CI status Donate

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
  • Selectable lists with context menus
  • Modal dialogs
  • Horizontal and vertical progress bars
  • Grid, Flexbox and page layouts
  • Sophisticated navigable table views
  • Flexible tree views
  • Draggable and resizable 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 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).