@timmo001/groundwork-tui

中文文档
0.9.33发布于 2026/11/03Apache-2.0ES Module构建来源已验证

底层的终端组件:终端令牌上的OpenTUI可渲染

中文使用文档

@timmo001 / groundwork-tui

基础的终端组件: OpenTUI 可渲染的 和格式化器上的终端令牌,所以每个基础的TUI都有相同的 看和钥匙。

import { AppHeader, formatHelpBar, loadTheme } from "@timmo001/groundwork-tui";
  • loadTheme 读取 GW_THEME 和 GW_MODE. 没有 GW_THEME 这是 桌面的Omarchy主题哪里有一个,否则Base和dark。 themeFor 直接选择主题和模式,和 omarchyThemeFor 一个地图 Omarchy colors.toml.
  • AppHeader 和 PaneHeader 是单行标题。 HeaderBlock 是 应用程序的名称为ASCII艺术over formatHeaderBar有地位的面包屑 当终端狭窄时,点和细节就会下降。
  • formatBreadcrumb, formatFilterBar 和 formatHelpBar 构建标题 踪迹,过滤线和关键提示沿着底部。
  • MenuList 是一个可过滤的两行列表,包含组标题和 分页。 StatusList 是标记值的普通列表。
  • MenuGrid 列出了 Tile 卡在 SectionHeading 行,带箭头 键移动到最近的贴图。
  • ScrollSurface 是一个主题滚动框,和 surfaceBackground 它的颜色。
  • Button, Input, RadioGroup 和 Collapsible 可对焦吗? 控制:按回车键或空格键(或单击键),选择或切换。
  • Dialog 是一个中央面板,一次打开一个,由Escape或 单击以外。 ConfirmDialog 询问是或否(Cancel有焦点),以及 ChoiceDialog 从列表中选择。 Toast 是一条自动关闭的信息吗 对于结果,屏幕上没有其他东西可以显示。

templates/tui-menu 显示组件,并运行 mise run demo:tui.

版本与发布记录

@timmo001/groundwork-tui 共发布 41 个版本,首次发布于 2026/11/01;过去 12 个月发布了 41 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.9.33latest2026/11/03今天
0.9.322026/11/021 天前
0.9.312026/11/021 天前
0.9.302026/11/021 天前
0.9.292026/11/021 天前
0.9.282026/11/021 天前

关于 @timmo001/groundwork-tui 的常见问题

@timmo001/groundwork-tui 是什么?

底层的终端组件:终端令牌上的OpenTUI可渲染

如何安装 @timmo001/groundwork-tui?

在项目目录运行 npm install @timmo001/groundwork-tui,或使用 pnpm add / yarn add / bun add。

@timmo001/groundwork-tui 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/timmo001__groundwork-tui 是否存在。

@timmo001/groundwork-tui 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@timmo001/groundwork-tui 可以商用吗?

@timmo001/groundwork-tui 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@timmo001/groundwork-tui 还在维护吗?

最新版本 0.9.33 发布于 2026/11/03(今天);至今共发布 41 个版本,其中过去 12 个月发布了 41 个;首次发布于 2026/11/01。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。