@opentui/core 0.1.6 → 0.1.8

package/README.md

@@ -3,6 +3,8 @@
 OpenTUI Core is a TypeScript library for building terminal user interfaces (TUIs). It is currently in
 development and is not ready for production use.
 
+[Getting Started](docs/getting-started.md)
+
 ## Install
 
 ```bash

package/Renderable.d.ts

@@ -14,6 +14,10 @@ export declare enum RenderableEvents {
     FOCUSED = "focused",
     BLURRED = "blurred"
 }
+export interface RootContext {
+    requestLive(): void;
+    dropLive(): void;
+}
 export interface Position {
     top?: number | "auto" | `${number}%`;
     right?: number | "auto" | `${number}%`;
@@ -54,10 +58,22 @@ export interface RenderableOptions extends Partial<LayoutOptions> {
     zIndex?: number;
     visible?: boolean;
     buffered?: boolean;
+    live?: boolean;
+    onMouseDown?: (event: MouseEvent) => void;
+    onMouseUp?: (event: MouseEvent) => void;
+    onMouseMove?: (event: MouseEvent) => void;
+    onMouseDrag?: (event: MouseEvent) => void;
+    onMouseDragEnd?: (event: MouseEvent) => void;
+    onMouseDrop?: (event: MouseEvent) => void;
+    onMouseOver?: (event: MouseEvent) => void;
+    onMouseOut?: (event: MouseEvent) => void;
+    onMouseScroll?: (event: MouseEvent) => void;
+    onKeyDown?: (key: ParsedKey) => void;
 }
 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 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;
@@ -70,8 +86,8 @@ export declare abstract class Renderable extends EventEmitter {
     private _y;
     protected _width: number | "auto" | `${number}%`;
     protected _height: number | "auto" | `${number}%`;
-    private _widthValue;
-    private _heightValue;
+    protected _widthValue: number;
+    protected _heightValue: number;
     private _zIndex;
     protected _visible: boolean;
     selectable: boolean;
@@ -82,6 +98,10 @@ export declare abstract class Renderable extends EventEmitter {
     protected _focused: boolean;
     protected keyHandler: KeyHandler;
     protected keypressHandler: ((key: ParsedKey) => void) | null;
+    private _live;
+    protected _liveCount: number;
+    private _mouseListeners;
+    private _keyListeners;
     protected layoutNode: TrackedNode;
     protected _positionType: PositionTypeString;
     protected _position: Position;
@@ -100,6 +120,10 @@ export declare abstract class Renderable extends EventEmitter {
     focus(): void;
     blur(): void;
     get focused(): boolean;
+    get live(): boolean;
+    get liveCount(): number;
+    set live(value: boolean);
+    protected propagateLiveCount(delta: number): void;
     handleKeyPress?(key: ParsedKey | string): boolean;
     protected get isDirty(): boolean;
     private markClean;
@@ -171,11 +195,25 @@ export declare abstract class Renderable extends EventEmitter {
     protected destroySelf(): void;
     processMouseEvent(event: MouseEvent): void;
     protected onMouseEvent(event: MouseEvent): void;
+    set onMouseDown(handler: ((event: MouseEvent) => void) | undefined);
+    set onMouseUp(handler: ((event: MouseEvent) => void) | undefined);
+    set onMouseMove(handler: ((event: MouseEvent) => void) | undefined);
+    set onMouseDrag(handler: ((event: MouseEvent) => void) | undefined);
+    set onMouseDragEnd(handler: ((event: MouseEvent) => void) | undefined);
+    set onMouseDrop(handler: ((event: MouseEvent) => void) | undefined);
+    set onMouseOver(handler: ((event: MouseEvent) => void) | undefined);
+    set onMouseOut(handler: ((event: MouseEvent) => void) | undefined);
+    set onMouseScroll(handler: ((event: MouseEvent) => void) | undefined);
+    set onKeyDown(handler: ((key: ParsedKey) => void) | undefined);
+    get onKeyDown(): ((key: ParsedKey) => void) | undefined;
+    private applyEventOptions;
 }
 export declare class RootRenderable extends Renderable {
     private yogaConfig;
-    constructor(width: number, height: number, ctx: RenderContext);
+    private rootContext;
+    constructor(width: number, height: number, ctx: RenderContext, rootContext: RootContext);
     requestLayout(): void;
+    protected propagateLiveCount(delta: number): void;
     calculateLayout(): void;
     resize(width: number, height: number): void;
     protected beforeRender(): void;

package/ansi.d.ts

@@ -23,4 +23,6 @@ export declare const ANSI: {
     disableAnyEventTracking: string;
     enableSGRMouseMode: string;
     disableSGRMouseMode: string;
+    makeRoomForRenderer: (height: number) => string;
+    clearRendererSpace: (height: number) => string;
 };

package/buffer.d.ts

@@ -1,5 +1,5 @@
 import type { TextBuffer } from "./text-buffer";
-import { RGBA } from "./types";
+import { RGBA } from "./lib";
 import { type RenderLib } from "./zig";
 import { type Pointer } from "bun:ffi";
 import { type BorderStyle, type BorderSides } from "./lib";

package/index.d.ts

@@ -6,9 +6,6 @@ export * from "./text-buffer";
 export * from "./post/filters";
 export * from "./animation/Timeline";
 export * from "./lib";
-export * from "./lib/parse.keypress";
-export * from "./lib/styled-text";
-export * from "./lib/selection";
 export * from "./renderer";
 export * from "./renderables";
 export * from "./zig";