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 e8e2d12710 Remove code.rocketnine.space migration notice 1 week ago
demos Add code.rocketnine.space migration notice 1 week ago
.gitignore Update .gitignore 6 months ago
CHANGELOG Remove code.rocketnine.space migration notice 1 week ago
CONTRIBUTING.md Add code.rocketnine.space migration notice 1 week ago
DESIGN.md Add code.rocketnine.space migration notice 1 week ago
FORK.md Add code.rocketnine.space migration notice 1 week ago
LICENSE Fix strikethrough support 2 months ago
Makefile chore: Add makefile and use in `gitlab-ci.yml` 7 months ago
README.md Remove code.rocketnine.space migration notice 1 week ago
ansi.go Bugfixes in ANSI escape sequence handling as well as TextView, fixes #320, fixes #344 10 months ago
application.go Remove reference to resolved tcell bug 4 months ago
borders.go Fork tview as cview 1 year ago
box.go Document how to prevent screen artifacts when using SetBackgroundTransparent 4 months ago
box_test.go Add comments to tests 12 months ago
button.go Add SetVisible and GetVisible to all widgets 6 months ago
button_test.go Add comments to tests 12 months ago
checkbox.go Add SetVisible and GetVisible to all widgets 6 months ago
checkbox_test.go Add comments to tests 12 months ago
contextmenu.go Rename SetBorderPadding and GetBorderPadding as SetPadding and GetPadding 6 months ago
cview.svg Update presentation demo recording 6 months ago
doc.go Add code.rocketnine.space migration notice 1 week ago
doc_test.go Add code.rocketnine.space migration notice 1 week ago
dropdown.go Replace FormItem.SetAttributes with individual methods 6 months ago
flex.go Add SetVisible and GetVisible to all widgets 6 months ago
focus.go Add FocusManager 6 months ago
form.go Fix highlighting focused Form element 3 months ago
frame.go Add SetVisible and GetVisible to all widgets 6 months ago
go.mod Add code.rocketnine.space migration notice 1 week ago
go.sum Fix TextView.GetTextDimensions 1 week ago
grid.go Release v1.5.2 4 months ago
inputfield.go Add SetVisible and GetVisible to all widgets 6 months ago
keys.go Add code.rocketnine.space migration notice 1 week ago
list.go Add SetVisible and GetVisible to all widgets 6 months ago
list_test.go Remove return values from methods which return their primitive (breaks chaining) 6 months ago
modal.go Rename SetBorderPadding and GetBorderPadding as SetPadding and GetPadding 6 months ago
mouse.go Print text using []byte instead of string, calculate string width using runewidth instead of uniseg 6 months ago
panels.go Preserve order of panels when updating panel 3 months ago
primitive.go Allow hiding form items 6 months ago
progressbar.go Add SetVisible and GetVisible to all widgets 6 months ago
progressbar_test.go Add comments to tests 12 months ago
semigraphics.go Upgrade tcell to v2 7 months ago
slider.go Add SetVisible and GetVisible to all widgets 6 months ago
styles.go Add Window and WindowManager 7 months ago
tabbedpanels.go Fix incorrect TabbedPanels colors 3 months ago
table.go Add SetVisible and GetVisible to all widgets 6 months ago
table_test.go Store ListItem text as []byte instead of string 6 months ago
textview.go Fix TextView.GetTextDimensions 1 week ago
textview_test.go Remove return values from methods which return their primitive (breaks chaining) 6 months ago
treeview.go Add SetVisible and GetVisible to all widgets 6 months ago
treeview_test.go Add comments to tests 12 months ago
util.go Fix strikethrough support 2 months ago
util_test.go Remove return values from methods which return their primitive (breaks chaining) 6 months ago
window.go Use SetRect to position Windows 6 months ago
windowmanager.go Fix WindowManager background not being drawn 5 months ago

README.md

cview - Terminal-based user interface toolkit

GoDoc 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 tabbed panel 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.

Applications

A list of applications powered by cview is available via pkg.go.dev.

Installation

go get code.rocketnine.space/tslocum/cview

Hello World

This basic example creates a TextView titled "Hello, World!" and displays it in your terminal:

package main

import (
	"code.rocketnine.space/tslocum/cview"
)

func main() {
	app := cview.NewApplication()
	
	box := cview.NewTextView()
	box.SetBorder(true)
	box.SetTitle("Hello, world!")
	box.SetText("Lorem ipsum dolor sit amet")
	
	app.SetRoot(box, true)
	if err := app.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).