feat(tui): add overlay compositing for ctx.ui.custom() (#558)

Adds overlay rendering capability to the TUI, enabling floating modal
components that render on top of existing content without clearing the screen.

- Add showOverlay(), hideOverlay(), hasOverlay() methods to TUI
- Implement ANSI-aware line compositing via extractSegments()
- Support overlay stack (multiple overlays, later on top)
- Add { overlay: true } option to ctx.ui.custom()
- Add overlay-test.ts example extension

Also fixes pre-existing bug where bash tool output cached visual lines
at fixed terminal width, causing crashes on terminal resize.

Co-authored-by: Nico Bailon <nico.bailon@gmail.com>
This commit is contained in:
Mario Zechner 2026-01-08 22:40:42 +01:00
parent 121823c74d
commit f9064c2f69
8 changed files with 488 additions and 48 deletions

View file

@ -0,0 +1,145 @@
/**
* Overlay Test - validates overlay compositing with inline text inputs
*
* Usage: pi --extension ./examples/extensions/overlay-test.ts
*
* Run /overlay-test to show a floating overlay with:
* - Inline text inputs within menu items
* - Edge case tests (wide chars, styled text, emoji)
*/
import type { ExtensionAPI, ExtensionCommandContext, Theme } from "@mariozechner/pi-coding-agent";
import { matchesKey, visibleWidth } from "@mariozechner/pi-tui";
export default function (pi: ExtensionAPI) {
pi.registerCommand("overlay-test", {
description: "Test overlay rendering with edge cases",
handler: async (_args: string, ctx: ExtensionCommandContext) => {
const result = await ctx.ui.custom<{ action: string; query?: string } | undefined>(
(_tui, theme, _keybindings, done) => new OverlayTestComponent(theme, done),
{ overlay: true },
);
if (result) {
const msg = result.query ? `${result.action}: "${result.query}"` : result.action;
ctx.ui.notify(msg, "info");
}
},
});
}
class OverlayTestComponent {
readonly width = 70;
private selected = 0;
private items = [
{ label: "Search", hasInput: true, text: "", cursor: 0 },
{ label: "Run", hasInput: true, text: "", cursor: 0 },
{ label: "Settings", hasInput: false, text: "", cursor: 0 },
{ label: "Cancel", hasInput: false, text: "", cursor: 0 },
];
constructor(
private theme: Theme,
private done: (result: { action: string; query?: string } | undefined) => void,
) {}
handleInput(data: string): void {
if (matchesKey(data, "escape")) {
this.done(undefined);
return;
}
const current = this.items[this.selected]!;
if (matchesKey(data, "return")) {
this.done({ action: current.label, query: current.hasInput ? current.text : undefined });
return;
}
if (matchesKey(data, "up")) {
this.selected = Math.max(0, this.selected - 1);
} else if (matchesKey(data, "down")) {
this.selected = Math.min(this.items.length - 1, this.selected + 1);
} else if (current.hasInput) {
if (matchesKey(data, "backspace")) {
if (current.cursor > 0) {
current.text = current.text.slice(0, current.cursor - 1) + current.text.slice(current.cursor);
current.cursor--;
}
} else if (matchesKey(data, "left")) {
current.cursor = Math.max(0, current.cursor - 1);
} else if (matchesKey(data, "right")) {
current.cursor = Math.min(current.text.length, current.cursor + 1);
} else if (data.length === 1 && data.charCodeAt(0) >= 32) {
current.text = current.text.slice(0, current.cursor) + data + current.text.slice(current.cursor);
current.cursor++;
}
}
}
render(_width: number): string[] {
const w = this.width;
const th = this.theme;
const innerW = w - 2;
const lines: string[] = [];
const pad = (s: string, len: number) => {
const vis = visibleWidth(s);
return s + " ".repeat(Math.max(0, len - vis));
};
const row = (content: string) => th.fg("border", "│") + pad(content, innerW) + th.fg("border", "│");
lines.push(th.fg("border", `${"─".repeat(innerW)}`));
lines.push(row(` ${th.fg("accent", "🧪 Overlay Test")}`));
lines.push(row(""));
// Edge cases - full width lines to test compositing at boundaries
lines.push(row(` ${th.fg("dim", "─── Edge Cases (borders should align) ───")}`));
lines.push(row(` Wide: ${th.fg("warning", "中文日本語한글テスト漢字繁體简体ひらがなカタカナ가나다라마바")}`));
lines.push(
row(
` Styled: ${th.fg("error", "RED")} ${th.fg("success", "GREEN")} ${th.fg("warning", "YELLOW")} ${th.fg("accent", "ACCENT")} ${th.fg("dim", "DIM")} ${th.fg("error", "more")} ${th.fg("success", "colors")}`,
),
);
lines.push(row(" Emoji: 👨‍👩‍👧‍👦 🇯🇵 🚀 💻 🎉 🔥 😀 🎯 🌟 💡 🎨 🔧 📦 🏆 🌈 🎪 🎭 🎬 🎮 🎲"));
lines.push(row(""));
// Menu with inline inputs
lines.push(row(` ${th.fg("dim", "─── Actions ───")}`));
for (let i = 0; i < this.items.length; i++) {
const item = this.items[i]!;
const isSelected = i === this.selected;
const prefix = isSelected ? " ▶ " : " ";
let content: string;
if (item.hasInput) {
const label = isSelected ? th.fg("accent", `${item.label}:`) : th.fg("text", `${item.label}:`);
let inputDisplay = item.text;
if (isSelected) {
const before = inputDisplay.slice(0, item.cursor);
const cursorChar = item.cursor < inputDisplay.length ? inputDisplay[item.cursor] : " ";
const after = inputDisplay.slice(item.cursor + 1);
inputDisplay = `${before}\x1b[7m${cursorChar}\x1b[27m${after}`;
}
content = `${prefix + label} ${inputDisplay}`;
} else {
content = prefix + (isSelected ? th.fg("accent", item.label) : th.fg("text", item.label));
}
lines.push(row(content));
}
lines.push(row(""));
lines.push(row(` ${th.fg("dim", "↑↓ navigate • type to input • Enter select • Esc cancel")}`));
lines.push(th.fg("border", `${"─".repeat(innerW)}`));
return lines;
}
invalidate(): void {}
dispose(): void {}
}