@simon_he/vue-tui 1.0.1 → 1.0.2

package/README.md

@@ -1,18 +1,47 @@
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="./docs/public/brand/vue-tui-logo-on-dark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="./docs/public/brand/vue-tui-logo-on-light.svg">
+    <img alt="Vue TUI" src="./docs/public/brand/vue-tui-logo-on-light.svg" width="360">
+  </picture>
+</p>
+
 # @simon_he/vue-tui
 
-Vue TUI is a Vue 3 terminal UI toolkit for building terminal-style interfaces that can render in a browser or in a real CLI. It gives you Vue components, terminal cell rendering, event dispatch, markdown rendering, and high-throughput primitives for lists, logs, and streaming transcripts.
+[![npm version](https://img.shields.io/npm/v/@simon_he/vue-tui?style=flat-square)](https://www.npmjs.com/package/@simon_he/vue-tui)
+[![npm downloads](https://img.shields.io/npm/dm/@simon_he/vue-tui?style=flat-square)](https://www.npmjs.com/package/@simon_he/vue-tui)
+[![CI](https://github.com/Simon-He95/vue-tui/actions/workflows/ci.yml/badge.svg)](https://github.com/Simon-He95/vue-tui/actions/workflows/ci.yml)
+[![Runtime compatibility](https://github.com/Simon-He95/vue-tui/actions/workflows/runtime-compat.yml/badge.svg)](https://github.com/Simon-He95/vue-tui/actions/workflows/runtime-compat.yml)
+[![Security](https://github.com/Simon-He95/vue-tui/actions/workflows/security.yml/badge.svg)](https://github.com/Simon-He95/vue-tui/actions/workflows/security.yml)
+![TypeScript types](https://img.shields.io/npm/types/@simon_he/vue-tui?style=flat-square)
+![Node version](https://img.shields.io/node/v/@simon_he/vue-tui?style=flat-square)
+[![MIT License](https://img.shields.io/github/license/Simon-He95/vue-tui?style=flat-square)](./license)
+
+[Docs](https://vue-tui.pages.dev/) | [npm](https://www.npmjs.com/package/@simon_he/vue-tui) | [GitHub](https://github.com/Simon-He95/vue-tui) | [Issues](https://github.com/Simon-He95/vue-tui/issues)
+
+Vue TUI is a Vue 3 terminal UI toolkit for building terminal-style interfaces that render to browser DOM, real CLI stdout, and headless tests.
+
+Use it to build browser terminal dashboards, Vue-powered CLI apps, streaming markdown transcripts, log viewers, virtual lists, and AI agent consoles with one shared component model.
+
+## Why Vue TUI?
+
+- **Vue component model for terminal UIs**: build with `TerminalProvider`, `TBox`, `TInput`, `TList`, `TTable`, and more.
+- **Browser + CLI renderers**: render the same UI model to browser DOM or real stdout.
+- **High-throughput surfaces**: virtual lists, append-only logs, streaming markdown, and agent transcripts.
+- **Clear host boundaries**: browser-safe root entrypoint, CLI-only APIs under `/cli`, sanitized links, and explicit host permissions.
+
+## Agent UI Showcase
+
+A real agent console built on `@simon_he/vue-tui` can stream agent output, markdown content, tool-call status, and input chrome in one terminal surface.
 
-Use it when you want:
+[![Agent console rendering built with vue-tui](./docs/public/agent-console-rendering-poster.png)](./docs/public/agent-console-rendering.mp4)
 
-- Browser-hosted terminal interfaces, dashboards, demos, and playgrounds.
-- CLI apps that use Vue component composition instead of imperative stdout drawing.
-- Shared UI code that can run against a DOM renderer, a stdout renderer, or headless tests.
-- Large terminal surfaces such as virtual lists, append-only logs, markdown transcripts, and agent console UIs.
+[Watch the rendering demo](./docs/public/agent-console-rendering.mp4)
 
 ## Install
 
 ```bash
-pnpm add @simon_he/vue-tui@rc vue
+pnpm add @simon_he/vue-tui vue
 ```
 
 Vue is a peer dependency. The current package supports Vue `>=3.3.0 <4`.
@@ -217,19 +246,25 @@ This table is a category overview. The generated API reference for root, `/vue`,
 
 ## Documentation
 
-| Page                                                             | Purpose                                                              |
-| ---------------------------------------------------------------- | -------------------------------------------------------------------- |
-| [Docs home](./docs/index.md)                                     | Product overview and reading path                                    |
-| [Examples index](./docs/examples.md)                             | Browser, terminal, and smoke example commands                        |
-| [Core API](./docs/api.md)                                        | Terminal, renderer, events, runtime, planes, and scheduler contracts |
-| [Performance](./docs/performance.md)                             | Practical performance guidance                                       |
-| [Benchmarks](./docs/benchmarks.md)                               | Release benchmark budgets, sample results, and comparison boundaries |
-| [OpenTUI Solid comparison](./docs/compare-opentui-solid.md)      | Same-scenario comparison protocol and public claim boundaries        |
-| [High-throughput rendering](./docs/high-throughput-rendering.md) | Scheduler, dirty rows, mailbox, log, and renderer architecture       |
-| [Component acceptance](./docs/components-acceptance.md)          | Release readiness checks for component API and behavior              |
-| [Agent Console](./docs/agent-console.md)                         | Streaming transcript example stack                                   |
-| [Release candidate](./docs/release-candidate.md)                 | 1.0 RC validation, package export checks, and migration notes        |
-| [Security policy](./SECURITY.md)                                 | Vulnerability reporting and terminal permission boundaries           |
+| Page                                                               | Purpose                                                              |
+| ------------------------------------------------------------------ | -------------------------------------------------------------------- |
+| [Docs home](./docs/index.md)                                       | Product overview and reading path                                    |
+| [Vue Terminal UI](./docs/guide/vue-terminal-ui.md)                 | English landing page for terminal-style Vue interfaces               |
+| [Vue CLI UI](./docs/guide/vue-cli-ui.md)                           | CLI app model with Vue component composition                         |
+| [CLI stdout renderer](./docs/guide/cli-stdout-renderer.md)         | Stdout renderer, stdin driver, cleanup, and terminal output          |
+| [Terminal log viewer](./docs/guide/terminal-log-viewer.md)         | Append-only logs, retained windows, wrapping, links, and search      |
+| [Markdown transcripts](./docs/guide/markdown-transcript.md)        | Static and streaming markdown transcript rendering                   |
+| [Examples index](./docs/examples.md)                               | Browser, terminal, and smoke example commands                        |
+| [Core API](./docs/api.md)                                          | Terminal, renderer, events, runtime, planes, and scheduler contracts |
+| [Terminal UI best practices](./docs/terminal-ui-best-practices.md) | Cell layout, input focus, render invalidation, transcripts, tests    |
+| [Performance](./docs/performance.md)                               | Practical performance guidance                                       |
+| [Benchmarks](./docs/benchmarks.md)                                 | Release benchmark budgets, sample results, and comparison boundaries |
+| [OpenTUI Solid comparison](./docs/compare-opentui-solid.md)        | Same-scenario comparison protocol and public claim boundaries        |
+| [High-throughput rendering](./docs/high-throughput-rendering.md)   | Scheduler, dirty rows, mailbox, log, and renderer architecture       |
+| [Component acceptance](./docs/components-acceptance.md)            | Release readiness checks for component API and behavior              |
+| [Agent Console](./docs/agent-console.md)                           | Streaming transcript example stack                                   |
+| [Release candidate](./docs/release-candidate.md)                   | 1.0 RC validation, package export checks, and migration notes        |
+| [Security policy](./SECURITY.md)                                   | Vulnerability reporting and terminal permission boundaries           |
 
 Run the docs locally:
 

package/dist/{TSelect-HzILuti9.js → TSelect-DR0FomSu.js}

@@ -1,4 +1,4 @@
-import { getPlaneTerminal } from "./create-terminal-C2oiWFJU.js";
+import { getPlaneTerminal } from "./create-terminal-DBFNYr8f.js";
 import { charCellWidth, hasEncodedControl } from "./hyperlink-Bn02UXJb.js";
 import { DialogContextKey, EventZIndexContextKey, ImeAnchorContextKey, LayoutContextKey, RenderPlaneContextKey, RenderStackKey, TInputPluginsContextKey, TerminalContextKey, forEachTextCellSegment, graphemeRangeAt, hasTextWidthAsciiFastPath, intersectRect, padEndByCells$1 as padEndByCells, repeatChar, sanitizeInlineText, sanitizeTextBlock, sliceByCells, sliceByCellsRange, spaces, textCellWidth$1 as textCellWidth, translateRect, useLayout, useRenderNode, useRenderStack, useTerminal, useTerminalNode, useVisibility, withTextWidthProvider, wrapByCells } from "./wheel-scroll-vBRaQ7p-.js";
 import { TView } from "./linkify-D_gzn9Xq.js";

package/dist/{TTree-ChOot2Bh.js → TTree-kzhlB5P0.js}

@@ -1,13 +1,13 @@
-import { TERMINAL_RENDER_PLANES, createTerminal, getPlaneTerminal, resetPlaneRowsForRender, scrollPlaneRows } from "./create-terminal-C2oiWFJU.js";
+import { TERMINAL_RENDER_PLANES, createTerminal, getPlaneTerminal, resetPlaneRowsForRender, scrollPlaneRows } from "./create-terminal-DBFNYr8f.js";
 import { sanitizeDomHref } from "./hyperlink-Bn02UXJb.js";
-import { DOM_RENDERER_CAPABILITIES, createDomRenderer } from "./dom-renderer-BqGijQID.js";
+import { DOM_RENDERER_CAPABILITIES, createDomRenderer } from "./dom-renderer-BniJSQyX.js";
 import { EventZIndexContextKey, ImeAnchorContextKey, LayoutContextKey, RenderStackKey, TInputPluginsContextKey, TPathPickerProviderContextKey, TerminalContextKey, VisibilityContextKey, applyWheelScroll, clearTextCaches, createWheelScrollState, forEachTextCellSegment, formatInlineCellLine, injectionKey, intersectRect, normalizeCellRect, padEndByCells$1 as padEndByCells, resetWheelScrollState, sanitizeInlineText, sanitizeTextBlock, sliceByCells, sliceByCellsRange, spaces, textCellWidth$1 as textCellWidth, translateRect, useLayout, useRenderNode, useTerminal, useTerminalNode, useVisibility, withTextRenderPass } from "./wheel-scroll-vBRaQ7p-.js";
 import { TView, TuiThemeContextKey, createFrameMailbox, createTheme, defaultActiveStyle, defaultDimStyle, linkifyTextSegments, tuiDefaultTheme } from "./linkify-D_gzn9Xq.js";
 import { SUPPRESS_TERMINAL_POINTER_DOWN, SUPPRESS_TERMINAL_POINTER_MOVE, SUPPRESS_TERMINAL_POINTER_UP, createEventManager, createRuntime } from "./runtime-rfcZCyJq.js";
 import { createFramePerfStore, createTraceStore } from "./trace-CjzYeIxN.js";
 import { envFlag, envString, firstNonEmptyEnv } from "./env-Cl8qmNFN.js";
 import { createTerminalSelectionController } from "./terminal-selection-DBinO6p5.js";
-import { TBox, TInput, TRenderPlane, TText, clamp, fitCellText, mergeStyle, repeatToCells, resolveOverlayPlacement } from "./TSelect-HzILuti9.js";
+import { TBox, TInput, TRenderPlane, TText, clamp, fitCellText, mergeStyle, repeatToCells, resolveOverlayPlacement } from "./TSelect-DR0FomSu.js";
 import { framePerfNow, mergeFramePerfReason } from "./frame-perf-C6Xfg85O.js";
 import { computed, defineComponent, effectScope, getCurrentInstance, h, inject, nextTick, onBeforeUnmount, onMounted, onScopeDispose, onUnmounted, provide, ref, shallowReactive, shallowRef, toRef, watch, watchEffect } from "vue";
 

package/dist/agent.js

@@ -1,10 +1,10 @@
-import "./create-terminal-C2oiWFJU.js";
+import "./create-terminal-DBFNYr8f.js";
 import "./hyperlink-Bn02UXJb.js";
 import "./sgr-BmzxEjAO.js";
 import { forEachTextCellSegment, sanitizeInlineText, sanitizeTextBlock, sliceByCells, spaces, textCellWidth$1 as textCellWidth, useTerminal, withTextWidthProvider } from "./wheel-scroll-vBRaQ7p-.js";
 import { TView } from "./linkify-D_gzn9Xq.js";
 import "./terminal-selection-DBinO6p5.js";
-import { TBox, TCommandPalette, TDialog, TInput, TRenderPlane, TSelect, TText, computeCommandPaletteMatchRanges } from "./TSelect-HzILuti9.js";
+import { TBox, TCommandPalette, TDialog, TInput, TRenderPlane, TSelect, TText, computeCommandPaletteMatchRanges } from "./TSelect-DR0FomSu.js";
 import "./frame-perf-C6Xfg85O.js";
 import "./path-mnSgEpCm.js";
 import { TVirtualMarkdown, createMarkdownBlockSource } from "./block-source-CKUOnkgT.js";