Terminal-based user interface toolkit
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Oliver 946d2620b6 Added GetSelectable() to Table so users can find out what is currently selectable. Resolves #21 5 years ago
demos Added password field to Form demo in presentation. 5 years ago
CODE_OF_CONDUCT.md Added a contact link to code of conduct. 5 years ago
LICENSE.txt First commit. Some basic functionality. Publishing to GitHub now. 5 years ago
README.md Layout fixes in readme. 5 years ago
application.go A resize event should have the screen cleared before redrawing. Fixes #19 5 years ago
box.go Added support for wide unicode characters (e.g. Chinese). Resolves #9 5 years ago
button.go Added support for wide unicode characters (e.g. Chinese). Resolves #9 5 years ago
checkbox.go Added support for wide unicode characters (e.g. Chinese). Resolves #9 5 years ago
doc.go Added support for wide unicode characters (e.g. Chinese). Resolves #9 5 years ago
dropdown.go Added support for wide unicode characters (e.g. Chinese). Resolves #9 5 years ago
flex.go Added links to Wiki to documentation. Also replaced screenshot with GIF screencast. 5 years ago
focusable.go Added list, improved existing primitives, and fixed a bunch of bugs. 5 years ago
form.go Added masking to InputField, password field to form. Resolves #7, resolves #8. 5 years ago
frame.go Added links to Wiki to documentation. Also replaced screenshot with GIF screencast. 5 years ago
inputfield.go Some adaptations for 32-bit systems. Resolves #17 5 years ago
list.go Added support for wide unicode characters (e.g. Chinese). Resolves #9 5 years ago
modal.go Added support for wide unicode characters (e.g. Chinese). Resolves #9 5 years ago
pages.go Added links to Wiki to documentation. Also replaced screenshot with GIF screencast. 5 years ago
primitive.go Added Checkbox, Modal, and Pages. 5 years ago
styles.go Added Styles variable with default colors for primitives. 5 years ago
table.go Added GetSelectable() to Table so users can find out what is currently selectable. Resolves #21 5 years ago
textview.go Fixed wrong TextView handling of tabs (and other runes without a width). 5 years ago
tview.gif Added links to Wiki to documentation. Also replaced screenshot with GIF screencast. 5 years ago
util.go Supporting any color now in TextView. Resolves #12 5 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
  • Selectable lists
  • 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://godoc.org/github.com/rivo/tview for the package's documentation.

Dependencies

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

Your Feedback

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

Releases

  • v0.4 (2018-01-12)
    • TextView now accepts color tags with any W3C color (including RGB hex values).
    • Support for wide unicode characters.
  • v0.3 (2018-01-11)
    • Added masking to InputField and password entry to Form.
  • v0.2 (2018-01-10)
    • Added Styles variable with default colors for primitives.
    • Completed some missing InputField functions.
  • v0.1 (2018-01-06)
    • First Release.