@opentui/core 0.1.21 → 0.1.23

package/package.json

@@ -4,7 +4,7 @@
   "main": "index.js",
   "types": "index.d.ts",
   "type": "module",
-  "version": "0.1.21",
+  "version": "0.1.23",
   "description": "OpenTUI is a TypeScript library for building terminal user interfaces (TUIs)",
   "license": "MIT",
   "repository": {
@@ -38,11 +38,11 @@
     "bun-webgpu": "0.1.3",
     "planck": "^1.4.2",
     "three": "0.177.0",
-    "@opentui/core-darwin-x64": "0.1.21",
-    "@opentui/core-darwin-arm64": "0.1.21",
-    "@opentui/core-linux-x64": "0.1.21",
-    "@opentui/core-linux-arm64": "0.1.21",
-    "@opentui/core-win32-x64": "0.1.21",
-    "@opentui/core-win32-arm64": "0.1.21"
+    "@opentui/core-darwin-x64": "0.1.23",
+    "@opentui/core-darwin-arm64": "0.1.23",
+    "@opentui/core-linux-x64": "0.1.23",
+    "@opentui/core-linux-arm64": "0.1.23",
+    "@opentui/core-win32-x64": "0.1.23",
+    "@opentui/core-win32-arm64": "0.1.23"
   }
 }

package/renderables/Input.d.ts

@@ -20,7 +20,7 @@ export declare enum InputRenderableEvents {
     ENTER = "enter"
 }
 export declare class InputRenderable extends Renderable {
-    protected focusable: boolean;
+    protected _focusable: boolean;
     private _value;
     private _cursorPosition;
     private _placeholder;

package/renderables/ScrollBar.d.ts

@@ -17,7 +17,7 @@ export declare class ScrollBarRenderable extends Renderable {
     readonly startArrow: ArrowRenderable;
     readonly endArrow: ArrowRenderable;
     readonly orientation: "vertical" | "horizontal";
-    protected focusable: boolean;
+    protected _focusable: boolean;
     private _scrollSize;
     private _scrollPosition;
     private _viewportSize;

package/renderables/ScrollBox.d.ts

@@ -18,6 +18,8 @@ export interface ScrollBoxOptions extends BoxOptions<ScrollBoxRenderable> {
     scrollbarOptions?: Omit<ScrollBarOptions, "orientation">;
     verticalScrollbarOptions?: Omit<ScrollBarOptions, "orientation">;
     horizontalScrollbarOptions?: Omit<ScrollBarOptions, "orientation">;
+    stickyScroll?: boolean;
+    stickyStart?: "bottom" | "top" | "left" | "right";
 }
 export declare class ScrollBoxRenderable extends BoxRenderable {
     static idCounter: number;
@@ -27,7 +29,7 @@ export declare class ScrollBoxRenderable extends BoxRenderable {
     readonly content: ContentRenderable;
     readonly horizontalScrollBar: ScrollBarRenderable;
     readonly verticalScrollBar: ScrollBarRenderable;
-    protected focusable: boolean;
+    protected _focusable: boolean;
     private selectionListener?;
     private autoScrollMouseX;
     private autoScrollMouseY;
@@ -40,13 +42,26 @@ export declare class ScrollBoxRenderable extends BoxRenderable {
     private cachedAutoScrollSpeed;
     private autoScrollAccumulatorX;
     private autoScrollAccumulatorY;
+    private _stickyScroll;
+    private _stickyScrollTop;
+    private _stickyScrollBottom;
+    private _stickyScrollLeft;
+    private _stickyScrollRight;
+    private _stickyStart?;
+    private _hasManualScroll;
+    get stickyScroll(): boolean;
+    set stickyScroll(value: boolean);
+    get stickyStart(): "bottom" | "top" | "left" | "right" | undefined;
+    set stickyStart(value: "bottom" | "top" | "left" | "right" | undefined);
     get scrollTop(): number;
     set scrollTop(value: number);
     get scrollLeft(): number;
     set scrollLeft(value: number);
     get scrollWidth(): number;
     get scrollHeight(): number;
-    constructor(ctx: RenderContext, { wrapperOptions, viewportOptions, contentOptions, rootOptions, scrollbarOptions, verticalScrollbarOptions, horizontalScrollbarOptions, ...options }: ScrollBoxOptions);
+    private updateStickyState;
+    private applyStickyStart;
+    constructor(ctx: RenderContext, { wrapperOptions, viewportOptions, contentOptions, rootOptions, scrollbarOptions, verticalScrollbarOptions, horizontalScrollbarOptions, stickyScroll, stickyStart, ...options }: ScrollBoxOptions);
     protected onUpdate(deltaTime: number): void;
     scrollBy(delta: number | {
         x: number;

package/renderables/Select.d.ts

@@ -31,7 +31,7 @@ export declare enum SelectRenderableEvents {
     ITEM_SELECTED = "itemSelected"
 }
 export declare class SelectRenderable extends Renderable {
-    protected focusable: boolean;
+    protected _focusable: boolean;
     private _options;
     private selectedIndex;
     private scrollOffset;

package/renderables/TabSelect.d.ts

@@ -29,7 +29,7 @@ export declare enum TabSelectRenderableEvents {
     ITEM_SELECTED = "itemSelected"
 }
 export declare class TabSelectRenderable extends Renderable {
-    protected focusable: boolean;
+    protected _focusable: boolean;
     private _options;
     private selectedIndex;
     private scrollOffset;

package/renderer.d.ts

@@ -70,7 +70,7 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     private static animationFrameId;
     private lib;
     rendererPtr: Pointer;
-    private stdin;
+    stdin: NodeJS.ReadStream;
     private stdout;
     private exitOnCtrlC;
     private isDestroyed;
@@ -134,7 +134,10 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     private sigwinchHandler;
     private _capabilities;
     private _latestPointer;
+    private _currentFocusedRenderable;
     constructor(lib: RenderLib, rendererPtr: Pointer, stdin: NodeJS.ReadStream, stdout: NodeJS.WriteStream, width: number, height: number, config?: CliRendererConfig);
+    get currentFocusedRenderable(): Renderable | null;
+    focusRenderable(renderable: Renderable): void;
     addToHitGrid(x: number, y: number, width: number, height: number, id: number): void;
     get widthMethod(): WidthMethod;
     private writeOut;

package/testing/mock-keys.d.ts

@@ -0,0 +1,67 @@
+import type { CliRenderer } from "../renderer";
+export declare const KeyCodes: {
+    readonly ENTER: "\r";
+    readonly TAB: "\t";
+    readonly BACKSPACE: "\b";
+    readonly DELETE: "\u001B[3~";
+    readonly HOME: "\u001B[H";
+    readonly END: "\u001B[F";
+    readonly ESCAPE: "\u001B";
+    readonly ARROW_UP: "\u001B[A";
+    readonly ARROW_DOWN: "\u001B[B";
+    readonly ARROW_RIGHT: "\u001B[C";
+    readonly ARROW_LEFT: "\u001B[D";
+    readonly F1: "\u001BOP";
+    readonly F2: "\u001BOQ";
+    readonly F3: "\u001BOR";
+    readonly F4: "\u001BOS";
+    readonly F5: "\u001B[15~";
+    readonly F6: "\u001B[17~";
+    readonly F7: "\u001B[18~";
+    readonly F8: "\u001B[19~";
+    readonly F9: "\u001B[20~";
+    readonly F10: "\u001B[21~";
+    readonly F11: "\u001B[23~";
+    readonly F12: "\u001B[24~";
+    readonly CTRL_A: "\u0001";
+    readonly CTRL_B: "\u0002";
+    readonly CTRL_C: "\u0003";
+    readonly CTRL_D: "\u0004";
+    readonly CTRL_E: "\u0005";
+    readonly CTRL_F: "\u0006";
+    readonly CTRL_G: "\u0007";
+    readonly CTRL_H: "\b";
+    readonly CTRL_I: "\t";
+    readonly CTRL_J: "\n";
+    readonly CTRL_K: "\v";
+    readonly CTRL_L: "\f";
+    readonly CTRL_M: "\r";
+    readonly CTRL_N: "\u000E";
+    readonly CTRL_O: "\u000F";
+    readonly CTRL_P: "\u0010";
+    readonly CTRL_Q: "\u0011";
+    readonly CTRL_R: "\u0012";
+    readonly CTRL_S: "\u0013";
+    readonly CTRL_T: "\u0014";
+    readonly CTRL_U: "\u0015";
+    readonly CTRL_V: "\u0016";
+    readonly CTRL_W: "\u0017";
+    readonly CTRL_X: "\u0018";
+    readonly CTRL_Y: "\u0019";
+    readonly CTRL_Z: "\u001A";
+    readonly ALT_A: "\u001Ba";
+    readonly ALT_B: "\u001Bb";
+    readonly ALT_C: "\u001Bc";
+};
+export type KeyInput = string | keyof typeof KeyCodes;
+export declare function createMockKeys(renderer: CliRenderer): {
+    pressKeys: (keys: KeyInput[], delayMs?: number) => Promise<void>;
+    pressKey: (key: KeyInput) => void;
+    typeText: (text: string, delayMs?: number) => Promise<void>;
+    pressEnter: () => void;
+    pressEscape: () => void;
+    pressTab: () => void;
+    pressBackspace: () => void;
+    pressArrow: (direction: "up" | "down" | "left" | "right") => void;
+    pressCtrlC: () => void;
+};

package/testing/test-renderer.d.ts

@@ -0,0 +1,6 @@
+import { CliRenderer, type CliRendererConfig } from "../renderer";
+import { createMockKeys } from "./mock-keys";
+export declare function createTestRenderer(options: CliRendererConfig): Promise<{
+    renderer: CliRenderer;
+    mockInput: ReturnType<typeof createMockKeys>;
+}>;

package/types.d.ts

@@ -1,6 +1,7 @@
 import type { RGBA } from "./lib/RGBA";
 import type { EventEmitter } from "events";
 import type { Selection } from "./lib/selection";
+import type { Renderable } from "./Renderable";
 export declare const TextAttributes: {
     NONE: number;
     BOLD: number;
@@ -46,6 +47,8 @@ export interface RenderContext extends EventEmitter {
     hasSelection: boolean;
     getSelection: () => Selection | null;
     requestSelectionUpdate: () => void;
+    currentFocusedRenderable: Renderable | null;
+    focusRenderable: (renderable: Renderable) => void;
 }
 export type Timeout = ReturnType<typeof setTimeout> | undefined;
 export interface ViewportBounds {