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 68b2c49d11 Fix WindowManager background not being drawn 2 years ago
demos Rename SetBorderPadding and GetBorderPadding as SetPadding and GetPadding 2 years ago
.gitignore Update .gitignore 2 years ago
.gitlab-ci.yml chore: Add makefile and use in `gitlab-ci.yml` 2 years ago
CHANGELOG Fix WindowManager background not being drawn 2 years ago
CONTRIBUTING.md Migrate docs to docs.rocketnine.space 2 years ago
DESIGN.md Support custom TabbedPanels tab styling 2 years ago
FORK.md Handle events before executing queued updates 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 Update presentation demo recording 2 years ago
ansi.go Bugfixes in ANSI escape sequence handling as well as TextView, fixes #320, fixes #344 2 years ago
application.go Handle events before executing queued updates 2 years ago
borders.go Fork tview as cview 3 years ago
box.go Reduce Box inner rect calculations 2 years ago
box_test.go Add comments to tests 2 years ago
button.go Add SetVisible and GetVisible to all widgets 2 years ago
button_test.go Add comments to tests 2 years ago
checkbox.go Add SetVisible and GetVisible to all widgets 2 years 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 Display TextView scroll bar automatically by default 2 years ago
doc_test.go Remove return values from methods which return their primitive (breaks chaining) 2 years ago
dropdown.go Replace FormItem.SetAttributes with individual methods 2 years ago
flex.go Add SetVisible and GetVisible to all widgets 2 years ago
focus.go Add FocusManager 2 years ago
form.go Rename SetBorderPadding and GetBorderPadding as SetPadding and GetPadding 2 years ago
frame.go Add SetVisible and GetVisible to all widgets 2 years ago
go.mod Fix WindowManager background not being drawn 2 years ago
go.sum Fix WindowManager background not being drawn 2 years ago
grid.go Add SetVisible and GetVisible to all widgets 2 years ago
inputfield.go Add SetVisible and GetVisible to all widgets 2 years ago
keys.go Upgrade tcell to v2 2 years ago
list.go Add SetVisible and GetVisible to all widgets 2 years ago
list_test.go Remove return values from methods which return their primitive (breaks chaining) 2 years ago
modal.go Rename SetBorderPadding and GetBorderPadding as SetPadding and GetPadding 2 years ago
mouse.go Print text using []byte instead of string, calculate string width using runewidth instead of uniseg 2 years ago
panels.go Add deprecation notice to SetBorderPadding, GetBorderPadding and Pages 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 Add SetVisible and GetVisible to all widgets 2 years ago
styles.go Add Window and WindowManager 2 years ago
tabbedpanels.go Add TabbedPanels.HasTab 2 years ago
table.go Add SetVisible and GetVisible to all widgets 2 years ago
table_test.go Store ListItem text as []byte instead of string 2 years ago
textview.go Add TextView.SetWrapWidth 2 years ago
textview_test.go Remove return values from methods which return their primitive (breaks chaining) 2 years ago
treeview.go Add SetVisible and GetVisible to all widgets 2 years ago
treeview_test.go Add comments to tests 2 years ago
util.go Fix WordWrap dropping last character of closing tag 2 years 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 CI status Donate

This package is a fork of tview. See FORK.md for more information.

Warning: Breaking changes may be added to cview without bumping its major version. The largest changes have been made. Smaller breaking changes may continue to be made where backwards compatibility is not possible. Changes are listed in FORK.md.

Demo

ssh cview.rocketnine.space -p 20000

Recording of presentation demo

Additional examples are listed on pkg.go.dev.

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.

Installation

go get gitlab.com/tslocum/cview

Hello World

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

package main

import (
	"gitlab.com/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).