README.md
1# Rich Interactive Widgets for Terminal UIs
2
3[![Godoc Reference](https://img.shields.io/badge/godoc-reference-blue.svg)](https://godoc.org/github.com/rivo/tview)
4[![Go Report](https://img.shields.io/badge/go%20report-A%2B-brightgreen.svg)](https://goreportcard.com/report/github.com/rivo/tview)
5
6This Go package provides commonly needed components for terminal based user interfaces.
7
8![Screenshot](tview.gif)
9
10Among these components are:
11
12- __Input forms__ (include __input/password fields__, __drop-down selections__, __checkboxes__, and __buttons__)
13- Navigable multi-color __text views__
14- Sophisticated navigable __table views__
15- Flexible __tree views__
16- Selectable __lists__
17- __Grid__, __Flexbox__ and __page layouts__
18- Modal __message windows__
19- An __application__ wrapper
20
21They come with lots of customization options and can be easily extended to fit your needs.
22
23## Installation
24
25```bash
26go get github.com/rivo/tview
27```
28
29## Hello World
30
31This basic example creates a box titled "Hello, World!" and displays it in your terminal:
32
33```go
34package main
35
36import (
37 "github.com/rivo/tview"
38)
39
40func main() {
41 box := tview.NewBox().SetBorder(true).SetTitle("Hello, world!")
42 if err := tview.NewApplication().SetRoot(box, true).Run(); err != nil {
43 panic(err)
44 }
45}
46```
47
48Check out the [GitHub Wiki](https://github.com/rivo/tview/wiki) for more examples along with screenshots. Or try the examples in the "demos" subdirectory.
49
50For a presentation highlighting this package, compile and run the program found in the "demos/presentation" subdirectory.
51
52## Documentation
53
54Refer to https://godoc.org/github.com/rivo/tview for the package's documentation.
55
56## Dependencies
57
58This package is based on [github.com/gdamore/tcell](https://github.com/gdamore/tcell) (and its dependencies) as well as on [github.com/rivo/uniseg](https://github.com/rivo/uniseg).
59
60## Your Feedback
61
62Add your issue here on GitHub. Feel free to get in touch if you have any questions.
63
64## Version History
65
66(There are no corresponding tags in the project. I only keep such a history in this README.)
67
68- v0.19 (2018-10-28)
69 - Added `QueueUpdate()` and `QueueEvent()` to `Application` to help with modifications to primitives from goroutines.
70- v0.18 (2018-10-18)
71 - `InputField` elements can now be navigated freely.
72- v0.17 (2018-06-20)
73 - Added `TreeView`.
74- v0.15 (2018-05-02)
75 - `Flex` and `Grid` don't clear their background per default, thus allowing for custom modals. See the [Wiki](https://github.com/rivo/tview/wiki/Modal) for an example.
76- v0.14 (2018-04-13)
77 - Added an `Escape()` function which keep strings like color or region tags from being recognized as such.
78 - Added `ANSIWriter()` and `TranslateANSI()` which convert ANSI escape sequences to `tview` color tags.
79- v0.13 (2018-04-01)
80 - Added background colors and text attributes to color tags.
81- v0.12 (2018-03-13)
82 - Added "suspended mode" to `Application`.
83- v0.11 (2018-03-02)
84 - Added a `RemoveItem()` function to `Grid` and `Flex`.
85- v0.10 (2018-02-22)
86 - Direct access to the `screen` object through callback in `Box` (i.e. for all primitives).
87- v0.9 (2018-02-20)
88 - Introduced `Grid` layout.
89 - Direct access to the `screen` object through callbacks in `Application`.
90- v0.8 (2018-01-17)
91 - Color tags can now be used almost everywhere.
92- v0.7 (2018-01-16)
93 - Forms can now also have a horizontal layout.
94- v0.6 (2018-01-14)
95 - All primitives can now intercept all key events when they have focus.
96 - Key events can also be intercepted globally (changed to a more general, consistent handling)
97- v0.5 (2018-01-13)
98 - `TextView` now has word wrapping and text alignment
99- v0.4 (2018-01-12)
100 - `TextView` now accepts color tags with any W3C color (including RGB hex values).
101 - Support for wide unicode characters.
102- v0.3 (2018-01-11)
103 - Added masking to `InputField` and password entry to `Form`.
104- v0.2 (2018-01-10)
105 - Added `Styles` variable with default colors for primitives.
106 - Completed some missing InputField functions.
107- v0.1 (2018-01-06)
108 - First Release.
109