Keel v0.5.1 English GitHub

Terminal

在线示例:这是真实的 Keel 程序编译成 WebAssembly,可以直接操作。首次加载约 10 MB。全屏打开
示例代码Go · 可复制

这是上方组件库展示案例的完整源码。examples/components/terminal.go

在脚手架项目中复用组件构造和 Render 写法;示例的 registerSection 与共享辅助函数由组件库提供。

package main

import (
	"fmt"
	"strings"
	"time"
	"unicode/utf8"

	"github.com/dyike/keel/ui/core"
	"github.com/dyike/keel/ui/el"
	"github.com/dyike/keel/ui/kit"
)

func init() {
	registerSection("terminal", "data", func() core.Widget {
		term := kit.Terminal().Name(demoText("Terminal session", "终端会话")).Height(380)
		prompt := "\x1b[32mkeel\x1b[0m:\x1b[34m~\x1b[0m$ "
		line := ""
		welcomed := false
		running := false
		generation := 0
		write := func(s string) { term.WriteString(s) }
		help := func() { write("help · colors · progress · echo <text> · clear\r\n") }
		var tick func(int, int)
		tick = func(token, done int) {
			time.AfterFunc(60*time.Millisecond, func() {
				core.UpdateIf(func() bool {
					if generation != token || !running {
						return false
					}
					next := done + 5
					write(fmt.Sprintf("\r\x1b[36m%s\x1b[2m%s\x1b[0m %d%%", strings.Repeat("█", next/5), strings.Repeat("░", 20-next/5), next))
					if next == 100 {
						running = false
						write("\r\n" + prompt)
					} else {
						tick(token, next)
					}
					return true
				})
			})
		}
		term.OnResize(func(cols, rows int) {
			if !welcomed {
				welcomed = true
				write("Keel terminal · pure Go\r\n")
				help()
				write(prompt)
			}
		}).OnData(func(data string) {
			if strings.ContainsRune(data, 3) {
				generation++
				running = false
				line = ""
				write("^C\r\n" + prompt)
				return
			}
			if running {
				return
			}
			if strings.HasPrefix(data, "\x1b") {
				return
			}
			for _, r := range data {
				switch r {
				case '\r':
					write("\r\n")
					command := strings.TrimSpace(line)
					line = ""
					name, rest, _ := strings.Cut(command, " ")
					switch name {
					case "help":
						help()
					case "clear":
						write("\x1b[3J\x1b[2J\x1b[H")
					case "echo":
						write(rest + "\r\n")
					case "colors":
						for i := 0; i < 16; i++ {
							write(fmt.Sprintf("\x1b[48;5;%dm  \x1b[0m", i))
						}
						write("\r\n")
						for i := 0; i < 32; i++ {
							write(fmt.Sprintf("\x1b[48;2;%d;96;%dm \x1b[0m", 255-i*8, i*8))
						}
						write("\r\n")
					case "progress":
						running = true
						generation++
						tick(generation, 0)
					case "":
					default:
						write("\x1b[31mUnknown command: " + name + "\x1b[0m\r\n")
					}
					if !running {
						write(prompt)
					}
				case 0x7f:
					if line != "" {
						_, n := utf8.DecodeLastRuneInString(line)
						line = line[:len(line)-n]
						write("\b \b")
					}
				default:
					if r >= ' ' {
						line += string(r)
						write(string(r))
					}
				}
			}
		})
		return el.Root(el.ViewFunc(func(cx *el.Context) el.Element {
			return el.Div().P(16).Gap(12).ScrollY().Child(el.Text(demoText("Type help. Ctrl+C cancels progress; Ctrl+Shift+C copies a selection.", "输入 help。Ctrl+C 取消进度;Ctrl+Shift+C 复制选区。")), term.Render(cx))
		}))
	})
}

Terminal() 是纯 Go ANSI 显示组件,输入/输出连接由应用拥有。它不会启动 shell、建立网络连接或执行 OSC 剪贴板指令。将 OnData(func(string)) 接到进程、PTY、WebSocket 或 SSH 通道,把收到的字节传给 Write;也提供 WriteString,均返回常规 writer 返回值。后台调用与其他 Keel 视图一样,需要放在 core.Update 或 core.UpdateIf 中。禁用输入时仍可接收输出,输出不会触发 OnData。

Name 设置文本框名称。Height 设置嵌套视口高度,默认 320dp;Fill 使用可用空间,el.Root 可填满窗口。Size 返回字符列/行数;OnResize 在真实可见布局的尺寸变化后通知,不在测量阶段通知,首次可见布局也会报告。最大 512 列、256 行。调整尺寸会保留并限制当前屏幕,但不重排旧文本。Scrollback 设置保留的历史行数,范围 0–10000,默认 1000。Reset 清空屏幕、历史、解析模式及选区,不发送输入。Text 返回纯文本屏幕/历史,包含屏幕空行。

ANSI 支持 16/256/RGB 颜色、粗体、暗色、斜体、下划线、反色和删除线;回车、换行、退格、制表、延迟折行;光标定位/保存/恢复;擦除屏幕/行/字符;插入/删除字符/行;滚动区域;备用屏幕 1049;光标可见性、应用光标及括号粘贴模式。UTF-8 和转义序列可分块写入。宽字符、组合字符和 ZWJ 使用字素感知字符格。历史及解析缓存均有上限。不支持的控制字符串被消费,不执行。尚不等同于完整 xterm/VT:鼠标报告、终端查询、替代字符集、冒号式 SGR、高级键盘协议及历史重排尚不支持。

输入不本地回显;应用自行写回回显。提交文本、回车、退格、Tab、Escape、Ctrl 字母组合、方向键、Home/End、Delete、PageUp/PageDown 和 F1–F12 转换为终端序列;应用光标模式改变方向键序列。Escape 后按 Tab 可离开焦点,普通 Tab 发送给会话。鼠标点击/触摸轻点聚焦终端。输入法组合文本在本地显示,组合结束后提交一次;事件测试不等于真实平台输入法验收。

鼠标拖动选择。Ctrl+Shift+C(或 Super+C)复制 Selection;Ctrl+C 始终发送字节 3。Ctrl+Shift+V(或 Super+V)读取剪贴板文本,启用括号粘贴模式时添加对应包裹序列。粘贴上限 1MiB。复制采用显示行边界并保留完整宽字素。无关输出保留选区;改写所选文本或淘汰选中历史时清除选区。滚轮/触摸可滚离底部,后续输出保留当前位置并补偿淘汰历史;新的键盘输入恢复跟随输出。SetDisabled 阻止交互并取消临时输入/粘贴,静默输出方法仍可用;遵循祖先禁用状态。

仅绘制可见行。ANSI 背景及字体样式使用已有 Gio/theme 字形渲染器,包括平台支持的彩色 emoji。使用静态光标,空闲终端不安排闪烁帧。无障碍通过已有 textbox 角色提供可见文本及禁用状态。字体覆盖、物理设备输入法、实际 PTY 应用和客户端内存/帧性能仍需单独验收。

组件示例是进程内命令演示(help、colors、progress、echo、clear),不是操作系统 shell。进度命令使用有限次数的定时更新,Ctrl+C 可取消。生产环境的传输、进程生命周期、背压及输出调度由应用负责。

验证:go test ./ui/kit ./ui/window -run TestTerminal;go run ./examples/components -section terminal。