Terminal-based user interface toolkit
Go to file
Oliver c989300073 Final preparations for the first official release. 2018-01-06 22:49:12 +01:00
demos Final preparations for the first official release. 2018-01-06 22:49:12 +01:00
LICENSE.txt First commit. Some basic functionality. Publishing to GitHub now. 2017-12-15 15:29:21 +01:00
README.md Final preparations for the first official release. 2018-01-06 22:49:12 +01:00
application.go Various improvements. 2018-01-01 21:50:20 +01:00
box.go Final preparations for the first official release. 2018-01-06 22:49:12 +01:00
button.go No need to explicitly hide the cursor in no-cursor primitives. 2017-12-28 22:19:36 +01:00
checkbox.go No need to explicitly hide the cursor in no-cursor primitives. 2017-12-28 22:19:36 +01:00
doc.go Completed Godoc documentation. 2018-01-03 21:13:32 +01:00
dropdown.go More callback handlers for lists. And more consistency. 2018-01-01 17:17:20 +01:00
flex.go Fixed focus delegation. 2017-12-27 22:55:50 +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 Fixed focus delegation. 2017-12-27 22:55:50 +01:00
frame.go Various improvements. 2018-01-01 21:50:20 +01:00
inputfield.go Fixed a number of bugs and added missing useful functions. 2017-12-27 16:04:21 +01:00
list.go More callback handlers for lists. And more consistency. 2018-01-01 17:17:20 +01:00
modal.go Various improvements. 2018-01-01 21:50:20 +01:00
pages.go Various improvements. 2018-01-01 21:50:20 +01:00
primitive.go Added Checkbox, Modal, and Pages. 2017-12-20 20:54:49 +01:00
screenshot.jpg Final preparations for the first official release. 2018-01-06 22:49:12 +01:00
table.go Final preparations for the first official release. 2018-01-06 22:49:12 +01:00
textview.go Non-scrollable text views must track end. 2017-12-30 22:09:36 +01:00
util.go Final preparations for the first official release. 2018-01-06 22:49:12 +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)
  • Navigatable multi-color text views
  • Sophisticated navigatable 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.1 (2018-01-06)
    • First Release