Terminal-based user interface toolkit
Go to file
Oliver 09ec4666c8 Added a contact link to code of conduct. 2018-01-12 08:09:08 +01:00
demos Added masking to InputField, password field to form. Resolves #7, resolves #8. 2018-01-11 16:13:01 +01:00
CODE_OF_CONDUCT.md Added a contact link to code of conduct. 2018-01-12 08:09:08 +01:00
LICENSE.txt First commit. Some basic functionality. Publishing to GitHub now. 2017-12-15 15:29:21 +01:00
README.md Updated readme. 2018-01-11 16:55:22 +01:00
application.go Application does not lock on PollEvent() call anymore. Should resolve gridlocks when calling SetRoot() in goroutines. Resolves #6 2018-01-11 11:54:22 +01:00
box.go Added support for wide unicode characters (e.g. Chinese). Resolves #9 2018-01-11 15:45:52 +01:00
button.go Added support for wide unicode characters (e.g. Chinese). Resolves #9 2018-01-11 15:45:52 +01:00
checkbox.go Added support for wide unicode characters (e.g. Chinese). Resolves #9 2018-01-11 15:45:52 +01:00
doc.go Added support for wide unicode characters (e.g. Chinese). Resolves #9 2018-01-11 15:45:52 +01:00
dropdown.go Added support for wide unicode characters (e.g. Chinese). Resolves #9 2018-01-11 15:45:52 +01:00
flex.go Added links to Wiki to documentation. Also replaced screenshot with GIF screencast. 2018-01-07 16:39:06 +01:00
focusable.go Added list, improved existing primitives, and fixed a bunch of bugs. 2017-12-16 22:48:26 +01:00
form.go Added masking to InputField, password field to form. Resolves #7, resolves #8. 2018-01-11 16:13:01 +01:00
frame.go Added links to Wiki to documentation. Also replaced screenshot with GIF screencast. 2018-01-07 16:39:06 +01:00
inputfield.go Added masking to InputField, password field to form. Resolves #7, resolves #8. 2018-01-11 16:13:01 +01:00
list.go Added support for wide unicode characters (e.g. Chinese). Resolves #9 2018-01-11 15:45:52 +01:00
modal.go Added support for wide unicode characters (e.g. Chinese). Resolves #9 2018-01-11 15:45:52 +01:00
pages.go Added links to Wiki to documentation. Also replaced screenshot with GIF screencast. 2018-01-07 16:39:06 +01:00
primitive.go Added Checkbox, Modal, and Pages. 2017-12-20 20:54:49 +01:00
styles.go Added Styles variable with default colors for primitives. 2018-01-10 09:44:21 +01:00
table.go Added support for wide unicode characters (e.g. Chinese). Resolves #9 2018-01-11 15:45:52 +01:00
textview.go Added support for wide unicode characters (e.g. Chinese). Resolves #9 2018-01-11 15:45:52 +01: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 Added support for wide unicode characters (e.g. Chinese). Resolves #9 2018-01-11 15:45:52 +01: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 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.

Your Feedback

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

Releases

  • 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