- Go 100%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
|
All checks were successful
checks / Vet / Test / Lint (push) Successful in 46s
|
||
| .forgejo/workflows | ||
| docs | ||
| example | ||
| render | ||
| term | ||
| test | ||
| widget | ||
| .gitignore | ||
| .golangci.yml | ||
| app.go | ||
| base.go | ||
| bus.go | ||
| compose.go | ||
| doc.go | ||
| draw.go | ||
| focus.go | ||
| go.mod | ||
| go.sum | ||
| headless.go | ||
| input.go | ||
| LICENSE | ||
| mouse.go | ||
| mouse_capture_test.go | ||
| node.go | ||
| quit.go | ||
| README.md | ||
| run.go | ||
| timer.go | ||
tui
TUI-библиотека с собственным терминальным ядром (go.neonxp.ru/tui/term). Компоненты с
собственными буферами, ленивая перерисовка, вывод только различий кадров,
клавиатура и мышь, мост к eventbus.
Быстрый старт
package main
import (
"context"
"go.neonxp.ru/tui"
"go.neonxp.ru/tui/render"
"go.neonxp.ru/tui/term/key"
)
type hello struct {
tui.Base
app *tui.App
text string
}
func (h *hello) Mounted(a *tui.App) { h.app = a }
func (h *hello) HandleKey(e key.Event) (bool, error) {
switch {
case e.Key == key.Escape || e.Rune == 'q':
h.app.Quit(tui.Quitf("выход"))
case e.Rune >= 0x20:
h.text += string(e.Rune)
h.Redraw()
}
return true, nil
}
func (h *hello) Paint(p *render.Painter) {
p.Clear(render.Style{})
p.Text(0, 0, h.text, render.Style{Attrs: render.AttrBold})
}
func main() {
a := tui.New(&hello{}, tui.WithAltScreen())
if err := a.Run(context.Background()); err != nil && !tui.IsQuit(err) {
panic(err)
}
}
Компонент встраивает tui.Base и переопределяет Paint. Redraw помечает
узел на перерисовку: без него узел в кадр не попадает, его буфер переиспользуется.
Готовые виджеты лежат в widget (Panel, ScrollView, Paragraph, Button,
Menu, Overlay, Label, Spacer, контейнеры Row/Column (с зазором или SetSharedBorder),
Pad/Align), widget/list (List), widget/table (Table, Tree),
widget/form (Input, Check, RadioGroup, Form, Tabs). Документация —
в docs/.
Кадры
App.Run раскладывает дерево, перерисовывает грязные узлы и выводит различия
кадра с предыдущим: позиционирование курсора + SGR-делта, синхронизированный
вывод (DEC 2026) — без мерцания. Буферы детей вставляются в буфер родителя,
буфер корня — это кадр. Каждая клетка принадлежит ровно одному узлу.
Ввод
Клавиши уходят узлу фокуса и всплывают к предкам, пока не потреблены. Tab и
Shift+Tab без потребителя двигают фокус. Мышь: событие самому глубокому узлу
под курсором, клик передаёт фокус, наведение — HandleHover. Вставка —
bracketed paste одной строкой. Всё доставляется на UI-потоке Run; мутации
состояния — только там.
Асинхронщина
func (c *comp) Mounted(a *tui.App) {
tui.Subscribe(a, func(tick) { c.n++; c.Redraw() })
go func() {
t := time.NewTicker(time.Second)
defer t.Stop()
for {
select {
case <-a.Context().Done():
return
case <-t.C:
a.Bus().Publish(tick{})
}
}
}()
}
Колбэк Subscribe выполняется на UI-потоке. Фоновая горутина общается с
приложением шиной (WithBus) и App.Context().
Для отложенных вызовов своих goroutine не нужно:
stop := tui.Every(a, time.Second, func() { c.clock++; c.Redraw() })
defer stop()
tui.After(a, 300*time.Millisecond, func() { toast.Close() })
Тестирование
Приложение гоняется headless, проверки смотрят на клетки кадра:
package myapp
import (
"testing"
"go.neonxp.ru/tui/test"
"go.neonxp.ru/tui/widget"
"go.neonxp.ru/tui/widget/form"
)
func TestGreet(t *testing.T) {
in := form.NewInput()
h := test.New(widget.Column(0, in), 20, 3)
h.Mount()
in.RequestFocus()
if err := h.Type("world"); err != nil {
t.Fatal(err)
}
if got := h.Line(0); got != "world" {
t.Errorf("frame: %q", got)
}
}
Press/Type/Click доставляют события, Lines/Line/Cell читают кадр,
Wait исполняет очередь таймеров и шины, Out/ResetOut дают байты вывода —
для проверки инкрементальности кадра.
TextView и Textarea
widget/textview — просмотрщик кода/логов с внешним провайдером стилей,
программным выделением и скроллом; опция Editable() превращает его в редактор
(или своя стратегия Editor — emacs/vi-кейбинды). Подсветка, blame, поиск — внешние StyleSource/Gutter,
виджет о них не знает:
tv := textview.New(src)
tv.SetLeftGutters(textview.NewLineNumbers())
tv.SetStyleSource(myHighlighter) // только для видимых строк
tv.SetSelection(from, to) // скролл не двигает: он отдельный API
tv.CenterCursor()
ta := textview.New("", textview.Editable()) // + печать, Enter, Ctrl-слова, Shift-выделение,
ta.SetPlaceholder("пусто") // Ctrl+A/C (OSC 52), paste, readonly
Стилизация
Тем в библиотеке нет — каждый виджет настраивается сеттером:
panel := widget.NewPanel("ToDo List", list)
st := panel.Style()
st.Border.Fg = term.Palette(12) // синий
st.Border.Set = render.DoubleBorder // двойная рамка
panel.SetStyle(st)
Row/Column с SetSharedBorder раскладывают панели внахлёст: общая граница занимает одно
знакоместо, как в Far/Norton Commander; стыки (┬ ┴ ├ ┤ ┼) дорисовывает
контейнер, стиль шва забирает панель с фокусом. Строки списка реализуют
SetSelected(bool) и сами решают, как рисовать выделение. Глифы — данные:
BorderSet, ScrollSet, нулевой глиф оставляет символ по умолчанию.
Примеры
example/counter— событийная шина, тики из горутиныexample/todo— приёмочный макет: шапка с часами, панели, список с переносом выполненных, футер хоткеевexample/textview— читалка кода: подсветка, номера строк, blame-gutter, поиск с выделениемexample/editor— редактор на Textarea: статусная строка, Tab вставляет таб, подсветка цифр и "строк"
Требования
Go 1.27+, VT100-совместимый терминал, Unix. Зависимости: eventbus, go-runewidth.
Лицензия
GPL v3, см. LICENSE.