Rachel Williams d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
..
CODE_OF_CONDUCT.md d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
CONTRIBUTING.md d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
LICENSE.txt d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
README.md d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
ansi.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
application.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
borders.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
box.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
button.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
checkbox.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
doc.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
dropdown.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
flex.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
focusable.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
form.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
frame.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
go.mod d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
go.sum d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
grid.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
inputfield.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
list.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
modal.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
pages.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
primitive.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
semigraphics.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
styles.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
table.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
textview.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
treeview.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
tview.gif d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago
util.go d8ebde37ca TUN-3201: Create base cloudflared UI structure 4 years ago

README.md

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.

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.