tview README

The project's README from github.com/rivo/tview. As one markdown file: 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:

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:

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.

tview (rivo/tview)

Searching Database…

14.1K ·GitHub
Tview
Что это такое?tview — это пакет для Go, который предоставляет готовые интерактивные виджеты для создания терминальных пользовательских интерфейсов: формы ввода, текстовые просмотрщики, редактируемые текстовые области, таблицы, древовидные представления, списки, изображения, макеты и модальные окна.
Это фреймворк или библиотека?Это библиотека Go, которую вы подключаете к своей программе. В неё входит обёртка приложения, которая запускает цикл обработки событий, но сама по себе tview не является отдельным приложением.
Как добавить её в проект?Добавьте пакет в свой проект Go стандартными средствами работы с модулями (go get), затем подключите его и используйте пример «Hello, World!» с окном-прямоугольником как отправную точку.
От чего зависит tview?Она построена на основе github.com/gdamore/tcell для работы с терминалом и github.com/rivo/uniseg для разбиения Unicode-текста на сегменты.
Сломается ли мой код при будущих обновлениях?Автор старается сохранять обратную совместимость tview, но поломки всё же возможны: если этого потребуют изменения в tcell, если исправят ошибку или если изменятся внутренние интерфейсы, например Primitive.
Какие виджеты есть в tview сразу из коробки?Формы ввода с текстовыми полями, списками выбора, флажками и кнопками, текстовые просмотрщики с несколькими цветами, редактируемые текстовые области, таблицы с навигацией, древовидные представления, списки с выбором, изображения, макеты Flexbox, сетки и страничные макеты, а также модальные окна с сообщениями.
Где посмотреть реальные примеры использования tview?В README перечислены десятки реальных проектов на tview, например K9s (CLI для Kubernetes), gh (CLI для GitHub), lazysql и podman-tui. Также есть подпапка demos и вики на GitHub со скриншотами.
Почему tview так популярна у авторов CLI-инструментов?Она даёт разработчикам Go готовые настраиваемые терминальные виджеты, так что не нужно создавать формы, таблицы и макеты с нуля. Поэтому её выбрали многие популярные CLI-инструменты на Go, например K9s, gh и ktop.
What are similar projects?FTXUI, lazygit, superfile, spotify-tui, lipgloss, bubbletea, plandex, python-prompt-toolkit
Which topics is it in?user-interface, terminal-based, tui, golang, command-line, ui, go, terminal, library, cli, cross-platform, developer-tools
Creator
rivo
Size
6.4 MB
Stars
14.1K
Updated
CommitAug 11Releasev0.42.0Aug 27
Age
8y
Commits · 90 Days