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 d045073571 Improve docs regarding widgets 2 years ago
demos Fix applying ScrollBarAlways to List 2 years ago
.gitignore Fork tview as cview 3 years ago
.gitlab-ci.yml Update CI script 3 years ago
CHANGELOG Update README 2 years ago
CONTRIBUTING.md Migrate docs to docs.rocketnine.space 3 years ago
FORK.md Do not wrap around form by default 2 years ago
LICENSE Fork tview as cview 3 years ago
README.md Update README 2 years ago
ansi.go ANSI parser now also handles SGR 39 and 49. Fixes #347 3 years ago
application.go Improve docs regarding widgets 2 years ago
borders.go Fork tview as cview 3 years ago
box.go Clarify that Box does not have inner text 3 years ago
button.go Migrate to GitLab 3 years ago
checkbox.go Migrate to GitLab 3 years ago
cview.gif Fork tview as cview 3 years ago
doc.go Improve docs regarding widgets 2 years ago
doc_test.go Migrate to GitLab 3 years ago
dropdown.go Fix applying ScrollBarNever to DropDown or InputField 3 years ago
events.go Improve docs regarding widgets 2 years ago
flex.go Migrate to GitLab 3 years ago
focusable.go Fork tview as cview 3 years ago
form.go Do not wrap around form by default 2 years ago
frame.go Migrate to GitLab 3 years ago
go.mod Add option to always show scroll bar 3 years ago
go.sum Add option to always show scroll bar 3 years ago
grid.go Migrate to GitLab 3 years ago
inputfield.go Fix applying ScrollBarNever to DropDown or InputField 3 years ago
list.go Update README 2 years ago
modal.go Migrate to GitLab 3 years ago
pages.go Migrate to GitLab 3 years ago
primitive.go Add documentation for GetChildren methods 3 years ago
progressbar.go Do not wrap around form by default 2 years ago
semigraphics.go Fork tview as cview 3 years ago
styles.go Add scroll bar to List, DropDown, Table and TreeView 3 years ago
table.go Fix scrolling Table with PageDown and PageUp when some fixedRows are not visible 2 years ago
textview.go Migrate to GitLab 3 years ago
treeview.go Fix applying ScrollBarAlways to List 2 years ago
util.go Fix applying ScrollBarAlways to List 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
  • 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.

This package is not thread-safe. Most functions may only be called from the main thread, as documented in Concurrency.

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