@opentui/core 0.0.0-20250908-4906ddad → 0.0.0-20250915-f5db043a

package/Renderable.d.ts

@@ -1,13 +1,12 @@
 import { EventEmitter } from "events";
 import { OptimizedBuffer } from "./buffer";
-import { type KeyHandler } from "./lib/KeyHandler";
 import { TrackedNode } from "./lib/TrackedNode";
 import type { ParsedKey } from "./lib/parse.keypress";
+import type { Selection } from "./lib/selection";
 import { type AlignString, type FlexDirectionString, type JustifyString, type OverflowString, type PositionTypeString, type WrapString } from "./lib/yoga.options";
-import type { MouseEvent } from "./renderer";
-import type { RenderContext, ViewportBounds } from "./types";
 import { type VNode } from "./renderables/composition/vnode";
-import type { Selection } from "./lib/selection";
+import type { MouseEvent } from "./renderer";
+import type { RenderContext } from "./types";
 declare const BrandedRenderable: unique symbol;
 export declare enum LayoutEvents {
     LAYOUT_CHANGED = "layout-changed",
@@ -25,7 +24,10 @@ export interface Position {
     bottom?: number | "auto" | `${number}%`;
     left?: number | "auto" | `${number}%`;
 }
-export interface LayoutOptions {
+export interface BaseRenderableOptions {
+    id?: string;
+}
+export interface LayoutOptions extends BaseRenderableOptions {
     flexGrow?: number;
     flexShrink?: number;
     flexDirection?: FlexDirectionString;
@@ -56,8 +58,7 @@ export interface LayoutOptions {
     paddingLeft?: number | `${number}%`;
     enableLayout?: boolean;
 }
-export interface RenderableOptions<T extends Renderable = Renderable> extends Partial<LayoutOptions> {
-    id?: string;
+export interface RenderableOptions<T extends BaseRenderable = BaseRenderable> extends Partial<LayoutOptions> {
     width?: number | "auto" | `${number}%`;
     height?: number | "auto" | `${number}%`;
     zIndex?: number;
@@ -89,12 +90,32 @@ export declare function isDimensionType(value: any): value is number | "auto" |
 export declare function isFlexBasisType(value: any): value is number | "auto" | undefined;
 export declare function isSizeType(value: any): value is number | `${number}%` | undefined;
 export declare function isRenderable(obj: any): obj is Renderable;
-export declare abstract class Renderable extends EventEmitter {
+export declare abstract class BaseRenderable extends EventEmitter {
     [BrandedRenderable]: boolean;
     private static renderableNumber;
-    static renderablesByNumber: Map<number, Renderable>;
     readonly id: string;
     readonly num: number;
+    protected _dirty: boolean;
+    parent: BaseRenderable | null;
+    protected _visible: boolean;
+    constructor(options: BaseRenderableOptions);
+    abstract add(obj: BaseRenderable | unknown, index?: number): number;
+    abstract remove(id: string): void;
+    abstract insertBefore(obj: BaseRenderable | unknown, anchor: BaseRenderable | unknown): void;
+    abstract getChildren(): BaseRenderable[];
+    abstract getChildrenCount(): number;
+    abstract getRenderable(id: string): BaseRenderable | undefined;
+    abstract requestRender(): void;
+    get isDirty(): boolean;
+    protected markClean(): void;
+    protected markDirty(): void;
+    destroy(): void;
+    destroyRecursively(): void;
+    get visible(): boolean;
+    set visible(value: boolean);
+}
+export declare abstract class Renderable extends BaseRenderable {
+    static renderablesByNumber: Map<number, Renderable>;
     private _isDestroyed;
     protected _ctx: RenderContext;
     protected _translateX: number;
@@ -106,14 +127,11 @@ export declare abstract class Renderable extends EventEmitter {
     protected _widthValue: number;
     protected _heightValue: number;
     private _zIndex;
-    protected _visible: boolean;
     selectable: boolean;
     protected buffered: boolean;
     protected frameBuffer: OptimizedBuffer | null;
-    private _dirty;
-    protected focusable: boolean;
+    protected _focusable: boolean;
     protected _focused: boolean;
-    protected keyHandler: KeyHandler;
     protected keypressHandler: ((key: ParsedKey) => void) | null;
     private _live;
     protected _liveCount: number;
@@ -131,11 +149,15 @@ export declare abstract class Renderable extends EventEmitter {
     parent: Renderable | null;
     private childrenPrimarySortDirty;
     private childrenSortedByPrimaryAxis;
+    private _newChildren;
+    onLifecyclePass: (() => void) | null;
     renderBefore?: (this: Renderable, buffer: OptimizedBuffer, deltaTime: number) => void;
     renderAfter?: (this: Renderable, buffer: OptimizedBuffer, deltaTime: number) => void;
     constructor(ctx: RenderContext, options: RenderableOptions<any>);
+    get focusable(): boolean;
     get ctx(): RenderContext;
     get visible(): boolean;
+    get primaryAxis(): "row" | "column";
     set visible(value: boolean);
     hasSelection(): boolean;
     onSelectionChanged(selection: Selection | null): boolean;
@@ -149,9 +171,7 @@ export declare abstract class Renderable extends EventEmitter {
     set live(value: boolean);
     protected propagateLiveCount(delta: number): void;
     handleKeyPress?(key: ParsedKey | string): boolean;
-    protected get isDirty(): boolean;
     findDescendantById(id: string): Renderable | undefined;
-    private markClean;
     requestRender(): void;
     get translateX(): number;
     set translateX(value: number);
@@ -177,8 +197,7 @@ export declare abstract class Renderable extends EventEmitter {
     set zIndex(value: number);
     private requestZIndexSort;
     private ensureZIndexSorted;
-    getChildrenInViewport(viewport: ViewportBounds, padding?: number, minTriggerSize?: number): Renderable[];
-    protected getChildrenSortedByPrimaryAxis(): Renderable[];
+    getChildrenSortedByPrimaryAxis(): Renderable[];
     private setupYogaProperties;
     private setupMarginAndPadding;
     set position(positionType: PositionTypeString);
@@ -215,13 +234,15 @@ export declare abstract class Renderable extends EventEmitter {
     protected createFrameBuffer(): void;
     protected onResize(width: number, height: number): void;
     private replaceParent;
-    add(obj: Renderable | VNode<any, any[]>, index?: number): number;
-    insertBefore(obj: Renderable | VNode<any, any[]>, anchor?: Renderable): number;
+    private _forceLayoutUpdateFor;
+    add(obj: Renderable | VNode<any, any[]> | unknown, index?: number): number;
+    insertBefore(obj: Renderable | VNode<any, any[]> | unknown, anchor?: Renderable | unknown): number;
     getRenderable(id: string): Renderable | undefined;
     remove(id: string): void;
     protected onRemove(): void;
     getChildren(): Renderable[];
     getChildrenCount(): number;
+    updateLayout(deltaTime: number, renderList?: RenderCommand[]): void;
     render(buffer: OptimizedBuffer, deltaTime: number): void;
     protected _getChildren(): Renderable[];
     protected onUpdate(deltaTime: number): void;
@@ -254,13 +275,32 @@ export declare abstract class Renderable extends EventEmitter {
     get onSizeChange(): (() => void) | undefined;
     private applyEventOptions;
 }
+interface RenderCommandBase {
+    action: "render" | "pushScissorRect" | "popScissorRect";
+}
+interface RenderCommandPushScissorRect extends RenderCommandBase {
+    action: "pushScissorRect";
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+interface RenderCommandPopScissorRect extends RenderCommandBase {
+    action: "popScissorRect";
+}
+interface RenderCommandRender extends RenderCommandBase {
+    action: "render";
+    renderable: Renderable;
+}
+export type RenderCommand = RenderCommandPushScissorRect | RenderCommandPopScissorRect | RenderCommandRender;
 export declare class RootRenderable extends Renderable {
     private yogaConfig;
+    private renderList;
     constructor(ctx: RenderContext);
+    render(buffer: OptimizedBuffer, deltaTime: number): void;
     protected propagateLiveCount(delta: number): void;
     calculateLayout(): void;
     resize(width: number, height: number): void;
-    protected onUpdate(): void;
     protected destroySelf(): void;
 }
 export {};

package/buffer.d.ts

@@ -13,7 +13,9 @@ export declare class OptimizedBuffer {
     private _height;
     respectAlpha: boolean;
     private _rawBuffers;
+    private _destroyed;
     get ptr(): Pointer;
+    private guard;
     get buffers(): {
         char: Uint32Array;
         fg: Float32Array;
@@ -28,11 +30,11 @@ export declare class OptimizedBuffer {
         respectAlpha?: boolean;
         id?: string;
     }): OptimizedBuffer;
-    private coordsToIndex;
     get width(): number;
     get height(): number;
     setRespectAlpha(respectAlpha: boolean): void;
     getNativeId(): string;
+    getRealCharBytes(addLineBreaks?: boolean): Uint8Array;
     clear(bg?: RGBA): void;
     setCell(x: number, y: number, char: string, fg: RGBA, bg: RGBA, attributes?: number): void;
     setCellWithAlphaBlending(x: number, y: number, char: string, fg: RGBA, bg: RGBA, attributes?: number): void;