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 be22f3b33c Release v1.5.7 10 months ago
demos Add Application.HandlePanic 11 months ago
.gitignore Document TextView region tag fix 11 months ago
CHANGELOG Release v1.5.7 10 months ago
CONTRIBUTING.md Add code.rocketnine.space migration notice 1 year ago
DESIGN.md Add code.rocketnine.space migration notice 1 year ago
FORK.md Add Application.Draw change to FORK.md 12 months ago
LICENSE Document TextView region tag fix 11 months ago
Makefile chore: Add makefile and use in `gitlab-ci.yml` 2 years ago
README.md Add Button.SetCursorRune and CheckBox.SetCursorRune 1 year ago
ansi.go Bugfixes in ANSI escape sequence handling as well as TextView, fixes #320, fixes #344 2 years ago
application.go Draw application after updating root primitive via Application.SetRoot 11 months ago
borders.go Fork tview as cview 3 years ago
box.go Document how to prevent screen artifacts when using SetBackgroundTransparent 2 years ago
box_test.go Add comments to tests 2 years ago
button.go Improve Button cursor positioning 1 year ago
button_test.go Add comments to tests 2 years ago
checkbox.go Add Button.SetCursorRune and CheckBox.SetCursorRune 1 year ago
checkbox_test.go Add comments to tests 2 years ago
contextmenu.go Rename SetBorderPadding and GetBorderPadding as SetPadding and GetPadding 2 years ago
cview.svg Update presentation demo recording 2 years ago
doc.go Add TabbedPanels to doc.go 1 year ago
doc_test.go Add Application.HandlePanic 11 months ago
dropdown.go Add Button.SetCursorRune and CheckBox.SetCursorRune 1 year ago
flex.go Fill empty space in Flex with invisible Box 1 year ago
focus.go Add FocusManager 2 years ago
form.go Add Button.SetCursorRune and CheckBox.SetCursorRune 1 year ago
frame.go Add SetVisible and GetVisible to all widgets 2 years ago
go.mod runewidth: Create lookup table 10 months ago
go.sum runewidth: Create lookup table 10 months ago
grid.go Fix passing mouse events to Grid items 1 year ago
inputfield.go Fix drawing InputField cursor outside of the field 12 months ago
keys.go Add code.rocketnine.space migration notice 1 year ago
list.go Update List, Table and TreeView to not handle Tab or Backtab 1 year ago
list_test.go Remove return values from methods which return their primitive (breaks chaining) 2 years ago
modal.go Add Modal.SetButtonsAlign and Modal.SetTextAlign 12 months ago
mouse.go Print text using []byte instead of string, calculate string width using runewidth instead of uniseg 2 years ago
panels.go Preserve order of panels when updating panel 2 years ago
primitive.go Allow hiding form items 2 years ago
progressbar.go Add SetVisible and GetVisible to all widgets 2 years ago
progressbar_test.go Add comments to tests 2 years ago
semigraphics.go Upgrade tcell to v2 2 years ago
slider.go Improve Button cursor positioning 1 year ago
styles.go Add Button.SetCursorRune and CheckBox.SetCursorRune 1 year ago
tabbedpanels.go Add TextView highlight color options 1 year ago
table.go Update List, Table and TreeView to not handle Tab or Backtab 1 year ago
table_test.go Store ListItem text as []byte instead of string 2 years ago
textview.go Fixed missed tag at EOL in TextView 11 months ago
textview_test.go Remove return values from methods which return their primitive (breaks chaining) 2 years ago
treeview.go Update List, Table and TreeView to not handle Tab or Backtab 1 year ago
treeview_test.go Add comments to tests 2 years ago
util.go runewidth: Create lookup table 10 months ago
util_test.go Remove return values from methods which return their primitive (breaks chaining) 2 years ago
window.go Use SetRect to position Windows 2 years ago
windowmanager.go Fix WindowManager background not being drawn 2 years 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()

	tv := cview.NewTextView()
	tv.SetBorder(true)
	tv.SetTitle("Hello, world!")
	tv.SetText("Lorem ipsum dolor sit amet")
	
	app.SetRoot(tv, true)
	if err := app.Run(); err != nil {
		panic(err)
	}
}

Examples are available via godoc and in the demos directory.

For a presentation highlighting the features of this package, compile and run the program in the demos/presentation directory.

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