Categorygithub.com/rivo/tview

modulepackage

0.0.0-20241227133733-17b7edb88c57

Repository: https://github.com/rivo/tview.git

Documentation: pkg.go.dev

# README

Rich Interactive Widgets for Terminal UIs

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.

# Packages

demos

# Functions

ANSIWriter

ANSIWriter returns an io.Writer which translates any ANSI escape codes written to it into tview style tags.

Escape

Escape escapes the given text such that color and/or region tags are not recognized and substituted by the print functions of this package.

NewApplication

NewApplication creates and returns a new application.

NewBox

NewBox returns a Box without a border.

NewButton

NewButton returns a new input field.

NewCheckbox

NewCheckbox returns a new input field.

NewDropDown

NewDropDown returns a new drop-down.

NewFlex

NewFlex returns a new flexbox layout container with no primitives and its direction set to FlexColumn.

NewForm

NewForm returns a new form.

NewFrame

NewFrame returns a new frame around the given primitive.

NewGrid

NewGrid returns a new grid-based layout container with no initial primitives.

NewImage

NewImage returns a new image widget with an empty image (use [Image.SetImage] to specify the image to be displayed).

NewInputField

NewInputField returns a new input field.

NewList

NewList returns a new list.

NewModal

NewModal returns a new modal message window.

NewPages

NewPages returns a new Pages object.

NewTable

NewTable returns a new table.

NewTableCell

NewTableCell returns a new table cell with sensible defaults.

NewTextArea

NewTextArea returns a new text area.

NewTextView

NewTextView returns a new text view.

NewTreeNode

NewTreeNode returns a new tree node.

NewTreeView

NewTreeView returns a new tree view.

Print prints text onto the screen into the given box at (x,y,maxWidth,1), not exceeding that box.

PrintJoinedSemigraphics

PrintJoinedSemigraphics prints a semigraphics rune into the screen at the given position with the given style, joining it with any existing semigraphics rune.At this point, only regular single line borders are supported.

Rich Interactive Widgets for Terminal UIs

Usage

Hello World

Projects using tview

Documentation

Dependencies

Sponsor this Project

Versioning and Backwards-Compatibility

Your Feedback

Code of Conduct

Projects using `tview`