@ny4n/tui 0.0.0-stage → 1.0.1

package/dist/tui-alt-screen.d.ts

@@ -0,0 +1,168 @@
+import type { Terminal } from "./terminal.ts";
+import { type Component, TuiBase, type TuiStopOptions, VIEWPORT_TUI, type ViewportTUI } from "./tui.ts";
+import { type WheelScrollLines } from "./wheel-scroll.ts";
+export interface TuiAltScreenOptions {
+    /**
+     * Logical lines moved for each mouse-wheel event (default: 1). `"auto"` accelerates fast wheel
+     * spins on terminals that send one event per notch. Alt+wheel moves five times as far.
+     */
+    wheelScrollLines?: WheelScrollLines;
+    /** Capture mouse events for viewport scrolling and application-owned text selection. */
+    mouse?: boolean;
+    /** Style a non-current transcript search match. */
+    searchMatchStyle?: (text: string) => string;
+    /** Style the current transcript search match. */
+    searchCurrentMatchStyle?: (text: string) => string;
+    /** Style a transcript search navigation button. */
+    searchNavigationButtonStyle?: (text: string, hovered: boolean) => string;
+    /**
+     * Render a clickable jump-to-end label. It is centered on the last row of a follow-end
+     * primary scroll view while that view is scrolled away from its end.
+     */
+    scrollToEndIndicator?: () => string;
+    /** Open an OSC 8 hyperlink activated with a primary-button click. */
+    openUrl?: (url: string) => void;
+    /** Handle an unmodified secondary-button press for clipboard paste. Currently enabled on Windows only. */
+    onRightClickPaste?: () => void;
+    /** Automatically copy selected text to the clipboard on mouse release (default: true). */
+    copyOnSelect?: boolean;
+    /**
+     * Copy selected text to the system clipboard. Return `true` on success, an error message to
+     * display on failure, or `false` for a generic error. When omitted, the selection is copied
+     * via an OSC 52 write.
+     */
+    copySelection?: (text: string) => Promise<boolean | string>;
+}
+/** Alternate-screen TUI with a scrollable, application-owned viewport. */
+export declare class TuiAltScreen extends TuiBase implements ViewportTUI {
+    readonly mode: "fullscreen";
+    readonly [VIEWPORT_TUI]: true;
+    private previousScreen;
+    private lastDocument;
+    private previousScreenWidth;
+    private previousScreenHeight;
+    private layoutRoot;
+    private currentLayout;
+    private readonly implicitDocument;
+    private readonly implicitScrollView;
+    private readonly flashes;
+    private altScreenActive;
+    private imageProtocol;
+    private savedCapabilities?;
+    private readonly uploadedKittyImages;
+    private selectionAnchor?;
+    private selectionFocus?;
+    private selectionGranularity;
+    private selectionInitialRange?;
+    private lastClick?;
+    private selectionDragPointer?;
+    private selectionAutoScrollDirection;
+    private selectionAutoScrollTimer?;
+    private selectionPressActive;
+    private scrollbarDrag?;
+    private scrollbarHover?;
+    private scrollToEndIndicatorRect?;
+    private activeSearch?;
+    private pressedUrl?;
+    private selectionDragged;
+    private mouseCapture?;
+    private mousePressTarget?;
+    private mousePressPoint?;
+    private mousePressMoved;
+    private lastComponentClick?;
+    private readonly wheelScroll;
+    private readonly mouseEnabled;
+    private readonly searchMatchStyle;
+    private readonly searchCurrentMatchStyle;
+    private readonly searchNavigationButtonStyle;
+    private readonly scrollToEndIndicator?;
+    private readonly openUrl?;
+    private readonly onRightClickPaste?;
+    private copyOnSelect;
+    private readonly copySelection?;
+    constructor(terminal: Terminal, showHardwareCursor?: boolean, logDirectory?: string, options?: TuiAltScreenOptions);
+    get viewportTop(): number;
+    get isFollowingOutput(): boolean;
+    setWheelScrollLines(lines: WheelScrollLines): void;
+    getCopyOnSelect(): boolean;
+    setCopyOnSelect(enabled: boolean): void;
+    /** Whether the fullscreen viewport has a non-empty active text selection. */
+    hasActiveSelection(): boolean;
+    /** Copy the active fullscreen text selection, if any, using the configured selection clipboard path. */
+    copyActiveSelectionToClipboard(): Promise<boolean>;
+    /** Drop the text selection and multi-click history, e.g. before the host replaces the transcript. */
+    resetTextSelection(): void;
+    /** The lines of the last rendered frame, one per terminal row, as written to the terminal. */
+    getScreenLines(): string[];
+    setLayoutRoot(component: Component | undefined): void;
+    render(width: number): string[];
+    protected getMountedRoots(): readonly Component[];
+    private getPrimaryScrollView;
+    protected beforeTerminalStart(): void;
+    protected beforeTerminalStop(_options: TuiStopOptions): void;
+    protected afterTerminalStop(options: TuiStopOptions): void;
+    private deleteKittyImages;
+    private prepareKittyScreen;
+    protected resetRenderState(): void;
+    scrollBy(lines: number): void;
+    scrollToTop(): void;
+    scrollToBottom(): void;
+    private scrollToPrompt;
+    private toggleSearch;
+    private closeSearch;
+    private updateSearchQuery;
+    private navigateSearch;
+    private getSearchNavigationDirectionAt;
+    private handleSearchMouseEvent;
+    private refreshSearch;
+    /** Show a transient message in the alternate-screen flash stack. */
+    flash(message: string, durationMs?: number): void;
+    private shouldDeferViewportInputToOverlay;
+    private clearComponentMouseGesture;
+    private handleViewportInput;
+    private decodeMouseButton;
+    private createMouseEvent;
+    private dispatchMouseToLayout;
+    private applyMouseDispatchResult;
+    private dispatchMouseToTarget;
+    private getComponentClickCount;
+    private clearTextSelection;
+    private handleMouseEvent;
+    private parseWheelEvent;
+    private routeWheel;
+    private parseSgrMouseEvent;
+    private handleRightClickPaste;
+    private handleScrollToEndIndicatorMouseEvent;
+    private getScrollbarTargetAt;
+    private setScrollbarHover;
+    private updateScrollbarHover;
+    private stopScrollbarHover;
+    private scrollScrollbarToPointer;
+    private handleScrollbarMouseEvent;
+    private stopScrollbarDrag;
+    private getScrollSelectionPoint;
+    private getSelectionPoint;
+    private getSelectionSourceLine;
+    private getWordSelection;
+    private getLineSelection;
+    private updateSelectionFocus;
+    private getClickCount;
+    private updateSelectionAutoScroll;
+    private autoScrollSelection;
+    private stopSelectionAutoScroll;
+    private handleSelectionMouseEvent;
+    private getSelectionBounds;
+    private getSelectionColumns;
+    private getActiveSelectionText;
+    private copySelectionToClipboard;
+    private copyTextToClipboard;
+    private applySearchTextHighlight;
+    private applySearchHighlights;
+    private applySelectionHighlight;
+    private applySelection;
+    private isMouseSequence;
+    private compositeScrollToEndIndicator;
+    private compositeFlashes;
+    protected doRender(): void;
+}
+//# sourceMappingURL=tui-alt-screen.d.ts.map

package/dist/tui-alt-screen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tui-alt-screen.d.ts","sourceRoot":"","sources":["../src/tui-alt-screen.ts"],"names":[],"mappings":"AAoBA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAa9C,OAAO,EACN,KAAK,SAAS,EAOd,OAAO,EAKP,KAAK,cAAc,EACnB,YAAY,EACZ,KAAK,WAAW,EAChB,MAAM,UAAU,CAAC;AAWlB,OAAO,EAA0B,KAAK,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AA2GlF,MAAM,WAAW,mBAAmB;IACnC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,wFAAwF;IACxF,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,mDAAmD;IACnD,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IAC5C,iDAAiD;IACjD,uBAAuB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACnD,mDAAmD;IACnD,2BAA2B,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,MAAM,CAAC;IACzE;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,MAAM,CAAC;IACpC,qEAAqE;IACrE,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAChC,0GAA0G;IAC1G,iBAAiB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC/B,0FAA0F;IAC1F,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;OAIG;IACH,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC;CAC5D;AAED,0EAA0E;AAC1E,qBAAa,YAAa,SAAQ,OAAQ,YAAW,WAAW;IAC/D,QAAQ,CAAC,IAAI,EAAG,YAAY,CAAU;IACtC,QAAQ,CAAC,CAAC,YAAY,CAAC,OAAiB;IACxC,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,mBAAmB,CAAK;IAChC,OAAO,CAAC,oBAAoB,CAAK;IACjC,OAAO,CAAC,UAAU,CAAwB;IAC1C,OAAO,CAAC,aAAa,CAA0B;IAC/C,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAY;IAC7C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAa;IAChD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAClD,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,aAAa,CAAuB;IAC5C,OAAO,CAAC,iBAAiB,CAAC,CAAuB;IACjD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAuC;IAC3E,OAAO,CAAC,eAAe,CAAC,CAAiB;IACzC,OAAO,CAAC,cAAc,CAAC,CAAiB;IACxC,OAAO,CAAC,oBAAoB,CAAqC;IACjE,OAAO,CAAC,qBAAqB,CAAC,CAAiB;IAC/C,OAAO,CAAC,SAAS,CAAC,CAAc;IAChC,OAAO,CAAC,oBAAoB,CAAC,CAA2B;IACxD,OAAO,CAAC,4BAA4B,CAAiB;IACrD,OAAO,CAAC,wBAAwB,CAAC,CAAiB;IAClD,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,aAAa,CAAC,CAAgB;IACtC,OAAO,CAAC,cAAc,CAAC,CAAa;IACpC,OAAO,CAAC,wBAAwB,CAAC,CAA2B;IAC5D,OAAO,CAAC,YAAY,CAAC,CAAe;IACpC,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,YAAY,CAAC,CAAyB;IAC9C,OAAO,CAAC,gBAAgB,CAAC,CAAyB;IAClD,OAAO,CAAC,eAAe,CAAC,CAA2B;IACnD,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,kBAAkB,CAAC,CAMzB;IACF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAyB;IACrD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAU;IACvC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA2B;IAC5D,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAA2B;IACnE,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAA6C;IACzF,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAe;IACrD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAwB;IACjD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAa;IAChD,OAAO,CAAC,YAAY,CAAU;IAC9B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAA8C;IAE7E,YACC,QAAQ,EAAE,QAAQ,EAClB,kBAAkB,CAAC,EAAE,OAAO,EAC5B,YAAY,CAAC,EAAE,MAAM,EACrB,OAAO,GAAE,mBAAwB,EAuBjC;IAED,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,IAAI,iBAAiB,IAAI,OAAO,CAE/B;IAED,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,GAAG,IAAI,CAEjD;IAED,eAAe,IAAI,OAAO,CAEzB;IAED,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAEtC;IAED,6EAA6E;IAC7E,kBAAkB,IAAI,OAAO,CAE5B;IAED,wGAAwG;IAClG,8BAA8B,IAAI,OAAO,CAAC,OAAO,CAAC,CAIvD;IAED,qGAAqG;IACrG,kBAAkB,IAAI,IAAI,CAGzB;IAED,8FAA8F;IAC9F,cAAc,IAAI,MAAM,EAAE,CAEzB;IAED,aAAa,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,GAAG,IAAI,CAKpD;IAEQ,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAEvC;IAED,UAAmB,eAAe,IAAI,SAAS,SAAS,EAAE,CAEzD;IAED,OAAO,CAAC,oBAAoB;IAI5B,UAAmB,mBAAmB,IAAI,IAAI,CAwC7C;IAED,UAAmB,kBAAkB,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI,CAapE;IAED,UAAmB,iBAAiB,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI,CAyBlE;IAED,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,kBAAkB;IAkD1B,UAAmB,gBAAgB,IAAI,IAAI,CAK1C;IAED,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAG5B;IAED,WAAW,IAAI,IAAI,CAGlB;IAED,cAAc,IAAI,IAAI,CAGrB;IAED,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,YAAY;IA2BpB,OAAO,CAAC,WAAW;IAQnB,OAAO,CAAC,iBAAiB;IAWzB,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,8BAA8B;IAUtC,OAAO,CAAC,sBAAsB;IAY9B,OAAO,CAAC,aAAa;IAqErB,oEAAoE;IACpE,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAEhD;IAED,OAAO,CAAC,iCAAiC;IAIzC,OAAO,CAAC,0BAA0B;IAOlC,OAAO,CAAC,mBAAmB;IAqH3B,OAAO,CAAC,iBAAiB;IAazB,OAAO,CAAC,gBAAgB;IAwBxB,OAAO,CAAC,qBAAqB;IAoB7B,OAAO,CAAC,wBAAwB;IAehC,OAAO,CAAC,qBAAqB;IAO7B,OAAO,CAAC,sBAAsB;IAe9B,OAAO,CAAC,kBAAkB;IAW1B,OAAO,CAAC,gBAAgB;IA+DxB,OAAO,CAAC,eAAe;IA6BvB,OAAO,CAAC,UAAU;IAclB,OAAO,CAAC,kBAAkB;IAW1B,OAAO,CAAC,qBAAqB;IAkB7B,OAAO,CAAC,oCAAoC;IAQ5C,OAAO,CAAC,oBAAoB;IAiB5B,OAAO,CAAC,iBAAiB;IAOzB,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,wBAAwB;IAYhC,OAAO,CAAC,yBAAyB;IA6CjC,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,uBAAuB;IAoB/B,OAAO,CAAC,iBAAiB;IAWzB,OAAO,CAAC,sBAAsB;IAQ9B,OAAO,CAAC,gBAAgB;IAqCxB,OAAO,CAAC,gBAAgB;IAOxB,OAAO,CAAC,oBAAoB;IAoB5B,OAAO,CAAC,aAAa;IA0BrB,OAAO,CAAC,yBAAyB;IA4BjC,OAAO,CAAC,mBAAmB;IAkB3B,OAAO,CAAC,uBAAuB;IAS/B,OAAO,CAAC,yBAAyB;IAgFjC,OAAO,CAAC,kBAAkB;IAiB1B,OAAO,CAAC,mBAAmB;IAqB3B,OAAO,CAAC,sBAAsB;YAwBhB,wBAAwB;YAMxB,mBAAmB;IAmBjC,OAAO,CAAC,wBAAwB;IAoBhC,OAAO,CAAC,qBAAqB;IA+D7B,OAAO,CAAC,uBAAuB;IAiB/B,OAAO,CAAC,cAAc;IAiDtB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,6BAA6B;IAwBrC,OAAO,CAAC,gBAAgB;IAcxB,UAAmB,QAAQ,IAAI,IAAI,CA0GlC;CACD"}