跳转到主要内容

23 TUI 组件

介绍 pi 的 TUI 组件系统：组件接口、IME 支持、覆盖层、内置组件及键盘鼠标输入。

pi 可以帮你创建 TUI 组件。可以请它为你的使用场景构建一个。

扩展和自定义工具可以渲染自定义 TUI 组件，构建交互式用户界面。本页介绍组件系统以及可用的小组件。

源码： @earendil-works/pi-tui

组件接口

所有组件都要实现：

interface Component {
  render(width: number): string[];
  handleInput?(data: string): void;
  handleMouse?(event: TuiMouseEvent): TuiMouseEventResult | undefined;
  wantsKeyRelease?: boolean;
  invalidate(): void;
}
方法说明
render(width)返回字符串数组（每行一个）。每行不得超过 width。
handleInput?(data)在组件获得焦点时接收键盘输入。
handleMouse?(event)在全屏模式下接收归一化的指针输入。
wantsKeyRelease?若为 true，组件会接收按键释放事件（Kitty 协议）。默认：false。
invalidate()清除缓存的渲染状态。在主题变更时调用。

TUI 会在每一行渲染输出的末尾附加完整的 SGR 重置和 OSC 8 重置。样式不会跨行保留。如果你要输出带样式的多行文本，请逐行重新应用样式，或使用 wrapTextWithAnsi()，让折行后的每一行都保留样式。

Focusable 接口（IME 支持）

显示文本光标并需要 IME（输入法编辑器）支持的组件应当实现 Focusable 接口：

import { CURSOR_MARKER, type Component, type Focusable } from "@earendil-works/pi-tui";

class MyInput implements Component, Focusable {
  focused: boolean = false;  // Set by TUI when focus changes
  
  render(width: number): string[] {
    const marker = this.focused ? CURSOR_MARKER : "";
    // Emit marker right before the fake cursor
    return [`> ${beforeCursor}${marker}\x1b[7m${atCursor}\x1b[27m${afterCursor}`];
  }
}

当 Focusable 组件获得焦点时，TUI 会：

  1. 将组件的 focused 设置为 true
  2. 扫描渲染输出中的 CURSOR_MARKER（一个零宽 APC 转义序列）
  3. 将硬件终端光标定位到该位置
  4. 仅在启用了 showHardwareCursor 时才显示硬件光标

光标默认保持隐藏。这样既能继续渲染伪造的光标，又能为那些在光标隐藏时仍跟踪 IME 候选窗口的终端定位硬件光标。某些终端要求 IME 定位必须有可见的硬件光标；可以通过渲染器的 showHardwareCursor 构造参数或 setShowHardwareCursor(true) 来启用。pi 在创建渲染器之前还会把 PI_HARDWARE_CURSOR=1 映射到该设置。内置的 Editor 和 Input 组件已经实现了该接口。

内嵌输入组件的容器

当容器组件（对话框、选择器等）包含 Input 或 Editor 子组件时，容器必须实现 Focusable，并把焦点状态传递给子组件。否则，硬件光标将无法为 IME 输入正确定位。

import { Container, type Focusable, Input } from "@earendil-works/pi-tui";

class SearchDialog extends Container implements Focusable {
  private searchInput: Input;

  // Focusable implementation - propagate to child input for IME cursor positioning
  private _focused = false;
  get focused(): boolean {
    return this._focused;
  }
  set focused(value: boolean) {
    this._focused = value;
    this.searchInput.focused = value;
  }

  constructor() {
    super();
    this.searchInput = new Input();
    this.addChild(this.searchInput);
  }
}

如果没有这个传递，使用输入法（中文、日文、韩文等）输入时，候选窗口会显示在屏幕上错误的位置。

使用组件

在扩展中通过 ctx.ui.custom() 使用：

pi.on("session_start", async (_event, ctx) => {
  const result = await ctx.ui.custom<string | null>((tui, theme, keybindings, done) =>
    new MyComponent({
      theme,
      keybindings,
      onChange: () => tui.requestRender(),
      onSelect: (value) => done(value),
      onCancel: () => done(null),
    })
  );
});

在自定义工具中通过 ctx.ui.custom() 使用：

async execute(toolCallId, params, signal, onUpdate, ctx) {
  const result = await ctx.ui.custom<string | null>((tui, theme, keybindings, done) =>
    new MyComponent({
      theme,
      keybindings,
      onChange: () => tui.requestRender(),
      onSelect: (value) => done(value),
      onCancel: () => done(null),
    })
  );
  // Use result...
}

覆盖层

覆盖层（overlay）在现有内容之上渲染组件，而不会清空屏幕。向 ctx.ui.custom() 传入 { overlay: true }：

const result = await ctx.ui.custom<string | null>(
  (tui, theme, keybindings, done) => new MyDialog({ onClose: done }),
  { overlay: true }
);

要控制定位和尺寸，可使用 overlayOptions：

const result = await ctx.ui.custom<string | null>(
  (tui, theme, keybindings, done) => new SidePanel({ onClose: done }),
  {
    overlay: true,
    overlayOptions: {
      // Size: number or percentage string
      width: "50%",          // 50% of terminal width
      minWidth: 40,          // minimum 40 columns
      maxHeight: "80%",      // max 80% of terminal height

      // Position: anchor-based (default: "center")
      anchor: "right-center", // 9 positions: center, top-left, top-center, etc.
      offsetX: -2,            // offset from anchor
      offsetY: 0,

      // Or percentage/absolute positioning
      row: "25%",            // 25% from top
      col: 10,               // column 10

      // Margins
      margin: 2,             // all sides, or { top, right, bottom, left }

      // Responsive: hide on narrow terminals
      visible: (termWidth, termHeight) => termWidth >= 80,
    },
    // Get handle for programmatic focus and visibility control
    onHandle: (handle) => {
      // handle.focus() - focus this overlay and bring it to the visual front
      // handle.unfocus() - release input to normal fallback
      // handle.unfocus({ target }) - release input to a specific component or null
      // handle.setHidden(true/false) - toggle visibility
      // handle.hide() - permanently remove
    },
  }
);

覆盖层焦点

获得焦点的可见覆盖层会在临时的非覆盖层 UI 期间保持输入所有权。如果覆盖层打开另一个未带 { overlay: true } 的 ctx.ui.custom() 组件，那么在这个替换 UI 处于活动状态期间由它接收输入；当它关闭后，获得焦点的覆盖层可以收回输入。

当某个可见覆盖层应当停止持有输入、让 TUI 回退到另一个可见的捕获型覆盖层或之前的焦点目标时，使用 handle.unfocus()。当某个特定组件应当在覆盖层保持可见的同时接收输入时，使用 handle.unfocus({ target })。传入 { target: null } 会刻意让焦点悬空，直到再次设置焦点。

覆盖层生命周期

覆盖层组件在关闭时会被销毁。不要复用旧引用——请创建新的实例：

// Wrong - stale reference
let menu: MenuComponent;
await ctx.ui.custom((_, __, ___, done) => {
  menu = new MenuComponent(done);
  return menu;
}, { overlay: true });
setActiveComponent(menu);  // Disposed

// Correct - re-call to re-show
const showMenu = () => ctx.ui.custom((_, __, ___, done) => 
  new MenuComponent(done), { overlay: true });

await showMenu();  // First show
await showMenu();  // "Back" = just call again

涵盖锚点定位、边距、堆叠、响应式可见性和动画的完整示例，请参见 overlay-qa-tests.ts。

内置组件

从 @earendil-works/pi-tui 导入：

import { Text, Box, Container, Spacer, Markdown } from "@earendil-works/pi-tui";

Text

带自动换行的多行文本。

const text = new Text(
  "Hello World",    // content
  1,                // paddingX (default: 1)
  1,                // paddingY (default: 1)
  (s) => bgGray(s)  // optional background function
);
text.setText("Updated");

Box

带内边距和背景色的容器。

const box = new Box(
  1,                // paddingX
  1,                // paddingY
  (s) => bgGray(s)  // background function
);
box.addChild(new Text("Content", 0, 0));
box.setBgFn((s) => bgBlue(s));

Container

垂直排列子组件。

const container = new Container();
container.addChild(component1);
container.addChild(component2);
container.removeChild(component1);

Spacer

垂直空白区域。

const spacer = new Spacer(2);  // 2 empty lines

Markdown

渲染 markdown 并带语法高亮。

const md = new Markdown(
  "# Title\n\nSome **bold** text",
  1,        // paddingX
  1,        // paddingY
  theme     // MarkdownTheme (see below)
);
md.setText("Updated markdown");

Image

在支持的终端（Kitty、iTerm2、Ghostty、WezTerm、Warp）中渲染图片。

const image = new Image(
  base64Data,   // base64-encoded image
  "image/png",  // MIME type
  theme,        // ImageTheme
  { maxWidthCells: 80, maxHeightCells: 24 }
);

键盘输入

使用 matchesKey() 进行按键检测：

import { matchesKey, Key } from "@earendil-works/pi-tui";

handleInput(data: string) {
  if (matchesKey(data, Key.up)) {
    this.selectedIndex--;
  } else if (matchesKey(data, Key.enter)) {
    this.onSelect?.(this.selectedIndex);
  } else if (matchesKey(data, Key.escape)) {
    this.onCancel?.();
  } else if (matchesKey(data, Key.ctrl("c"))) {
    // Ctrl+C
  }
}

按键标识符（使用 Key.* 可获得自动补全，也可使用字符串字面量）：

  • 基本按键：Key.enter、Key.escape、Key.tab、Key.space、Key.backspace、Key.delete、Key.home、Key.end
  • 方向键：Key.up、Key.down、Key.left、Key.right
  • 带修饰键：Key.ctrl("c")、Key.shift("tab")、Key.alt("left")、Key.ctrlShift("p")
  • 字符串格式同样有效："enter"、"ctrl+c"、"shift+tab"、"ctrl+shift+p"

鼠标输入

全屏模式会把归一化的按下、释放、点击、移动、拖拽和滚轮事件路由给组件和覆盖层。返回 { handled: true } 可抑制默认行为，capture: true 可保留拖拽/释放所有权，focus: true 可请求键盘焦点，悬停或释放导致组件外观发生可见变化时返回 render: true。按下、点击、拖拽和滚轮事件默认会触发渲染；无实际作用的移动/释放事件则不会。

import { MouseRegion } from "@earendil-works/pi-tui";

const clickable = new MouseRegion(content, (event) => {
  if (event.type !== "click" || event.button !== "left") return undefined;
  expanded = !expanded;
  return { handled: true };
});

未处理的滚轮输入会滚动最近的 ScrollView；未处理的主键拖拽会保留会话记录的选区。OSC 8 链接的优先级高于父级点击区域。Input、Editor、SelectList 和 SettingsList 自带全屏鼠标行为。普通模式不会捕获鼠标输入，因为滚动回溯区由终端自己管理。

行宽

关键要求： render() 返回的每一行都不得超过 width 参数。

import { visibleWidth, truncateToWidth } from "@earendil-works/pi-tui";

render(width: number): string[] {
  // Truncate long lines
  return [truncateToWidth(this.text, width)];
}

工具函数：

  • visibleWidth(str) - 获取显示宽度（忽略 ANSI 码）
  • truncateToWidth(str, width, ellipsis?) - 截断文本，可选省略号
  • wrapTextWithAnsi(str, width) - 保留 ANSI 码的自动换行

创建自定义组件

示例：交互式选择器

import {
  matchesKey, Key,
  truncateToWidth, visibleWidth
} from "@earendil-works/pi-tui";

class MySelector {
  private items: string[];
  private selected = 0;
  private cachedWidth?: number;
  private cachedLines?: string[];
  
  public onSelect?: (item: string) => void;
  public onCancel?: () => void;

  constructor(items: string[]) {
    this.items = items;
  }

  handleInput(data: string): void {
    if (matchesKey(data, Key.up) && this.selected > 0) {
      this.selected--;
      this.invalidate();
    } else if (matchesKey(data, Key.down) && this.selected < this.items.length - 1) {
      this.selected++;
      this.invalidate();
    } else if (matchesKey(data, Key.enter)) {
      this.onSelect?.(this.items[this.selected]);
    } else if (matchesKey(data, Key.escape)) {
      this.onCancel?.();
    }
  }

  render(width: number): string[] {
    if (this.cachedLines && this.cachedWidth === width) {
      return this.cachedLines;
    }

    this.cachedLines = this.items.map((item, i) => {
      const prefix = i === this.selected ? "> " : "  ";
      return truncateToWidth(prefix + item, width);
    });
    this.cachedWidth = width;
    return this.cachedLines;
  }

  invalidate(): void {
    this.cachedWidth = undefined;
    this.cachedLines = undefined;
  }
}

在扩展中的用法：

pi.registerCommand("pick", {
  description: "Pick an item",
  handler: async (_args, ctx) => {
    const items = ["Option A", "Option B", "Option C"];
    const selected = await ctx.ui.custom<string | null>((tui, _theme, _keybindings, done) => {
      const selector = new MySelector(items);
      selector.onSelect = done;
      selector.onCancel = () => done(null);

      return {
        render: (width) => selector.render(width),
        handleInput: (data) => {
          selector.handleInput(data);
          tui.requestRender();
        },
        invalidate: () => selector.invalidate(),
      };
    });

    if (selected !== null) {
      ctx.ui.notify(`Selected: ${selected}`, "info");
    }
  }
});

主题化

组件接受主题对象来进行样式设置。

在 renderCall/renderResult 中，使用 theme 参数：

renderResult(result, options, theme, context) {
  // Use theme.fg() for foreground colors
  return new Text(theme.fg("success", "Done!"), 0, 0);
  
  // Use theme.bg() for background colors
  const styled = theme.bg("toolPendingBg", theme.fg("accent", "text"));
}

前景色（theme.fg(color, text)）：

类别颜色
常规text、accent、muted、dim、searchMatchText
状态success、error、warning
边框border、borderAccent、borderMuted
消息userMessageText、customMessageText、customMessageLabel
工具toolTitle、toolOutput
差异toolDiffAdded、toolDiffRemoved、toolDiffContext
MarkdownmdHeading、mdLink、mdLinkUrl、mdCode、mdCodeBlock、mdCodeBlockBorder、mdQuote、mdQuoteBorder、mdHr、mdListBullet
语法syntaxComment、syntaxKeyword、syntaxFunction、syntaxVariable、syntaxString、syntaxNumber、syntaxType、syntaxOperator、syntaxPunctuation
思考强度thinkingOff、thinkingMinimal、thinkingLow、thinkingMedium、thinkingHigh、thinkingXhigh、thinkingMax
模式bashMode

背景色（theme.bg(color, text)）：

selectedBg、searchMatchBg、userMessageBg、customMessageBg、toolPendingBg、toolSuccessBg、toolErrorBg

对 Markdown，使用 getMarkdownTheme()：

import { getMarkdownTheme } from "@earendil-works/pi-coding-agent";
import { Markdown } from "@earendil-works/pi-tui";

renderResult(result, options, theme, context) {
  const mdTheme = getMarkdownTheme();
  return new Markdown(result.details.markdown, 0, 0, mdTheme);
}

对自定义组件，定义你自己的主题接口：

interface MyTheme {
  selected: (s: string) => string;
  normal: (s: string) => string;
}

调试日志

设置 PI_TUI_WRITE_LOG 可以捕获写入 stdout 的原始 ANSI 流。

PI_TUI_WRITE_LOG=/tmp/tui-ansi.log npx tsx packages/tui/test/chat-simple.ts

性能

尽可能缓存渲染输出：

class CachedComponent {
  private cachedWidth?: number;
  private cachedLines?: string[];

  render(width: number): string[] {
    if (this.cachedLines && this.cachedWidth === width) {
      return this.cachedLines;
    }
    // ... compute lines ...
    this.cachedWidth = width;
    this.cachedLines = lines;
    return lines;
  }

  invalidate(): void {
    this.cachedWidth = undefined;
    this.cachedLines = undefined;
  }
}

状态变化时调用 invalidate()，然后使用注入的 tui.requestRender() 触发重新渲染。

失效与主题变更

主题变更时，TUI 会对所有组件调用 invalidate() 来清除其缓存。组件必须正确实现 invalidate()，主题变更才能生效。

问题所在

如果组件把主题颜色预先烘焙进字符串（通过 theme.fg()、theme.bg() 等）并缓存下来，那么缓存字符串中就包含旧主题的 ANSI 转义码。如果组件把带主题的内容单独存储，仅清除渲染缓存是不够的。

错误做法（主题颜色不会更新）：

class BadComponent extends Container {
  private content: Text;

  constructor(message: string, theme: Theme) {
    super();
    // Pre-baked theme colors stored in Text component
    this.content = new Text(theme.fg("accent", message), 1, 0);
    this.addChild(this.content);
  }
  // No invalidate override - parent's invalidate only clears
  // child render caches, not the pre-baked content
}

解决方案

用主题颜色构建内容的组件，必须在 invalidate() 被调用时重建该内容：

class GoodComponent extends Container {
  private message: string;
  private content: Text;

  constructor(message: string) {
    super();
    this.message = message;
    this.content = new Text("", 1, 0);
    this.addChild(this.content);
    this.updateDisplay();
  }

  private updateDisplay(): void {
    // Rebuild content with current theme
    this.content.setText(theme.fg("accent", this.message));
  }

  override invalidate(): void {
    super.invalidate();  // Clear child caches
    this.updateDisplay(); // Rebuild with new theme
  }
}

模式：失效时重建

对于内容复杂的组件：

class ComplexComponent extends Container {
  private data: SomeData;

  constructor(data: SomeData) {
    super();
    this.data = data;
    this.rebuild();
  }

  private rebuild(): void {
    this.clear();  // Remove all children

    // Build UI with current theme
    this.addChild(new Text(theme.fg("accent", theme.bold("Title")), 1, 0));
    this.addChild(new Spacer(1));

    for (const item of this.data.items) {
      const color = item.active ? "success" : "muted";
      this.addChild(new Text(theme.fg(color, item.label), 1, 0));
    }
  }

  override invalidate(): void {
    super.invalidate();
    this.rebuild();
  }
}

何时需要该模式

以下情况需要该模式：

  1. 预先烘焙主题颜色 - 使用 theme.fg() 或 theme.bg() 创建带样式的字符串，并存储在子组件中
  2. 语法高亮 - 使用 highlightCode()，它会应用基于主题的语法颜色
  3. 复杂布局 - 构建嵌入了主题颜色的子组件树

以下情况不需要该模式：

  1. 使用主题回调 - 传入在渲染期间调用的函数，如 (text) => theme.fg("accent", text)
  2. 简单容器 - 只是分组其他组件，不添加带主题的内容
  3. 无状态渲染 - 在每次 render() 调用中重新计算带主题的输出（无缓存）

常用模式

这些模式覆盖了扩展中最常见的 UI 需求。请直接复制这些模式，而不是从零开始构建。

模式 1：选择对话框（SelectList）

用于让用户从选项列表中挑选。使用 @earendil-works/pi-tui 的 SelectList，配合 DynamicBorder 做边框。

import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
import { DynamicBorder } from "@earendil-works/pi-coding-agent";
import { Container, type SelectItem, SelectList, Text } from "@earendil-works/pi-tui";

pi.registerCommand("pick", {
  handler: async (_args, ctx) => {
    const items: SelectItem[] = [
      { value: "opt1", label: "Option 1", description: "First option" },
      { value: "opt2", label: "Option 2", description: "Second option" },
      { value: "opt3", label: "Option 3" },  // description is optional
    ];

    const result = await ctx.ui.custom<string | null>((tui, theme, _kb, done) => {
      const container = new Container();

      // Top border
      container.addChild(new DynamicBorder((s: string) => theme.fg("accent", s)));

      // Title
      container.addChild(new Text(theme.fg("accent", theme.bold("Pick an Option")), 1, 0));

      // SelectList with theme
      const selectList = new SelectList(items, Math.min(items.length, 10), {
        selectedPrefix: (t) => theme.fg("accent", t),
        selectedText: (t) => theme.fg("accent", t),
        description: (t) => theme.fg("muted", t),
        scrollInfo: (t) => theme.fg("dim", t),
        noMatch: (t) => theme.fg("warning", t),
      });
      selectList.onSelect = (item) => done(item.value);
      selectList.onCancel = () => done(null);
      container.addChild(selectList);

      // Help text
      container.addChild(new Text(theme.fg("dim", "↑↓ navigate • enter select • esc cancel"), 1, 0));

      // Bottom border
      container.addChild(new DynamicBorder((s: string) => theme.fg("accent", s)));

      return {
        render: (w) => container.render(w),
        invalidate: () => container.invalidate(),
        handleInput: (data) => { selectList.handleInput(data); tui.requestRender(); },
      };
    });

    if (result) {
      ctx.ui.notify(`Selected: ${result}`, "info");
    }
  },
});

示例： preset.ts、tools.ts

模式 2：可取消的异步操作（BorderedLoader）

用于耗时且应可取消的操作。BorderedLoader 会显示一个 spinner，并处理 escape 取消。

import { BorderedLoader } from "@earendil-works/pi-coding-agent";

pi.registerCommand("fetch", {
  handler: async (_args, ctx) => {
    const result = await ctx.ui.custom<string | null>((tui, theme, _kb, done) => {
      const loader = new BorderedLoader(tui, theme, "Fetching data...");
      loader.onAbort = () => done(null);

      // Do async work
      fetchData(loader.signal)
        .then((data) => done(data))
        .catch(() => done(null));

      return loader;
    });

    if (result === null) {
      ctx.ui.notify("Cancelled", "info");
    } else {
      ctx.ui.setEditorText(result);
    }
  },
});

示例： qna.ts、handoff.ts

模式 3：设置与开关（SettingsList）

用于切换多项设置。使用 @earendil-works/pi-tui 的 SettingsList，配合 getSettingsListTheme()。

import { getSettingsListTheme } from "@earendil-works/pi-coding-agent";
import { Container, type SettingItem, SettingsList, Text } from "@earendil-works/pi-tui";

pi.registerCommand("settings", {
  handler: async (_args, ctx) => {
    const items: SettingItem[] = [
      { id: "verbose", label: "Verbose mode", currentValue: "off", values: ["on", "off"] },
      { id: "color", label: "Color output", currentValue: "on", values: ["on", "off"] },
    ];

    await ctx.ui.custom((_tui, theme, _kb, done) => {
      const container = new Container();
      container.addChild(new Text(theme.fg("accent", theme.bold("Settings")), 1, 1));

      const settingsList = new SettingsList(
        items,
        Math.min(items.length + 2, 15),
        getSettingsListTheme(),
        (id, newValue) => {
          // Handle value change
          ctx.ui.notify(`${id} = ${newValue}`, "info");
        },
        () => done(undefined),  // On close
        { enableSearch: true }, // Optional: enable fuzzy search by label
      );
      container.addChild(settingsList);

      return {
        render: (w) => container.render(w),
        invalidate: () => container.invalidate(),
        handleInput: (data) => settingsList.handleInput?.(data),
      };
    });
  },
});

示例： tools.ts

模式 4：持久状态指示器

在页脚显示跨渲染持久保留的状态。适合用作模式指示器。

// Set status (shown in footer)
ctx.ui.setStatus("my-ext", ctx.ui.theme.fg("accent", "● active"));

// Clear status
ctx.ui.setStatus("my-ext", undefined);

示例： status-line.ts、plan-mode/index.ts、preset.ts

模式 4b：自定义工作指示器

自定义 pi 流式输出响应期间显示的内联工作指示器。

// Static indicator
ctx.ui.setWorkingIndicator({ frames: [ctx.ui.theme.fg("accent", "●")] });

// Custom animated indicator
ctx.ui.setWorkingIndicator({
  frames: [
    ctx.ui.theme.fg("dim", "·"),
    ctx.ui.theme.fg("muted", "•"),
    ctx.ui.theme.fg("accent", "●"),
    ctx.ui.theme.fg("muted", "•"),
  ],
  intervalMs: 120,
});

// Hide the indicator entirely
ctx.ui.setWorkingIndicator({ frames: [] });

// Restore pi's default spinner
ctx.ui.setWorkingIndicator();

这只影响普通的流式工作指示器。上下文压缩和重试的加载动画保持其内置样式。自定义帧会原样渲染，因此扩展需要在需要时自行添加颜色。

示例： working-indicator.ts

模式 5：编辑器上方/下方的小组件

在输入编辑器上方或下方显示持久内容。适合待办列表、进度展示。

// Simple string array (above editor by default)
ctx.ui.setWidget("my-widget", ["Line 1", "Line 2"]);

// Render below the editor
ctx.ui.setWidget("my-widget", ["Line 1", "Line 2"], { placement: "belowEditor" });

// Or with theme
ctx.ui.setWidget("my-widget", (_tui, theme) => {
  const lines = items.map((item, i) =>
    item.done
      ? theme.fg("success", "✓ ") + theme.fg("muted", item.text)
      : theme.fg("dim", "○ ") + item.text
  );
  return {
    render: () => lines,
    invalidate: () => {},
  };
});

// Clear
ctx.ui.setWidget("my-widget", undefined);

示例： plan-mode/index.ts

替换页脚。footerData 暴露了扩展无法通过其他途径访问的数据。

ctx.ui.setFooter((tui, theme, footerData) => ({
  invalidate() {},
  render(width: number): string[] {
    // footerData.getGitBranch(): string | null
    // footerData.getExtensionStatuses(): ReadonlyMap<string, string>
    return [`${ctx.model?.id} (${footerData.getGitBranch() || "no git"})`];
  },
  dispose: footerData.onBranchChange(() => tui.requestRender()), // reactive
}));

ctx.ui.setFooter(undefined); // restore default

token 统计信息可通过 ctx.sessionManager.getBranch() 和 ctx.model 获取。

示例： custom-footer.ts

模式 7：自定义编辑器（vim 模式等）

用自定义实现替换主输入编辑器。适合模态编辑（vim）、不同的快捷键方案（emacs）或特殊的输入处理。

import { CustomEditor, type ExtensionAPI } from "@earendil-works/pi-coding-agent";
import { matchesKey, truncateToWidth } from "@earendil-works/pi-tui";

type Mode = "normal" | "insert";

class VimEditor extends CustomEditor {
  private mode: Mode = "insert";

  handleInput(data: string): void {
    // Escape: switch to normal mode, or pass through for app handling
    if (matchesKey(data, "escape")) {
      if (this.mode === "insert") {
        this.mode = "normal";
        return;
      }
      // In normal mode, escape aborts agent (handled by CustomEditor)
      super.handleInput(data);
      return;
    }

    // Insert mode: pass everything to CustomEditor
    if (this.mode === "insert") {
      super.handleInput(data);
      return;
    }

    // Normal mode: vim-style navigation
    switch (data) {
      case "i": this.mode = "insert"; return;
      case "h": super.handleInput("\x1b[D"); return; // Left
      case "j": super.handleInput("\x1b[B"); return; // Down
      case "k": super.handleInput("\x1b[A"); return; // Up
      case "l": super.handleInput("\x1b[C"); return; // Right
    }
    // Pass unhandled keys to super (ctrl+c, etc.), but filter printable chars
    if (data.length === 1 && data.charCodeAt(0) >= 32) return;
    super.handleInput(data);
  }

  render(width: number): string[] {
    const lines = super.render(width);
    // Add mode indicator to bottom border (use truncateToWidth for ANSI-safe truncation)
    if (lines.length > 0) {
      const label = this.mode === "normal" ? " NORMAL " : " INSERT ";
      const lastLine = lines[lines.length - 1]!;
      // Pass "" as ellipsis to avoid adding "..." when truncating
      lines[lines.length - 1] = truncateToWidth(lastLine, width - label.length, "") + label;
    }
    return lines;
  }
}

export default function (pi: ExtensionAPI) {
  pi.on("session_start", (_event, ctx) => {
    // Factory receives the TUI, theme, and keybindings from the app
    ctx.ui.setEditorComponent((tui, theme, keybindings) =>
      new VimEditor(tui, theme, keybindings)
    );
  });
}

要点：

  • 继承 CustomEditor（而不是基础 Editor），以获得应用快捷键（escape 中止、ctrl+d 退出、模型切换等）
  • 对你不处理的按键，调用 super.handleInput(data)
  • 状态 spinner：自定义编辑器默认保留独立的状态行。传入 { embedWorkingStatus: true } 作为 CustomEditor 构造函数的第四个参数，可将工作、上下文压缩、分支摘要和重试的 spinner 嵌入编辑器边框。
  • 工厂模式：setEditorComponent 接收一个工厂函数，其参数为 tui、theme 和 keybindings
  • 传入 undefined 可恢复默认编辑器：ctx.ui.setEditorComponent(undefined)

示例： modal-editor.ts

关键规则

  1. 始终使用回调传入的 theme - 不要直接导入主题。使用 ctx.ui.custom((tui, theme, keybindings, done) => ...) 回调中的 theme。

  2. 始终为 DynamicBorder 的颜色参数标注类型 - 写 (s: string) => theme.fg("accent", s)，而不是 (s) => theme.fg("accent", s)。

  3. 状态变化后调用 tui.requestRender() - 在 handleInput 中更新状态后调用 tui.requestRender()。

  4. 返回三方法对象 - 自定义组件需要 { render, invalidate, handleInput }。

  5. 使用现有组件 - SelectList、SettingsList、BorderedLoader 已覆盖 90% 的场景。不要重复造轮子。

示例

最后修改 2026-10-16