gocui README

The project's README from github.com/jroimartin/gocui. As one markdown file: README.md.

GOCUI - Go Console User Interface

Go Reference

Minimalist Go package aimed at creating Console User Interfaces.

Features

Installation

Execute:

go get github.com/jroimartin/gocui

Documentation

Execute:

go doc github.com/jroimartin/gocui

Or visit pkg.go.dev to read it online.

Example

package main

import (
	"fmt"
	"log"

	"github.com/jroimartin/gocui"
)

func main() {
	g, err := gocui.NewGui(gocui.OutputNormal)
	if err != nil {
		log.Panicln(err)
	}
	defer g.Close()

	g.SetManagerFunc(layout)

	if err := g.SetKeybinding("", gocui.KeyCtrlC, gocui.ModNone, quit); err != nil {
		log.Panicln(err)
	}

	if err := g.MainLoop(); err != nil && err != gocui.ErrQuit {
		log.Panicln(err)
	}
}

func layout(g *gocui.Gui) error {
	maxX, maxY := g.Size()
	if v, err := g.SetView("hello", maxX/2-7, maxY/2, maxX/2+7, maxY/2+2); err != nil {
		if err != gocui.ErrUnknownView {
			return err
		}
		fmt.Fprintln(v, "Hello world!")
	}
	return nil
}

func quit(g *gocui.Gui, v *gocui.View) error {
	return gocui.ErrQuit
}

Screenshots

r2cui

_examples/demo.go

_examples/dynamic.go

gocui (jroimartin/gocui)

Searching Database…

10.6K ·GitHub
Gocui
Что это такое?Gocui — это минималистичный пакет для Go, с помощью которого создают консольные интерфейсы (TUI): текстовые приложения, работающие прямо в терминале, с окнами, горячими клавишами и поддержкой мыши.
Так это готовая программа, которую я запускаю, или библиотека, на которой я пишу своё приложение?Это библиотека, а не готовая программа: вы подключаете её к своему Go-проекту и через её минималистичный API собираете собственный интерфейс для терминала.
Как добавить её в проект?Выполните go get github.com/jroimartin/gocui и импортируйте её, как любой другой пакет Go — кроме самого Go ничего дополнительно ставить не нужно. Полная справка по API есть на pkg.go.dev.
Как в нём устроен интерфейс — что такое «views»?Views («представления») — это базовые кирпичики, аналог окон в графическом интерфейсе. Каждое представление реализует io.ReadWriter, то есть пользовательский ввод из него читается, а вывод в него пишется, как в файл; представления могут перекрывать друг друга.
Могут ли приложения на нём реагировать на клавиатуру и мышь?Да — горячие клавиши можно назначать глобально или для отдельного представления, ввод с мыши тоже поддерживается. Выведенный текст можно раскрашивать, а режим редактирования текста настраивается.
Могу ли я менять интерфейс, пока приложение работает?Да. Интерфейс можно изменять прямо во время работы, и это безопасно при параллельном выполнении: даже если к нему одновременно обращаются несколько частей программы, всё остаётся согласованным.
Насколько gocui зрелый проект?Он существует с 2014 года и собрал более 10 000 звёзд на GitHub, так что это проверенный временем вариант для терминальных интерфейсов на Go. Распространяется под разрешительной лицензией BSD-3-Clause.
What are similar projects?wtf, BongoCat, ratatui, tui-rs, blessed, FTXUI, pyautogui, lipgloss
Which topics is it in?mouse, widgets, keyboard, lightweight, concurrency, tui, bsd, developers, ui, go, gui, free
Creator
jroimartin
Size
0.3 MB
Stars
10.6K
Updated
CommitMay 01
Age
12y
Commits · 90 Days