cloudflared-mirror/vendor/github.com/rivo/tview
cthuang d54c8cc745 TUN-5129: Use go 1.17 and copy .git folder to docker build to compute version 2021-09-21 15:50:35 +00:00
..
CODE_OF_CONDUCT.md TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
CONTRIBUTING.md TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
LICENSE.txt TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
README.md TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
ansi.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
application.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
borders.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
box.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
button.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
checkbox.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
doc.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
dropdown.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
flex.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
focusable.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
form.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
frame.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
grid.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
inputfield.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
list.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
modal.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
pages.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
primitive.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
semigraphics.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
styles.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
table.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
textview.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
treeview.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
tview.gif TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00
util.go TUN-3201: Create base cloudflared UI structure 2020-09-17 11:52:07 +04:00

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.