MCPcopy
hub / github.com/rivo/tview

github.com/rivo/tview @v0.42.0 sqlite

repository ↗ · DeepWiki ↗ · release v0.42.0 ↗
740 symbols 1,946 edges 63 files 713 documented · 96%
README

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!

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. 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.

Extension points exported contracts — how you extend this code

FormItem (Interface)
FormItem is the interface all form items must implement to be able to be included in a form. [6 implementers]
form.go
TableContent (Interface)
TableContent defines a Table's data. You may replace a Table's default implementation with your own using the Table.SetC [2 …
table.go
Primitive (Interface)
Primitive is the top-most interface for all graphical primitives. [1 implementers]
primitive.go
Slide (FuncType)
Slide is a function which returns the slide's main primitive and its title. It receives a "nextSlide" function which can
demos/presentation/main.go

Core symbols most depended-on inside this repo

AddItem
called by 88
grid.go
HasFocus
called by 46
primitive.go
NewBox
called by 33
box.go
GetInnerRect
called by 33
box.go
SetBorder
called by 30
box.go
SetContent
called by 28
table.go
SetTitle
called by 27
box.go
findCursor
called by 26
textarea.go

Shape

Method 616
Function 74
Struct 43
Interface 3
TypeAlias 3
FuncType 1

Languages

Go100%

Modules by API surface

table.go80 symbols
textarea.go63 symbols
textview.go55 symbols
form.go52 symbols
treeview.go51 symbols
dropdown.go42 symbols
inputfield.go40 symbols
list.go39 symbols
box.go39 symbols
application.go31 symbols
checkbox.go27 symbols
image.go25 symbols

Used by 5 indexed graphs manifest dependencies, hub-wide

github.com/GoogleContainerTools/skaffold
github.com/cli/cli
github.com/expr-lang/expr
github.com/kubevela/kubevela
github.com/wtfutil/wtf

Dependencies from manifests, versioned

github.com/gdamore/encodingv1.0.1 · 1×
github.com/gdamore/tcell/v2v2.8.1 · 1×
github.com/lucasb-eyer/go-colorfulv1.2.0 · 1×
github.com/mattn/go-runewidthv0.0.16 · 1×
github.com/rivo/unisegv0.4.7 · 1×
golang.org/x/sysv0.29.0 · 1×
golang.org/x/termv0.28.0 · 1×
golang.org/x/textv0.21.0 · 1×

For agents

$ claude mcp add tview \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact