piframe-go/vendor/github.com/rivo/tview
2020-09-20 20:00:07 -04:00
..
ansi.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
application.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
borders.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
box.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
button.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
checkbox.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
CODE_OF_CONDUCT.md Update vendoring for new ui 2020-08-28 15:19:36 -04:00
CONTRIBUTING.md Update vendoring for new ui 2020-08-28 15:19:36 -04:00
doc.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
dropdown.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
flex.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
focusable.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
form.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
frame.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
go.mod Update vendoring for new ui 2020-08-28 15:19:36 -04:00
go.sum Update vendoring for new ui 2020-08-28 15:19:36 -04:00
grid.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
inputfield.go Update vendoring 2020-09-20 20:00:07 -04:00
LICENSE.txt Update vendoring for new ui 2020-08-28 15:19:36 -04:00
list.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
modal.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
pages.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
primitive.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
README.md Update vendoring for new ui 2020-08-28 15:19:36 -04:00
semigraphics.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
styles.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
table.go Update vendoring 2020-09-20 20:00:07 -04:00
textview.go Update vendoring 2020-09-20 20:00:07 -04:00
treeview.go Update vendoring for new ui 2020-08-28 15:19:36 -04:00
tview.gif Update vendoring for new ui 2020-08-28 15:19:36 -04:00
util.go Update vendoring 2020-09-20 20:00:07 -04:00

Rich Interactive Widgets for Terminal UIs

Godoc Reference Go Report

This Go package provides commonly needed components for terminal based user interfaces.

Screenshot

Among these components are:

  • Input forms (include 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

They come with lots of customization options and can be easily extended to fit your needs.

Installation

go get github.com/rivo/tview

Hello World

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.

Projects using tview

Documentation

Refer to https://pkg.go.dev/github.com/rivo/tview for the package's documentation.

Dependencies

This package is based on github.com/gdamore/tcell (and its dependencies) as well as on github.com/rivo/uniseg.

Your Feedback

Add your issue here on GitHub. Feel free to get in touch if you have any questions.