Terminal UI library with rich, interactive widgets — written in Golang
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
rivo b0d41c484b
Merge pull request #966 from cuibuwei/master
chore: remove repetitive word
10 hours ago
.github Simplified funding button. 2 years ago
demos Enabled bracketed pasting. 2 months ago
CONTRIBUTING.md Added a clarifying note to the contributing guidelines. 4 years ago
LICENSE.txt Replaced license placeholders. Fixes #149 6 years ago
README.md Updated go get instruction so users will get the latest version. 2 months ago
ansi.go Implemented string parser and migrated all widgets but TextView. 8 months ago
application.go Added individual styling for selected table cells. Resolves #934 1 week ago
borders.go added configurable borders 6 years ago
box.go Added individual styling for selected table cells. Resolves #934 1 week ago
button.go Form elements can now also be disabled. Resolves #192 1 year ago
checkbox.go Switched to using styles in Checkbox. More customization options. 3 months ago
doc.go Clarifications on mouse handling, resolves #667 1 week ago
dropdown.go Fixed inconsistent selection styles in List, bugfixes in printWithStyle, removed reliance on ColorDefault. Fixes #954, resolves #960 1 week ago
flex.go Enabled bracketed pasting. 2 months ago
form.go chore: remove repetitive word 10 hours ago
frame.go Enabled bracketed pasting. 2 months ago
go.mod feat: update gdamore/tcell to 2.7.1 2 months ago
go.sum feat: update gdamore/tcell to 2.7.1 2 months ago
grid.go Removed code that forced the last grid item to be aligned bottom right. Fixes #951 1 week ago
image.go Fix typos 5 months ago
inputfield.go Fixed inconsistent selection styles in List, bugfixes in printWithStyle, removed reliance on ColorDefault. Fixes #954, resolves #960 1 week ago
list.go Fixed inconsistent selection styles in List, bugfixes in printWithStyle, removed reliance on ColorDefault. Fixes #954, resolves #960 1 week ago
modal.go Drawing the Box in Modal, not in contained Frame. Fixes #946 1 month ago
pages.go Enabled bracketed pasting. 2 months ago
primitive.go Enabled bracketed pasting. 2 months ago
semigraphics.go Merge pull request #910 from kianmeng/fix-typos 5 months ago
strings.go Fixed inconsistent selection styles in List, bugfixes in printWithStyle, removed reliance on ColorDefault. Fixes #954, resolves #960 1 week ago
styles.go Fixed the default theme to use ANSI palette colours only. 8 months ago
table.go Added individual styling for selected table cells. Resolves #934 1 week ago
textarea.go Handling end-of-text special case in TextArea.Select(). Fixes #958 2 weeks ago
textview.go fixing #959 textview mouse out of bounds fix 2 weeks ago
treeview.go Added TreeView.GetPath method. Resolves #897 6 months ago
tview.gif Finished Image implementation. 1 year ago
util.go Fixed inconsistent selection styles in List, bugfixes in printWithStyle, removed reliance on ColorDefault. Fixes #954, resolves #960 1 week ago

README.md

Rich Interactive Widgets for Terminal UIs

PkgGoDev Go Report

This Go package provides commonly used components for terminal based user interfaces.

Screenshot

Among these components are:

  • Input forms (including text input, selections, checkboxes, and buttons)
  • Navigable multi-color text views
  • Editable multi-line text areas
  • Sophisticated navigable table views
  • Flexible tree views
  • Selectable lists
  • Images
  • 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.

Usage

To add this package to your project:

go get github.com/rivo/tview@master

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. Also check out the Wiki.

Dependencies

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

Sponsor this Project

Become a Sponsor on GitHub to further this project!

Versioning and Backwards-Compatibility

I try really hard to keep this project backwards compatible. Your software should not break when you upgrade tview. But this also means that some of its shortcomings that were present in the initial versions will remain. In addition, at least for the time being, you won't find any version tags in this repo. The newest version should be the one to upgrade to. It has all the bugfixes and latest features. Having said that, backwards compatibility may still break when:

  • a new version of an imported package (most likely tcell) changes in such a way that forces me to make changes in tview as well,
  • I fix something that I consider a bug, rather than a feature, something that does not work as originally intended,
  • I make changes to "internal" interfaces such as Primitive. You shouldn't need these interfaces unless you're writing your own primitives for tview. (Yes, I realize these are public interfaces. This has advantages as well as disadvantages. For the time being, it is what it is.)

Your Feedback

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

Code of Conduct

We follow Golang's Code of Conduct which you can find here.