edgevoid/vue-tui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(runtime): give screen-reader mode a dedicated write path (Ink parity, G59) (#62)

Browse Source 
Ink's onRender screen-reader branch (ink.tsx:573-625) writes the wrapped SR
transcript with a RAW stdout.write using manual ansiEscapes.eraseLines(prev) +
(inline static, if any) + the wrapped output, sets lastOutput/lastOutputToRender/
lastOutputHeight, and RETURNS before the normal interactive frame path. It emits
NO clearTerminal, does NOT accumulate/replay fullStaticOutput, does NOT go
through log-update, and does NOT hide the cursor.

vue-tui routed SR frames through renderInteractiveFrame, so a tall/overflowing
SR transcript (outputHeight >= viewportRows, then previousOutputHeight >
viewportRows) hit the clearTerminal branch — wiping the SR user's scrollback,
replaying accumulated fullStaticOutput, and the mount-time hide left the cursor
hidden.

This adds a dedicated `if (isScreenReaderEnabled) { ... return; }` branch in
commit(), before fullStaticOutput accumulation (now gated off for SR) and before
renderInteractiveFrame, mirroring Ink's SR branch byte-for-byte (eraseLines +
inline static + wrapped output, lastOutputToRender = wrapped output with no
trailing "\n", height = split count). It never clears the terminal, never
replays static, never uses the log-update writer, and the mount-time cursor-hide
is now skipped for SR mode. The normal (non-SR) interactive path is unchanged —
clearTerminal-on-tall-frame still applies there. G17/G46 SR behavior preserved.

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Yunfei He
2026-05-30 14:30:02 +08:00
committed by GitHub
parent c8cbacfbb8
commit 8140c663ce
3 changed files with 217 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/runtime/src/render.ts
+69 -2
View File
@@ -727,7 +727,18 @@ export function createApp(root: Component, rootProps?: RootProps | null): TuiApp
}
}
const hasStaticOutput = staticOutput !== "" && staticOutput !== "\n";
if (hasStaticOutput) {
// fullStaticOutput is the accumulated <Static> history. Mirror Ink's three
// onRender branches: it accumulates in the DEBUG branch (ink.tsx:550-553)
// and the normal-interactive branch (ink.tsx:626-628), but NOT in the
// dedicated interactive screen-reader branch (ink.tsx:573-625), which
// writes static inline + never clears + never replays history. So we must
// accumulate ALWAYS in debug (so the debug writeToStdout/writeToStderr
// replay of `fullStaticOutput + lastOutput` still includes static history,
// regardless of SR), and otherwise only when NOT in the interactive SR
// path. The SR exclusion is non-debug only: accumulating for interactive SR
// would also make a later non-SR remount on the same stream replay stale
// history (the original G59 motivation).
if (hasStaticOutput && (debug || !isScreenReaderEnabled)) {
frameState.fullStaticOutput += staticOutput;
}
@@ -772,6 +783,59 @@ export function createApp(root: Component, rootProps?: RootProps | null): TuiApp
return;
}
if (isScreenReaderEnabled) {
// Dedicated screen-reader write path (Ink parity G59), mirroring Ink's
// onRender SR branch (ink.tsx:573-625). It writes the transcript with a
// RAW stdout.write using manual ansiEscapes.eraseLines(previousHeight) +
// (inline static, if any) + the wrapped output, then RETURNS — before the
// normal interactive frame path. Crucially it:
// - NEVER calls shouldClearTerminalForFrame / emits clearTerminal, so a
// tall/overflowing SR transcript does not wipe the user's scrollback;
// - NEVER accumulates or replays fullStaticOutput (gated above);
// - NEVER routes through the log-update writer (raw writes only);
// - leaves the cursor visible (the mount-time hide is skipped for SR).
// `frame` is already the wrapped SR output (renderFrame -> wrapAnsi), so
// it plays the role of Ink's `wrappedOutput`.
const sync = synchronize;
if (sync) stdout.write(bsu);
if (hasStaticOutput) {
// Erase the previous main output before writing new static output
// (ink.tsx:579-588), then reset the tracked height to 0.
const erase =
frameState.outputHeight > 0 ? ansiEscapes.eraseLines(frameState.outputHeight) : "";
stdout.write(erase + staticOutput);
frameState.outputHeight = 0;
}
if (frame === frameState.lastOutput && !hasStaticOutput) {
// Unchanged frame and no new static: nothing to write (ink.tsx:590-596).
if (sync) stdout.write(esu);
if (onRender) onRender({ renderTime: performance.now() - start });
return;
}
if (hasStaticOutput) {
// Already erased above; write the wrapped output directly.
stdout.write(frame);
} else {
const erase =
frameState.outputHeight > 0 ? ansiEscapes.eraseLines(frameState.outputHeight) : "";
stdout.write(erase + frame);
}
// Match Ink: lastOutputToRender = wrappedOutput (NO appended "\n" in ANY
// case — empty frame => 0 lines, multi-line frame keeps its true count so
// the next-frame erase is eraseLines(N), not eraseLines(N+1)).
frameState.lastOutput = frame;
frameState.lastOutputToRender = frame;
frameState.outputHeight = frame === "" ? 0 : frame.split("\n").length;
if (sync) stdout.write(esu);
if (onRender) onRender({ renderTime: performance.now() - start });
return;
}
// Interactive path
renderInteractiveFrame(frame, outputHeight, hasStaticOutput ? staticOutput : "");
if (onRender) onRender({ renderTime: performance.now() - start });
@@ -839,7 +903,10 @@ export function createApp(root: Component, rootProps?: RootProps | null): TuiApp
// Hide cursor on mount (matching Ink). Only in interactive mode — in
// debug/test mode or non-interactive the stream may not be a real TTY.
if (!debug && interactive && !mountedAlternateScreen) {
// Screen-reader mode leaves the cursor VISIBLE (Ink parity G59): Ink's SR
// path never hides the cursor (the dedicated SR write branch above does no
// cursor management), so a screen-reader user keeps a real terminal cursor.
if (!debug && interactive && !mountedAlternateScreen && !isScreenReaderEnabled) {
stdout.write("\x1b[?25l");
}