README.md
This Go package provides commonly used components for terminal based user interfaces.
Among these components are:
They come with lots of customization options and can be easily extended to fit your needs.
To add this package to your project:
go get github.com/rivo/tview@master
This basic example creates a box titled "Hello, World!" and displays it in your terminal:
package main
import (
"github.com/rivo/tview"
)
func main() {
box := tview.NewBox().SetBorder(true).SetTitle("Hello, world!")
if err := tview.NewApplication().SetRoot(box, true).Run(); err != nil {
panic(err)
}
}
Check out the GitHub Wiki for more examples along with screenshots. Or try the examples in the "demos" subdirectory.
For a presentation highlighting this package, compile and run the program found in the "demos/presentation" subdirectory.
tviewtviewRefer to https://pkg.go.dev/github.com/rivo/tview for the package's documentation. Also check out the Wiki.
This package is based on github.com/gdamore/tcell (and its dependencies) as well as on github.com/rivo/uniseg.
Become a Sponsor on GitHub to further this project!
I try really hard to keep this project backwards compatible. Your software should not break when you upgrade tview. But this also means that some of its shortcomings that were present in the initial versions will remain. Having said that, backwards compatibility may still break when:
tcell) changes in such a way that forces me to make changes in tview as well,Primitive. You shouldn't need these interfaces unless you're writing your own primitives for tview. (Yes, I realize these are public interfaces. This has advantages as well as disadvantages. For the time being, it is what it is.)Add your issue here on GitHub. Feel free to get in touch if you have any questions.
We follow Golang's Code of Conduct which you can find here.