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 语言包，用来构建控制台用户界面——也就是在终端里运行的文本模式应用，支持窗口、快捷键和鼠标操作。
那它是一个我能直接运行的程序，还是一个用来开发自己应用的库？它是一个库，不是现成的程序：把它导入你的 Go 项目里，用它那套极简的 API 搭建你自己的终端界面。
怎么把它加到项目里？运行 go get github.com/jroimartin/gocui,然后像其他 Go 包一样导入即可——除了 Go 工具链之外不需要安装别的东西。完整的参考文档在 pkg.go.dev 上。
它是怎么组织界面的——'视图(views)'是什么？视图是它的基本构件，相当于图形界面里的窗口。每个视图都实现了 io.ReadWriter,所以你可以像读写文件一样从视图读取用户输入、向视图写入输出，而且各个视图之间可以相互重叠。
用它开发的应用能响应键盘和鼠标吗？可以——快捷键既可以全局注册，也可以针对单个视图注册，还支持鼠标输入。渲染出来的文字可以上色，文本编辑模式也可以自定义。
应用运行的时候我还能改界面吗？可以。界面可以在运行时修改，而且是并发安全的，就算程序里多个部分同时操作它，状态也能保持一致。
gocui 成熟吗？它从 2014 年就存在了，在 GitHub 上积累了超过 10000 颗星，是 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