@opentui/core 0.1.13 → 0.1.15

package/Renderable.d.ts

@@ -3,10 +3,12 @@ import { OptimizedBuffer } from "./buffer";
 import { type KeyHandler } from "./lib/KeyHandler";
 import { TrackedNode } from "./lib/TrackedNode";
 import type { ParsedKey } from "./lib/parse.keypress";
-import { type AlignString, type FlexDirectionString, type JustifyString, type PositionTypeString } from "./lib/yoga.options";
+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, SelectionState } from "./types";
+import type { RenderContext, ViewportBounds } from "./types";
 import { type VNode } from "./renderables/composition/vnode";
+import type { Selection } from "./lib/selection";
+declare const BrandedRenderable: unique symbol;
 export declare enum LayoutEvents {
     LAYOUT_CHANGED = "layout-changed",
     ADDED = "added",
@@ -27,18 +29,21 @@ export interface LayoutOptions {
     flexGrow?: number;
     flexShrink?: number;
     flexDirection?: FlexDirectionString;
+    flexWrap?: WrapString;
     alignItems?: AlignString;
     justifyContent?: JustifyString;
+    alignSelf?: AlignString;
     flexBasis?: number | "auto" | undefined;
     position?: PositionTypeString;
+    overflow?: OverflowString;
     top?: number | "auto" | `${number}%`;
     right?: number | "auto" | `${number}%`;
     bottom?: number | "auto" | `${number}%`;
     left?: number | "auto" | `${number}%`;
-    minWidth?: number;
-    minHeight?: number;
-    maxWidth?: number;
-    maxHeight?: number;
+    minWidth?: number | "auto" | `${number}%`;
+    minHeight?: number | "auto" | `${number}%`;
+    maxWidth?: number | "auto" | `${number}%`;
+    maxHeight?: number | "auto" | `${number}%`;
     margin?: number | "auto" | `${number}%`;
     marginTop?: number | "auto" | `${number}%`;
     marginRight?: number | "auto" | `${number}%`;
@@ -72,23 +77,29 @@ export interface RenderableOptions<T extends Renderable = Renderable> extends Pa
     onMouseOut?: (this: T, event: MouseEvent) => void;
     onMouseScroll?: (this: T, event: MouseEvent) => void;
     onKeyDown?: (key: ParsedKey) => void;
+    onSizeChange?: (this: T) => void;
 }
 export declare function isValidPercentage(value: any): value is `${number}%`;
 export declare function isMarginType(value: any): value is number | "auto" | `${number}%`;
 export declare function isPaddingType(value: any): value is number | `${number}%`;
 export declare function isPositionType(value: any): value is number | "auto" | `${number}%`;
-export declare function isPostionTypeType(value: any): value is PositionTypeString;
+export declare function isPositionTypeType(value: any): value is PositionTypeString;
+export declare function isOverflowType(value: any): value is OverflowString;
 export declare function isDimensionType(value: any): value is number | "auto" | `${number}%`;
 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 {
+    [BrandedRenderable]: boolean;
     private static renderableNumber;
     static renderablesByNumber: Map<number, Renderable>;
     readonly id: string;
     readonly num: number;
     protected _ctx: RenderContext;
-    private _x;
-    private _y;
+    protected _translateX: number;
+    protected _translateY: number;
+    protected _x: number;
+    protected _y: number;
     protected _width: number | "auto" | `${number}%`;
     protected _height: number | "auto" | `${number}%`;
     protected _widthValue: number;
@@ -105,17 +116,20 @@ export declare abstract class Renderable extends EventEmitter {
     protected keypressHandler: ((key: ParsedKey) => void) | null;
     private _live;
     protected _liveCount: number;
+    private _sizeChangeListener;
     private _mouseListener;
     private _mouseListeners;
     private _keyListeners;
     protected layoutNode: TrackedNode;
     protected _positionType: PositionTypeString;
+    protected _overflow: OverflowString;
     protected _position: Position;
-    private _childHostOverride;
     private renderableMap;
-    private renderableArray;
+    protected renderableArray: Renderable[];
     private needsZIndexSort;
     parent: Renderable | null;
+    private childrenPrimarySortDirty;
+    private childrenSortedByPrimaryAxis;
     renderBefore?: (this: Renderable, buffer: OptimizedBuffer, deltaTime: number) => void;
     renderAfter?: (this: Renderable, buffer: OptimizedBuffer, deltaTime: number) => void;
     constructor(ctx: RenderContext, options: RenderableOptions<any>);
@@ -123,7 +137,7 @@ export declare abstract class Renderable extends EventEmitter {
     get visible(): boolean;
     set visible(value: boolean);
     hasSelection(): boolean;
-    onSelectionChanged(selection: SelectionState | null): boolean;
+    onSelectionChanged(selection: Selection | null): boolean;
     getSelectedText(): string;
     shouldStartSelection(x: number, y: number): boolean;
     focus(): void;
@@ -135,12 +149,13 @@ export declare abstract class Renderable extends EventEmitter {
     protected propagateLiveCount(delta: number): void;
     handleKeyPress?(key: ParsedKey | string): boolean;
     protected get isDirty(): boolean;
-    get childHost(): Renderable;
-    set childHost(host: Renderable | null);
     findDescendantById(id: string): Renderable | undefined;
-    setChildHostById(id: string): boolean;
     private markClean;
-    needsUpdate(): void;
+    requestRender(): void;
+    get translateX(): number;
+    set translateX(value: number);
+    get translateY(): number;
+    set translateY(value: number);
     get x(): number;
     set x(value: number);
     get top(): number | "auto" | `${number}%` | undefined;
@@ -161,16 +176,22 @@ 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[];
     private setupYogaProperties;
     private setupMarginAndPadding;
     set position(positionType: PositionTypeString);
+    get overflow(): OverflowString;
+    set overflow(overflow: OverflowString);
     setPosition(position: Position): void;
     private updateYogaPosition;
     set flexGrow(grow: number);
     set flexShrink(shrink: number);
     set flexDirection(direction: FlexDirectionString);
+    set flexWrap(wrap: WrapString);
     set alignItems(alignItems: AlignString);
     set justifyContent(justifyContent: JustifyString);
+    set alignSelf(alignSelf: AlignString);
     set flexBasis(basis: number | "auto" | undefined);
     set minWidth(minWidth: number | `${number}%` | undefined);
     set maxWidth(maxWidth: number | `${number}%` | undefined);
@@ -199,8 +220,16 @@ export declare abstract class Renderable extends EventEmitter {
     remove(id: string): void;
     protected onRemove(): void;
     getChildren(): Renderable[];
+    getChildrenCount(): number;
     render(buffer: OptimizedBuffer, deltaTime: number): void;
-    protected beforeRender(): void;
+    protected _getChildren(): Renderable[];
+    protected onUpdate(deltaTime: number): void;
+    protected getScissorRect(): {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
     protected renderSelf(buffer: OptimizedBuffer, deltaTime: number): void;
     destroy(): void;
     destroyRecursively(): void;
@@ -219,6 +248,8 @@ export declare abstract class Renderable extends EventEmitter {
     set onMouseScroll(handler: ((event: MouseEvent) => void) | undefined);
     set onKeyDown(handler: ((key: ParsedKey) => void) | undefined);
     get onKeyDown(): ((key: ParsedKey) => void) | undefined;
+    set onSizeChange(handler: (() => void) | undefined);
+    get onSizeChange(): (() => void) | undefined;
     private applyEventOptions;
 }
 export declare class RootRenderable extends Renderable {
@@ -227,6 +258,7 @@ export declare class RootRenderable extends Renderable {
     protected propagateLiveCount(delta: number): void;
     calculateLayout(): void;
     resize(width: number, height: number): void;
-    protected beforeRender(): void;
+    protected onUpdate(): void;
     protected destroySelf(): void;
 }
+export {};

package/animation/Timeline.d.ts

@@ -88,7 +88,11 @@ export declare class Timeline {
     private autoplay;
     private onComplete?;
     private onPause?;
+    private stateChangeListeners;
     constructor(options?: TimelineOptions);
+    addStateChangeListener(listener: (timeline: Timeline) => void): void;
+    removeStateChangeListener(listener: (timeline: Timeline) => void): void;
+    private notifyStateChange;
     add(target: any, properties: AnimationOptions, startTime?: number | string): this;
     once(target: any, properties: AnimationOptions): this;
     call(callback: () => void, startTime?: number | string): this;
@@ -101,9 +105,16 @@ export declare class Timeline {
 }
 declare class TimelineEngine {
     private timelines;
+    private renderer;
+    private frameCallback;
+    private isLive;
     defaults: {
         frameRate: number;
     };
+    attach(renderer: any): void;
+    detach(): void;
+    private updateLiveState;
+    private onTimelineStateChange;
     register(timeline: Timeline): void;
     unregister(timeline: Timeline): void;
     clear(): void;

package/buffer.d.ts

@@ -9,44 +9,33 @@ export declare class OptimizedBuffer {
     id: string;
     lib: RenderLib;
     private bufferPtr;
-    private buffer;
     private _width;
     private _height;
     respectAlpha: boolean;
-    private useFFI;
+    private _rawBuffers;
     get ptr(): Pointer;
-    constructor(lib: RenderLib, ptr: Pointer, buffer: {
+    get buffers(): {
         char: Uint32Array;
         fg: Float32Array;
         bg: Float32Array;
         attributes: Uint8Array;
-    }, width: number, height: number, options: {
+    };
+    constructor(lib: RenderLib, ptr: Pointer, width: number, height: number, options: {
         respectAlpha?: boolean;
+        id?: string;
     });
     static create(width: number, height: number, widthMethod: WidthMethod, options?: {
         respectAlpha?: boolean;
+        id?: string;
     }): OptimizedBuffer;
-    get buffers(): {
-        char: Uint32Array;
-        fg: Float32Array;
-        bg: Float32Array;
-        attributes: Uint8Array;
-    };
     private coordsToIndex;
     get width(): number;
     get height(): number;
     setRespectAlpha(respectAlpha: boolean): void;
-    clear(bg?: RGBA, clearChar?: string): void;
-    clearLocal(bg?: RGBA, clearChar?: string): void;
+    getNativeId(): string;
+    clear(bg?: RGBA): void;
     setCell(x: number, y: number, char: string, fg: RGBA, bg: RGBA, attributes?: number): void;
-    get(x: number, y: number): {
-        char: number;
-        fg: RGBA;
-        bg: RGBA;
-        attributes: number;
-    } | null;
     setCellWithAlphaBlending(x: number, y: number, char: string, fg: RGBA, bg: RGBA, attributes?: number): void;
-    setCellWithAlphaBlendingLocal(x: number, y: number, char: string, fg: RGBA, bg: RGBA, attributes?: number): void;
     drawText(text: string, x: number, y: number, fg: RGBA, bg?: RGBA, attributes?: number, selection?: {
         start: number;
         end: number;
@@ -54,9 +43,7 @@ export declare class OptimizedBuffer {
         fgColor?: RGBA;
     } | null): void;
     fillRect(x: number, y: number, width: number, height: number, bg: RGBA): void;
-    fillRectLocal(x: number, y: number, width: number, height: number, bg: RGBA): void;
     drawFrameBuffer(destX: number, destY: number, frameBuffer: OptimizedBuffer, sourceX?: number, sourceY?: number, sourceWidth?: number, sourceHeight?: number): void;
-    drawFrameBufferLocal(destX: number, destY: number, frameBuffer: OptimizedBuffer, sourceX?: number, sourceY?: number, sourceWidth?: number, sourceHeight?: number): void;
     destroy(): void;
     drawTextBuffer(textBuffer: TextBuffer, x: number, y: number, clipRect?: {
         x: number;
@@ -65,14 +52,8 @@ export declare class OptimizedBuffer {
         height: number;
     }): void;
     drawSuperSampleBuffer(x: number, y: number, pixelDataPtr: Pointer, pixelDataLength: number, format: "bgra8unorm" | "rgba8unorm", alignedBytesPerRow: number): void;
-    drawSuperSampleBufferFFI(x: number, y: number, pixelDataPtr: Pointer, pixelDataLength: number, format: "bgra8unorm" | "rgba8unorm", alignedBytesPerRow: number): void;
     drawPackedBuffer(dataPtr: Pointer, dataLen: number, posX: number, posY: number, terminalWidthCells: number, terminalHeightCells: number): void;
-    setCellWithAlphaBlendingFFI(x: number, y: number, char: string, fg: RGBA, bg: RGBA, attributes?: number): void;
-    fillRectFFI(x: number, y: number, width: number, height: number, bg: RGBA): void;
     resize(width: number, height: number): void;
-    clearFFI(bg?: RGBA): void;
-    drawTextFFI(text: string, x: number, y: number, fg?: RGBA, bg?: RGBA, attributes?: number): void;
-    drawFrameBufferFFI(destX: number, destY: number, frameBuffer: OptimizedBuffer, sourceX?: number, sourceY?: number, sourceWidth?: number, sourceHeight?: number): void;
     drawBox(options: {
         x: number;
         y: number;
@@ -87,4 +68,7 @@ export declare class OptimizedBuffer {
         title?: string;
         titleAlignment?: "left" | "center" | "right";
     }): void;
+    pushScissorRect(x: number, y: number, width: number, height: number): void;
+    popScissorRect(): void;
+    clearScissorRects(): void;
 }

package/console.d.ts

@@ -1,5 +1,5 @@
-import type { CliRenderer, ColorInput } from ".";
 import { EventEmitter } from "events";
+import type { CliRenderer, ColorInput } from ".";
 import { OptimizedBuffer } from "./buffer";
 import { Capture } from "./lib/output.capture";
 export declare const capture: Capture;
@@ -45,7 +45,7 @@ export declare class TerminalConsole extends EventEmitter {
     private _displayLines;
     private _allLogEntries;
     private _needsFrameBufferUpdate;
-    private markNeedsUpdate;
+    private markNeedsRerender;
     private _rgbaInfo;
     private _rgbaWarn;
     private _rgbaError;