Terminal-based user interface toolkit
|
||
---|---|---|
.builds | ||
demos | ||
.gitignore | ||
ansi.go | ||
application.go | ||
borders.go | ||
box.go | ||
button.go | ||
checkbox.go | ||
CONTRIBUTING.md | ||
cview.gif | ||
doc.go | ||
dropdown.go | ||
flex.go | ||
focusable.go | ||
FORK.md | ||
form.go | ||
frame.go | ||
go.mod | ||
go.sum | ||
grid.go | ||
inputfield.go | ||
LICENSE | ||
list.go | ||
modal.go | ||
pages.go | ||
primitive.go | ||
README.md | ||
semigraphics.go | ||
styles.go | ||
table.go | ||
textview.go | ||
treeview.go | ||
util.go |
Terminal-based user interface toolkit
This package is a fork of tview. It allows the creation of rich terminal-based user interfaces.
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
- An application wrapper
Widgets may be customized and extended to suit any application.
Installation
go get git.sr.ht/~tslocum/cview@latest
Hello World
This basic example creates a box titled "Hello, World!" and displays it in your terminal:
package main
import (
"git.sr.ht/~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 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 on godoc.
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).
cview has two mailing lists:
- cview-discuss for general discussion
- cview-dev for development discussion