试用示例
本页的示例是代码片段,而非完整的 mod。每个示例都是一个元素及其内部嵌套内容的代码。 要在您自己的终端中查看示例,请按以下步骤创建一个小型 mod,并将示例粘贴进去。该 mod 会添加一个/gallery 命令,用于打开一个窗格并在其中绘制示例。窗格在宽屏全屏终端中是会话记录旁边的侧边栏,在其他情况下则是输入框上方带边框的区域。
1
创建 mod
创建一个名为 在 将代码保存为
gallery 的目录,并在其中创建 .claude-plugin 和 hooks 目录。创建 mod 介绍了这些文件。将清单保存为 gallery/.claude-plugin/plugin.json:gallery/.claude-plugin/plugin.json
gallery/hooks/hooks.json 中指定入口文件:gallery/hooks/hooks.json
gallery/hooks/register.js。它会添加一个打开窗格的 /gallery 命令,并在该窗格中绘制 Plain text:gallery/hooks/register.js
2
运行 mod
在 shell 中,从包含 在 Claude Code 输入框中运行
gallery 的目录启动 Claude Code:/gallery。一个窗格随即打开,其中显示 Plain text。3
替换为示例
从本页复制一个示例。在
register.js 中,将其粘贴以替换 Text({ children: ['Plain text'] }),使其位于 return 之后,然后保存文件。每次保存时 Claude Code 都会重新加载该模块,因此再次运行 /gallery 即可查看新示例。选择元素
示例按您想在屏幕上显示的内容分组:- 显示文本:
Text、Markdown和Link - 显示代码和更改:
Code - 排列元素:
Box - 接收输入:
Button、Input和Select - 绘制图形:
Raster、Svg、Image和Client
显示文本
有三个元素可在屏幕上显示文字:Text 用于自定义样式,Markdown 用于已格式化的内容,Link 用于 URL。
Text
Text 使用您指定的样式绘制字符串。此示例显示纯文本和八种样式,每行一种:


dimColor 以灰色绘制文本。backgroundColor 的填充宽度仅与文本相同。
Markdown
Markdown 按照 Claude 回复的格式来格式化文本。请通过 text 而非 children 传入内容:


# 标记。行内代码以彩色绘制,不显示反引号。引用以斜体绘制,左侧带一条竖线。
Link
Link 绘制一个标签,后跟其 URL:


显示代码和更改
Code 使用 Claude Code 自己的语法配色绘制源代码文本或 diff。在 VS Code 扩展中,Code 将其 source 显示为纯文本,不带这些截图中的配色、行号或 diff 底纹。
Code
指定 language,或传入 path 让 Claude Code 据此推断语言。使用 startLine 时,行号从该数字开始:


以 diff 形式使用 Code
使用 format: 'diff' 时,source 是一个或多个 unified diff hunk:


@@ 行进行绘制。当删除的行与添加的行相似时,发生变化的词会以更深的底纹显示。
排列元素
Box
Box 将其内部内容按行或列排布,并可绘制边框。此示例在一个带边框的框上方放置了一行文字:


接收输入
Button、Input 和 Select 是控件:用户通过 Tab 键在它们之间移动,并操作获得焦点的那个控件。键盘焦点和快捷键介绍了哪些按键会传递给它们。
使用 focus: true 打开窗格可为该窗格请求键盘焦点。Input 获得焦点后即可接收键入的字母。要选择窗格打开时哪个输入框获得焦点,请参阅设置快捷键和初始焦点。
Button
按钮会运行 onPress。此示例展示了默认形式、带快捷键的 plain 按钮,以及一个暗淡的按钮:




Input
Input 是文本输入框,默认只容纳一行,用户按 Enter 时会运行 onSubmit:


⏎ 之后显示 submitLabel:




rows 设置为 2 或更大的值:
rows 需要 Claude Code v2.1.301 或更高版本。在更早的版本中,输入框只容纳一行。
即使输入框为空,它也会占据您设置的行数,最多不超过其所在窗格或区域的高度。输入框获得焦点时,更长的文本会在输入框内滚动。
- 在终端中,Enter 仍然用于提交。在终端中,用户可以先键入反斜杠再按 Enter 来换行,或者在终端模拟器支持的情况下按 Shift+Enter。这些按键与提示词输入框中的按键相同。
- 在终端中,上方向键和下方向键用于在输入框的各行之间移动。在第一行和最后一行时,它们会移动到前一个或后一个控件。
onSubmit和onInput接收完整文本,其各行以\n连接。
Select
Select 让用户从多个选项中选择一个,并以该选项的 value 运行 onSelect:






绘制图形
Raster
Raster 是由彩色字符单元格组成的网格,可用于热力图、迷你折线图或游戏棋盘。由终端负责绘制。此示例使用了起始模块中的 cellsOf 函数,该函数会将单元格打包成 Raster 所需的字符串。绘制彩色单元格网格对此进行了说明:


Raster 会将每种颜色近似到一个较小的调色板,因此 0x2e7d32 会绘制为 #337733。
Svg
Svg 在 Desktop 应用和 VS Code 扩展中绘制 SVG 文档:
Svg 的窗格打开后是空的。要在那里绘制其他内容,请检查 e.surface 并返回不同的元素树。
Image 和 Client
Image 和 Client 在此没有示例。Image 在终端中绘制 PNG 或原始像素。Client 是由您的另一个文件负责绘制的区域,用于动画和指针输入。元素参考列出了它们的 prop。
在以下终端中,Image 会绘制为图片:
- kitty 0.28 或更高版本
- Ghostty
- iTerm2 3.5 或更高版本。在 iTerm2 中绘制需要 Claude Code v2.1.305 或更高版本。
Image 的 alt 文本,而不是图片。请编写能够独立表达含义的 alt 文本,因为在以下情况(以及其他一些情况)下也会显示该文本:
- GNU screen:在任何终端中运行于 screen 内的会话。
- tmux:运行于 tmux 内、但未满足某项在 tmux 中绘制的要求的会话。
- 后台会话:每个后台会话,无论从哪个终端连接。
- iTerm2 未使用全屏渲染:在 iTerm2 中,图片仅在全屏渲染下绘制,并且在
CLAUDE_CODE_ALT_SCREEN_FULL_REPAINT设置为1时不会绘制。要看到图片,请在 Claude Code 输入框中运行/tui fullscreen,并保持该变量未设置。 - iTerm2 或 tmux 中的文件路径来源:在 iTerm2 中以及在 tmux 内,
source指定file的Image会显示alt文本而不是图片。如果您的 mod 有 iTerm2 或 tmux 用户,请在source.png或source.rgba中以 base64 形式传递图片,而不是在source.file中以路径形式传递。
CLAUDE_CODE_FORCE_TERMINAL_IMAGES 设置为 1。不应在以下情况下设置该变量:在 GNU screen 内、在低于 3.3 版本的 tmux 内、在 tmux 弹出窗口中,或在 tmux 的 allow-passthrough 关闭时。在这些情况下,用户看不到图片,并且 alt 文本的位置会显示一个方框。
在 tmux 中绘制 Image
如果 Image 在 tmux 中显示其 alt 文本,请检查以下要求,同时检查其他显示 alt 文本的情况,例如后台会话:
- Claude Code v2.1.310 或更高版本
- tmux 3.3 或更高版本
- Claude Code 运行在 tmux 窗格中,而不是 tmux 弹出窗口中
- tmux 运行在 kitty 0.28 或更高版本、Ghostty 或 iTerm2 3.5 或更高版本中
- tmux 选项
focus-events和allow-passthrough为on。在 kitty 或 Ghostty 中,allow-passthrough也可以为all。 - 在 iTerm2 中,tmux 不使用
-CC运行,全屏渲染已开启,并且CLAUDE_CODE_ALT_SCREEN_FULL_REPAINT未设置。 - 在 iTerm2 中,tmux 窗口不大于 iTerm2 窗口。要进行检查,请在该 tmux 窗口中运行
tmux display-message -p '#{window_bigger}'。如果输出1,请调整 tmux 窗口使其适配,然后重启 Claude Code。 - mod 的作者以
png或rgba字节形式传递图片,而不是以file路径形式传递。如果您使用的 mod 并非由您编写,且其他要求均已满足,请让其作者检查这一项。
~/.tmux.conf。
了解 mod 可以在哪里绘制
这些示例都在窗格中绘制。mod 还可以在其他位置绘制,并可调用 Claude Code 为其显示内容:- 窗格和横条:选择绘制位置
- Claude Code 自身的行,例如加载动画:更改 Claude Code 已绘制的内容
- Toast 通知、状态栏和日志行:在不开启轮次的情况下显示内容
- 问题对话框:暂停工具调用直到用户做出决定