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 b357eaf10f Drop-down allows typing to directly jump to options. Resolves #77 4 years ago
demos Added placeholder text to InputField. Resolves #75 4 years ago
CODE_OF_CONDUCT.md Added a contact link to code of conduct. 5 years ago
CONTRIBUTING.md Added RemoveItem() to Grid and Flex. Resolves #63 5 years ago
LICENSE.txt First commit. Some basic functionality. Publishing to GitHub now. 5 years ago
README.md Updated release history. 5 years ago
application.go Added suspended mode to Application. (Swallows one key event, tcell issue pending.) Resolves #70 5 years ago
box.go Added getters for some callback functions. Resolves #65 5 years ago
button.go Added color tag functionality to all strings. Resolves #25 5 years ago
checkbox.go "FieldLength" is now "FieldWidth" everywhere for clarity and consistency. Sorry for this breaking change. It is better in the long run. 5 years ago
doc.go Added color tag functionality to all strings. Resolves #25 5 years ago
dropdown.go Drop-down allows typing to directly jump to options. Resolves #77 4 years ago
flex.go Added RemoveItem() to Grid and Flex. Resolves #63 5 years ago
focusable.go Added list, improved existing primitives, and fixed a bunch of bugs. 5 years ago
form.go Forms will attempt to keep focused form items within available area. Fixes #79 4 years ago
frame.go Added links to Wiki to documentation. Also replaced screenshot with GIF screencast. 5 years ago
grid.go Added RemoveItem() to Grid and Flex. Resolves #63 5 years ago
inputfield.go Added placeholder text to InputField. Resolves #75 4 years ago
list.go Drop-down allows typing to directly jump to options. Resolves #77 4 years ago
modal.go Added color tag functionality to all strings. Resolves #25 5 years ago
pages.go When a page with focus is removed, we should not end up with no focus anywhere. Also some simplifications. 5 years ago
primitive.go All primitives now offer a way to intercept all key events sent to them. Also made the global key event intercept handler more general/consistent. Resolves #22 5 years ago
styles.go Added placeholder text to InputField. Resolves #75 4 years ago
table.go Bugfix which caused a crash in Table class. Fixes #67 5 years ago
textview.go Finished implementation of grid layout. 5 years ago
tview.gif Added links to Wiki to documentation. Also replaced screenshot with GIF screencast. 5 years ago
util.go Rewrote WordWrap() function due to bugs. 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
  • 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://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.

Version History

(There are no corresponding tags in the project. I only keep such a history in this README.)

  • v0.12 (2018-03-13)
    • Added "suspended mode" to Application.
  • v0.11 (2018-03-02)
    • Added a RemoveItem() function to Grid and Flex.
  • v0.10 (2018-02-22)
    • Direct access to the screen object through callback in Box (i.e. for all primitives).
  • v0.9 (2018-02-20)
    • Introduced Grid layout.
    • Direct access to the screen object through callbacks in Application.
  • v0.8 (2018-01-17)
    • Color tags can now be used almost everywhere.
  • v0.7 (2018-01-16)
    • Forms can now also have a horizontal layout.
  • v0.6 (2018-01-14)
    • All primitives can now intercept all key events when they have focus.
    • Key events can also be intercepted globally (changed to a more general, consistent handling)
  • v0.5 (2018-01-13)
    • TextView now has word wrapping and text alignment
  • 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.