forked from tslocum/cview
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.
|
3 years ago | |
---|---|---|
.builds | 3 years ago | |
demos | 3 years ago | |
.gitignore | 3 years ago | |
CONTRIBUTING.md | 3 years ago | |
FORK.md | 3 years ago | |
LICENSE | 3 years ago | |
README.md | 3 years ago | |
ansi.go | 3 years ago | |
application.go | 3 years ago | |
borders.go | 3 years ago | |
box.go | 3 years ago | |
button.go | 3 years ago | |
checkbox.go | 3 years ago | |
cview.gif | 3 years ago | |
doc.go | 3 years ago | |
dropdown.go | 3 years ago | |
flex.go | 3 years ago | |
focusable.go | 3 years ago | |
form.go | 3 years ago | |
frame.go | 3 years ago | |
go.mod | 3 years ago | |
go.sum | 3 years ago | |
grid.go | 3 years ago | |
inputfield.go | 3 years ago | |
list.go | 3 years ago | |
modal.go | 3 years ago | |
pages.go | 3 years ago | |
primitive.go | 3 years ago | |
semigraphics.go | 3 years ago | |
styles.go | 3 years ago | |
table.go | 3 years ago | |
textview.go | 3 years ago | |
treeview.go | 3 years ago | |
util.go | 3 years ago |
README.md
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