opentui
Build terminal UIs with OpenTUI. Covers the core API, native audio, keymaps, React and Solid bindings, components, layout, keyboard input, plugins, and testing.
- License 许可
- Apache-2.0
- 所属仓库
- zai-org/ZCode
- 最近更新
- 2026-11-13
- Stars
- ★ 8.7k
- Forks
- 2.7k
01 前言 Front Matter
- name
- opentui
- description
- Build terminal UIs with OpenTUI. Covers the core API, native audio, keymaps, React and Solid bindings, components, layout, keyboard input, plugins, and testing.
02 资源文件 45
- 脚本config.ts536 B
- 其他docs/bindings/react.mdx9.4 KB
- 其他docs/bindings/solid.mdx12.0 KB
- 其他docs/components/ascii-font.mdx3.7 KB
- 其他docs/components/box.mdx5.4 KB
- 其他docs/components/code.mdx8.9 KB
- 其他docs/components/diff.mdx4.2 KB
- 其他docs/components/frame-buffer.mdx6.7 KB
- 其他docs/components/input.mdx4.7 KB
- 其他docs/components/line-number.mdx4.0 KB
- 其他docs/components/markdown.mdx9.2 KB
- 其他docs/components/qr-code.mdx4.1 KB
- 其他docs/components/scrollbar.mdx2.3 KB
- 其他docs/components/scrollbox.mdx7.3 KB
- 其他docs/components/select.mdx6.1 KB
- 其他docs/components/slider.mdx1.9 KB
- 其他docs/components/tab-select.mdx6.0 KB
- 其他docs/components/text.mdx4.5 KB
- 其他docs/components/textarea.mdx7.7 KB
- 其他docs/core-concepts/audio.mdx6.3 KB
- 其他docs/core-concepts/colors.mdx7.8 KB
- 其他docs/core-concepts/console.mdx2.9 KB
- 其他docs/core-concepts/constructs.mdx5.8 KB
- 其他docs/core-concepts/keyboard.mdx10.4 KB
- 其他docs/core-concepts/layout.mdx4.0 KB
- 其他docs/core-concepts/lifecycle.mdx3.3 KB
- 其他docs/core-concepts/notifications.mdx1.3 KB
- 其他docs/core-concepts/renderables-vs-constructs.mdx4.5 KB
- 其他docs/core-concepts/renderables.mdx8.6 KB
- 其他docs/core-concepts/renderer.mdx26.0 KB
- 其他docs/getting-started.mdx2.2 KB
- 其他docs/keymap/addons.mdx15.1 KB
- 其他docs/keymap/core.mdx38.3 KB
- 其他docs/keymap/custom-addons.mdx26.7 KB
- 其他docs/keymap/hosts.mdx15.7 KB
- 其他docs/keymap/overview.mdx16.7 KB
- 其他docs/keymap/react.mdx4.9 KB
- 其他docs/keymap/solid.mdx5.1 KB
- 其他docs/plugins/core.mdx12.6 KB
- 其他docs/plugins/react.mdx6.5 KB
- 其他docs/plugins/slots.mdx12.7 KB
- 其他docs/plugins/solid.mdx7.0 KB
- 其他docs/reference/color-matrix.mdx3.8 KB
- 其他docs/reference/env-vars.mdx3.3 KB
- 其他docs/reference/tree-sitter.mdx4.6 KB
03 SKILL.md 正文
OpenTUI Skill
Canonical reference docs are authored once in sibling docs/**/*.mdx files.
Inside the OpenTUI repo, this skill root lives at packages/web/src/content/, so the same files are also visible at packages/web/src/content/docs/**/*.mdx.
Path invariant
/docs/<slug>maps todocs/<slug>.mdxrelative to this skill root- in the repo, that same slug maps to
packages/web/src/content/docs/<slug>.mdx
Reading order by area
- Getting started:
/docs/getting-started - Core:
/docs/core-concepts/renderer - Audio:
/docs/core-concepts/audio - Keymap:
/docs/keymap/overview - React:
/docs/bindings/react - Solid:
/docs/bindings/solid - Components:
/docs/components/text,/docs/components/input - Layout:
/docs/core-concepts/layout - Keyboard:
/docs/core-concepts/keyboard - Plugins:
/docs/plugins/slots - Reference:
/docs/reference/env-vars
Quick routing by intent
| Intent(s) | Start here |
|---|---|
getting-started, installation, quickstart, intro |
docs/getting-started.mdx |
core, renderer, terminal, scrollback, lifecycle |
docs/core-concepts/renderer.mdx |
audio, native-audio, sound, playback, pcm, fft |
docs/core-concepts/audio.mdx |
keymap, keybindings, shortcuts, commands, leader |
docs/keymap/overview.mdx |
layout, flexbox, yoga, positioning |
docs/core-concepts/layout.mdx |
keyboard, input, keybindings, paste, focus |
docs/core-concepts/keyboard.mdx |
react, jsx, hooks, animation, testing |
docs/bindings/react.mdx |
solid, signals, jsx, hooks, animation, testing |
docs/bindings/solid.mdx |
plugins, plugin, slots, registry, extensions |
docs/plugins/slots.mdx |
text, styling, content, selection |
docs/components/text.mdx |
input, form, editing, focus |
docs/components/input.mdx |
env, environment, configuration, flags |
docs/reference/env-vars.mdx |
For concrete component requests, jump straight to docs/components/<name>.mdx after the relevant entry page. For plugin implementation details, narrow from docs/plugins/slots.mdx into docs/plugins/core.mdx, docs/plugins/react.mdx, or docs/plugins/solid.mdx.
Current skill entry pages
docs/getting-started.mdxdocs/core-concepts/renderer.mdxdocs/core-concepts/audio.mdxdocs/keymap/overview.mdxdocs/core-concepts/layout.mdxdocs/core-concepts/keyboard.mdxdocs/bindings/react.mdxdocs/bindings/solid.mdxdocs/plugins/slots.mdxdocs/components/text.mdxdocs/components/input.mdxdocs/reference/env-vars.mdx
Working rules
- Prefer the current entry pages first, then read narrower docs in the same section.
- Read the sibling
docs/**/*.mdxfiles directly instead of copying prose into this file. - Use stable
/docs/...URLs when cross-referencing docs.
04 同仓库更多 Skills
plugin-mcp-ping
E2E workspace Plugin skill marker
e2e-ext-compat-plain
PLM-EXT-STORE fixture skill for e2e-ext-compat-plain.
e2e-ext-compat-ok
PLM-EXT-STORE fixture skill for e2e-ext-compat-ok.
e2e-ext-compat-installed
PLM-EXT-STORE fixture skill for e2e-ext-compat-installed.
e2e-ext-compat-future
PLM-EXT-STORE fixture skill for e2e-ext-compat-future.
e2e-store-skill-b
E2E store fixture skill b