@opentui/react 0.1.13 → 0.1.15

package/README.md

@@ -18,7 +18,7 @@ function App() {
     <box>
       <text fg="#00FF00">Hello, Terminal!</text>
       <box title="Welcome" padding={2}>
-        <text>Welcome to OpenTUI with React!"</text>
+        <text>Welcome to OpenTUI with React!</text>
       </box>
     </box>
   )
@@ -484,7 +484,7 @@ class ButtonRenderable extends BoxRenderable {
 
   set label(value: string) {
     this._label = value
-    this.needsUpdate()
+    this.requestRender()
   }
 }
 

package/index.js

@@ -4,6 +4,7 @@ import {
   ASCIIFontRenderable,
   BoxRenderable,
   InputRenderable,
+  ScrollBoxRenderable,
   SelectRenderable,
   TabSelectRenderable,
   TextRenderable
@@ -13,6 +14,7 @@ var baseComponents = {
   text: TextRenderable,
   input: InputRenderable,
   select: SelectRenderable,
+  scrollbox: ScrollBoxRenderable,
   "ascii-font": ASCIIFontRenderable,
   "tab-select": TabSelectRenderable
 };
@@ -34,14 +36,30 @@ var useAppContext = () => {
 };
 // src/hooks/use-keyboard.tsx
 import { useEffect } from "react";
+
+// src/hooks/use-event.tsx
+import { useCallback, useLayoutEffect, useRef } from "react";
+function useEvent(handler) {
+  const handlerRef = useRef(handler);
+  useLayoutEffect(() => {
+    handlerRef.current = handler;
+  });
+  return useCallback((...args) => {
+    const fn = handlerRef.current;
+    return fn(...args);
+  }, []);
+}
+
+// src/hooks/use-keyboard.tsx
 var useKeyboard = (handler) => {
   const { keyHandler } = useAppContext();
+  const stableHandler = useEvent(handler);
   useEffect(() => {
-    keyHandler?.on("keypress", handler);
+    keyHandler?.on("keypress", stableHandler);
     return () => {
-      keyHandler?.off("keypress", handler);
+      keyHandler?.off("keypress", stableHandler);
     };
-  }, [keyHandler, handler]);
+  }, [keyHandler, stableHandler]);
 };
 // src/hooks/use-renderer.tsx
 var useRenderer = () => {
@@ -68,8 +86,8 @@ import { useState } from "react";
 var useTerminalDimensions = () => {
   const renderer = useRenderer();
   const [dimensions, setDimensions] = useState({
-    width: renderer.terminalWidth,
-    height: renderer.terminalHeight
+    width: renderer.width,
+    height: renderer.height
   });
   const cb = (width, height) => {
     setDimensions({ width, height });
@@ -266,7 +284,10 @@ var hostConfig = {
     if (!components[type]) {
       throw new Error(`[Reconciler] Unknown component type: ${type}`);
     }
-    return new components[type](rootContainerInstance.ctx, {});
+    return new components[type](rootContainerInstance.ctx, {
+      id,
+      ...props
+    });
   },
   appendChild(parent, child) {
     parent.add(child);
@@ -287,7 +308,7 @@ var hostConfig = {
     return null;
   },
   resetAfterCommit(containerInfo) {
-    containerInfo.needsUpdate();
+    containerInfo.requestRender();
   },
   getRootHostContext(rootContainerInstance) {
     return {};
@@ -321,11 +342,11 @@ var hostConfig = {
   commitMount(instance, type, props, internalInstanceHandle) {},
   commitUpdate(instance, type, oldProps, newProps, internalInstanceHandle) {
     updateProperties(instance, type, oldProps, newProps);
-    instance.needsUpdate();
+    instance.requestRender();
   },
   commitTextUpdate(textInstance, oldText, newText) {
     textInstance.content = newText;
-    textInstance.needsUpdate();
+    textInstance.requestRender();
   },
   appendChildToContainer(container, child) {
     container.add(child);
@@ -335,19 +356,19 @@ var hostConfig = {
   },
   hideInstance(instance) {
     instance.visible = false;
-    instance.needsUpdate();
+    instance.requestRender();
   },
   unhideInstance(instance, props) {
     instance.visible = true;
-    instance.needsUpdate();
+    instance.requestRender();
   },
   hideTextInstance(textInstance) {
     textInstance.visible = false;
-    textInstance.needsUpdate();
+    textInstance.requestRender();
   },
   unhideTextInstance(textInstance, text) {
     textInstance.visible = true;
-    textInstance.needsUpdate();
+    textInstance.requestRender();
   },
   clearContainer(container) {
     const children = container.getChildren();

package/jsx-namespace.d.ts

@@ -2,12 +2,14 @@ import type * as React from "react"
 import type {
   AsciiFontProps,
   BoxProps,
+  ExtendedIntrinsicElements,
   InputProps,
+  OpenTUIComponents,
+  ScrollBoxProps,
   SelectProps,
   TabSelectProps,
   TextProps,
 } from "./src/types/components"
-import type { ExtendedIntrinsicElements, OpenTUIComponents } from "./src/types/components"
 
 export namespace JSX {
   type Element = React.ReactNode
@@ -29,6 +31,7 @@ export namespace JSX {
     text: TextProps
     input: InputProps
     select: SelectProps
+    scrollbox: ScrollBoxProps
     "ascii-font": AsciiFontProps
     "tab-select": TabSelectProps
   }

package/package.json

@@ -4,7 +4,7 @@
   "main": "index.js",
   "types": "src/index.d.ts",
   "type": "module",
-  "version": "0.1.13",
+  "version": "0.1.15",
   "description": "React renderer for building terminal user interfaces using OpenTUI core",
   "license": "MIT",
   "repository": {
@@ -35,7 +35,7 @@
     }
   },
   "dependencies": {
-    "@opentui/core": "0.1.13",
+    "@opentui/core": "0.1.15",
     "react-reconciler": "^0.32.0"
   },
   "devDependencies": {

package/src/components/index.d.ts

@@ -1,10 +1,11 @@
-import { ASCIIFontRenderable, BoxRenderable, InputRenderable, SelectRenderable, TabSelectRenderable, TextRenderable } from "@opentui/core";
+import { ASCIIFontRenderable, BoxRenderable, InputRenderable, ScrollBoxRenderable, SelectRenderable, TabSelectRenderable, TextRenderable } from "@opentui/core";
 import type { RenderableConstructor } from "../types/components";
 export declare const baseComponents: {
     box: typeof BoxRenderable;
     text: typeof TextRenderable;
     input: typeof InputRenderable;
     select: typeof SelectRenderable;
+    scrollbox: typeof ScrollBoxRenderable;
     "ascii-font": typeof ASCIIFontRenderable;
     "tab-select": typeof TabSelectRenderable;
 };

package/src/hooks/use-event.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Returns a stable callback that always calls the latest version of the provided handler.
+ * This prevents unnecessary re-renders and effect re-runs while ensuring the callback
+ * always has access to the latest props and state.
+ *
+ * Useful for event handlers that need to be passed to effects with empty dependency arrays
+ * or memoized child components.
+ */
+export declare function useEvent<T extends (...args: any[]) => any>(handler: T): T;

package/src/reconciler/renderer.js

@@ -23,6 +23,7 @@ import {
   ASCIIFontRenderable,
   BoxRenderable,
   InputRenderable,
+  ScrollBoxRenderable,
   SelectRenderable,
   TabSelectRenderable,
   TextRenderable
@@ -32,6 +33,7 @@ var baseComponents = {
   text: TextRenderable,
   input: InputRenderable,
   select: SelectRenderable,
+  scrollbox: ScrollBoxRenderable,
   "ascii-font": ASCIIFontRenderable,
   "tab-select": TabSelectRenderable
 };
@@ -217,7 +219,10 @@ var hostConfig = {
     if (!components[type]) {
       throw new Error(`[Reconciler] Unknown component type: ${type}`);
     }
-    return new components[type](rootContainerInstance.ctx, {});
+    return new components[type](rootContainerInstance.ctx, {
+      id,
+      ...props
+    });
   },
   appendChild(parent, child) {
     parent.add(child);
@@ -238,7 +243,7 @@ var hostConfig = {
     return null;
   },
   resetAfterCommit(containerInfo) {
-    containerInfo.needsUpdate();
+    containerInfo.requestRender();
   },
   getRootHostContext(rootContainerInstance) {
     return {};
@@ -272,11 +277,11 @@ var hostConfig = {
   commitMount(instance, type, props, internalInstanceHandle) {},
   commitUpdate(instance, type, oldProps, newProps, internalInstanceHandle) {
     updateProperties(instance, type, oldProps, newProps);
-    instance.needsUpdate();
+    instance.requestRender();
   },
   commitTextUpdate(textInstance, oldText, newText) {
     textInstance.content = newText;
-    textInstance.needsUpdate();
+    textInstance.requestRender();
   },
   appendChildToContainer(container, child) {
     container.add(child);
@@ -286,19 +291,19 @@ var hostConfig = {
   },
   hideInstance(instance) {
     instance.visible = false;
-    instance.needsUpdate();
+    instance.requestRender();
   },
   unhideInstance(instance, props) {
     instance.visible = true;
-    instance.needsUpdate();
+    instance.requestRender();
   },
   hideTextInstance(textInstance) {
     textInstance.visible = false;
-    textInstance.needsUpdate();
+    textInstance.requestRender();
   },
   unhideTextInstance(textInstance, text) {
     textInstance.visible = true;
-    textInstance.needsUpdate();
+    textInstance.requestRender();
   },
   clearContainer(container) {
     const children = container.getChildren();

package/src/types/components.d.ts

@@ -1,4 +1,4 @@
-import type { ASCIIFontOptions, ASCIIFontRenderable, BoxOptions, BoxRenderable, InputRenderable, InputRenderableOptions, Renderable, RenderableOptions, RenderContext, SelectOption, SelectRenderable, SelectRenderableOptions, StyledText, TabSelectOption, TabSelectRenderable, TabSelectRenderableOptions, TextChunk, TextOptions, TextRenderable } from "@opentui/core";
+import type { ASCIIFontOptions, ASCIIFontRenderable, BoxOptions, BoxRenderable, InputRenderable, InputRenderableOptions, Renderable, RenderableOptions, RenderContext, ScrollBoxOptions, ScrollBoxRenderable, SelectOption, SelectRenderable, SelectRenderableOptions, StyledText, TabSelectOption, TabSelectRenderable, TabSelectRenderableOptions, TextChunk, TextOptions, TextRenderable } from "@opentui/core";
 import type React from "react";
 /** Properties that should not be included in the style prop */
 export type NonStyledProps = "id" | "buffered" | "live" | "enableLayout" | "selectable" | "renderAfter" | "renderBefore" | `on${string}`;
@@ -40,6 +40,9 @@ export type SelectProps = ComponentProps<SelectRenderableOptions, SelectRenderab
     onChange?: (index: number, option: SelectOption | null) => void;
     onSelect?: (index: number, option: SelectOption | null) => void;
 };
+export type ScrollBoxProps = ComponentProps<ContainerProps<ScrollBoxOptions>, ScrollBoxRenderable> & {
+    focused?: boolean;
+};
 export type AsciiFontProps = ComponentProps<ASCIIFontOptions, ASCIIFontRenderable>;
 export type TabSelectProps = ComponentProps<TabSelectRenderableOptions, TabSelectRenderable> & {
     focused?: boolean;