2
0
mirror of https://github.com/rivo/tview.git synced 2024-11-15 06:12:46 +00:00
Terminal UI library with rich, interactive widgets — written in Golang
Go to file
2020-09-26 07:09:04 +00:00
demos Bugfix in Flex which led to a panic. 2020-08-18 14:03:38 +02:00
ansi.go Merge pull request #444 from mjwhitta/master 2020-05-28 22:02:48 +02:00
application.go Removed size change check (apparently this led to problems on Windows). Fixes #401, closes #404 2020-08-18 12:21:46 +02:00
borders.go added configurable borders 2018-06-09 14:58:29 +02:00
box.go Added getters for common Box attributes. Resolves #427 2020-04-14 13:29:54 +02:00
button.go Added/fixed comments, some structural changes/bugfixes for mouse support. Table, TextView, and TreeView still open. Closes #363 2020-03-27 18:41:44 +01:00
checkbox.go Added/fixed comments, some structural changes/bugfixes for mouse support. Table, TextView, and TreeView still open. Closes #363 2020-03-27 18:41:44 +01:00
CODE_OF_CONDUCT.md Added a contact link to code of conduct. 2018-01-12 08:09:08 +01:00
CONTRIBUTING.md Added a clarifying note to the contributing guidelines. 2019-11-27 19:11:06 +01:00
doc.go Minor improvements. 2018-12-26 21:24:39 +01:00
dropdown.go Keyboard events are now propagated down the hierarchy, allowing users to intercept them. Closes #421 2020-08-18 12:05:43 +02:00
flex.go Bugfix in Flex which led to a panic. 2020-08-18 14:03:38 +02:00
focusable.go Added list, improved existing primitives, and fixed a bunch of bugs. 2017-12-16 22:48:26 +01:00
form.go Keyboard events are now propagated down the hierarchy, allowing users to intercept them. Closes #421 2020-08-18 12:05:43 +02:00
frame.go Keyboard events are now propagated down the hierarchy, allowing users to intercept them. Closes #421 2020-08-18 12:05:43 +02:00
go.mod Keyboard events are now propagated down the hierarchy, allowing users to intercept them. Closes #421 2020-08-18 12:05:43 +02:00
go.sum Keyboard events are now propagated down the hierarchy, allowing users to intercept them. Closes #421 2020-08-18 12:05:43 +02:00
grid.go Keyboard events are now propagated down the hierarchy, allowing users to intercept them. Closes #421 2020-08-18 12:05:43 +02:00
inputfield.go Selected autocomplete items should be used without colour tags. Fixes #472 2020-09-15 13:45:12 +02:00
LICENSE.txt Replaced license placeholders. Fixes #149 2018-08-04 11:55:25 +02:00
list.go Merge pull request #418 from abitrolly/patch-2 2020-04-14 13:53:51 +02:00
modal.go Keyboard events are now propagated down the hierarchy, allowing users to intercept them. Closes #421 2020-08-18 12:05:43 +02:00
pages.go Keyboard events are now propagated down the hierarchy, allowing users to intercept them. Closes #421 2020-08-18 12:05:43 +02:00
primitive.go Added/fixed comments, some structural changes/bugfixes for mouse support. Table, TextView, and TreeView still open. Closes #363 2020-03-27 18:41:44 +01:00
README.md docs(readme): add glab to tview projects 2020-09-26 07:09:04 +00:00
semigraphics.go Removed deprecated funcs/const related to semigraphic changes 2018-06-09 14:58:29 +02:00
styles.go Fixed some comments. 2019-03-09 14:04:59 +01:00
table.go Added a "clicked" handler to TableCell. Resolves #470 2020-09-15 13:09:44 +02:00
textview.go Selected autocomplete items should be used without colour tags. Fixes #472 2020-09-15 13:45:12 +02:00
treeview.go Also call node.selected on node click 2020-04-29 01:18:31 +00:00
tview.gif Added links to Wiki to documentation. Also replaced screenshot with GIF screencast. 2018-01-07 16:39:06 +01:00
util.go Selected autocomplete items should be used without colour tags. Fixes #472 2020-09-15 13:45:12 +02: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.