@jitl/opentui-solid 0.1.97-next.130245d

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 opentui
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,193 @@
+> Experimental build of OpenTUI for Node.js from [github.com/justjake/opentui](https://github.com/justjake/opentui).
+>
+> Published under `@jitl/*` until the Node.js support branch is upstreamed.
+# @jitl/opentui-solid
+
+Solid.js support for [OpenTUI](https://github.com/anomalyco/opentui).
+
+## Installation
+
+```bash
+bun install solid-js @jitl/opentui-solid
+```
+
+## Usage
+
+1. Add jsx config to tsconfig.json:
+
+```json
+{
+  "compilerOptions": {
+    "jsx": "preserve",
+    "jsxImportSource": "@jitl/opentui-solid"
+  }
+}
+```
+
+2. Add preload script to bunfig.toml:
+
+```toml
+preload = ["@jitl/opentui-solid/preload"]
+```
+
+3. Add render function to index.tsx:
+
+```tsx
+import { render } from "@jitl/opentui-solid"
+
+render(() => <text>Hello, World!</text>)
+```
+
+4. Run with `bun index.tsx`.
+
+5. To build use [Bun.build](https://bun.com/docs/bundler) ([source](https://github.com/anomalyco/opentui/issues/122)):
+
+```ts
+import solidPlugin from "@jitl/opentui-solid/bun-plugin"
+
+await Bun.build({
+  entrypoints: ["./index.tsx"],
+  target: "bun",
+  outdir: "./build",
+  plugins: [solidPlugin],
+  compile: {
+    target: "bun-darwin-arm64",
+    outfile: "app-macos",
+  },
+})
+```
+
+## Table of Contents
+
+- [Core Concepts](#core-concepts)
+  - [Components](#components)
+- [API Reference](#api-reference)
+  - [render(node, rendererOrConfig?)](#rendernode-rendererorconfig)
+  - [testRender(node, options?)](#testrendernode-options)
+  - [extend(components)](#extendcomponents)
+  - [getComponentCatalogue()](#getcomponentcatalogue)
+  - [Hooks](#hooks)
+  - [Portal](#portal)
+  - [Dynamic](#dynamic)
+- [Components](#components-1)
+  - [Layout & Display](#layout--display)
+  - [Input](#input)
+  - [Code & Diff](#code--diff)
+  - [Text Modifiers](#text-modifiers)
+
+## Core Concepts
+
+### Components
+
+OpenTUI Solid exposes intrinsic JSX elements that map to OpenTUI renderables:
+
+- **Layout & Display:** `text`, `box`, `scrollbox`, `ascii_font`
+- **Input:** `input`, `textarea`, `select`, `tab_select`
+- **Code & Diff:** `code`, `line_number`, `diff`
+- **Text Modifiers:** `span`, `strong`, `b`, `em`, `i`, `u`, `br`, `a`
+
+## API Reference
+
+### `render(node, rendererOrConfig?)`
+
+Render a Solid component tree into a CLI renderer. If `rendererOrConfig` is omitted, a renderer is created with default options.
+
+```tsx
+import { render } from "@jitl/opentui-solid"
+
+render(() => <App />)
+```
+
+**Parameters:**
+
+- `node`: Function returning a JSX element.
+- `rendererOrConfig?`: `CliRenderer` instance or `CliRendererConfig`.
+
+### `testRender(node, options?)`
+
+Create a test renderer for snapshots and interaction tests.
+
+```tsx
+import { testRender } from "@jitl/opentui-solid"
+
+const testSetup = await testRender(() => <App />, { width: 40, height: 10 })
+```
+
+### `extend(components)`
+
+Register custom renderables as JSX intrinsic elements.
+
+```tsx
+import { extend } from "@jitl/opentui-solid"
+
+extend({ customBox: CustomBoxRenderable })
+```
+
+### `getComponentCatalogue()`
+
+Returns the current component catalogue that powers JSX tag lookup.
+
+### Hooks
+
+- `useRenderer()`
+- `onResize(callback)`
+- `onFocus(callback)`
+- `onBlur(callback)`
+- `useTerminalDimensions()`
+- `useKeyboard(handler, options?)`
+- `usePaste(handler)`
+- `useSelectionHandler(handler)`
+- `useTimeline(options?)`
+
+### `Portal`
+
+Render children into a different mount node, useful for overlays and tooltips.
+
+```tsx
+import { Portal } from "@jitl/opentui-solid"
+;<Portal mount={renderer.root}>
+  <box border>Overlay</box>
+</Portal>
+```
+
+### `Dynamic`
+
+Render arbitrary intrinsic elements or components dynamically.
+
+```tsx
+import { Dynamic } from "@jitl/opentui-solid"
+;<Dynamic component={isMultiline() ? "textarea" : "input"} />
+```
+
+## Components
+
+### Layout & Display
+
+- `text`: styled text container
+- `box`: layout container with borders, padding, and flex settings
+- `scrollbox`: scrollable container
+- `ascii_font`: ASCII art text renderer
+
+### Input
+
+- `input`: single-line text input
+- `textarea`: multi-line text input
+- `select`: list selection
+- `tab_select`: tab-based selection
+
+### Code & Diff
+
+- `code`: syntax-highlighted code blocks
+- `line_number`: line-numbered code display with diff/diagnostic helpers
+- `diff`: unified or split diff viewer
+
+### Text Modifiers
+
+These must appear inside a `text` component:
+
+- `span`: inline styled text
+- `strong`/`b`: bold text
+- `em`/`i`: italic text
+- `u`: underline text
+- `br`: line break
+- `a`: link text with `href`

package/dist/index.d.ts

@@ -0,0 +1,160 @@
+export function useTimeline(options?: {}): Timeline;
+export function useTerminalDimensions(): import("solid-js").Accessor<{
+    width: any;
+    height: any;
+}>;
+export function useSelectionHandler(callback: any): void;
+export function useRenderer(): any;
+export function usePaste(callback: any): void;
+export function useKeyboard(callback: any, options: any): void;
+export function useKeyHandler(callback: any, options: any): void;
+export function use(fn: any, element: any, arg: any): any;
+export var textNodeKeys: string[];
+export function testRender(node: any, renderConfig?: {}): Promise<{
+    renderer: import("@jitl/opentui-core/testing").TestRenderer;
+    mockInput: import("@jitl/opentui-core/testing").MockInput;
+    mockMouse: import("@jitl/opentui-core/testing").MockMouse;
+    renderOnce: () => Promise<void>;
+    captureCharFrame: () => string;
+    captureSpans: () => import("@jitl/opentui-core").CapturedFrame;
+    resize: (width: number, height: number) => void;
+}>;
+export function spread(node: any, accessor: any, skipChildren: any): void;
+export function setProp(node: any, name: any, value: any, prev: any): any;
+export function render(node: any, rendererOrConfig?: {}): Promise<void>;
+export function onResize(callback: any): void;
+export function onFocus(callback: any): void;
+export function onBlur(callback: any): void;
+declare var mergeProps3: typeof mergeProps;
+declare function memo2(fn: any): import("solid-js").Accessor<any>;
+export var insertNode: any;
+export function insert(parent: any, accessor: any, marker: any, initial: any): any;
+export function getComponentCatalogue(): {
+    box: typeof BoxRenderable;
+    text: typeof TextRenderable3;
+    input: typeof InputRenderable2;
+    select: typeof SelectRenderable2;
+    textarea: typeof TextareaRenderable;
+    ascii_font: typeof ASCIIFontRenderable;
+    tab_select: typeof TabSelectRenderable2;
+    scrollbox: typeof ScrollBoxRenderable2;
+    code: typeof CodeRenderable;
+    diff: typeof DiffRenderable;
+    line_number: typeof LineNumberRenderable;
+    markdown: typeof MarkdownRenderable;
+    span: typeof SpanRenderable;
+    strong: typeof BoldSpanRenderable;
+    b: typeof BoldSpanRenderable;
+    em: typeof ItalicSpanRenderable;
+    i: typeof ItalicSpanRenderable;
+    u: typeof UnderlineSpanRenderable;
+    br: typeof LineBreakRenderable;
+    a: typeof LinkRenderable;
+};
+export function extend(objects: any): void;
+export var effect: typeof createRenderEffect;
+export var createTextNode: any;
+export function createSolidSlotRegistry(renderer: any, context: any, options?: {}): import("@jitl/opentui-core").SlotRegistry<any, object, any>;
+export function createSlotNode(): SlotRenderable;
+export function createSlot(registry: any, options?: {}): (props: any) => any;
+export var createElement: any;
+export function createDynamic(component: any, props: any): import("solid-js").Accessor<any>;
+declare var createComponent2: typeof createComponent;
+export namespace componentCatalogue {
+    export { BoxRenderable as box };
+    export { TextRenderable3 as text };
+    export { InputRenderable2 as input };
+    export { SelectRenderable2 as select };
+    export { TextareaRenderable as textarea };
+    export { ASCIIFontRenderable as ascii_font };
+    export { TabSelectRenderable2 as tab_select };
+    export { ScrollBoxRenderable2 as scrollbox };
+    export { CodeRenderable as code };
+    export { DiffRenderable as diff };
+    export { LineNumberRenderable as line_number };
+    export { MarkdownRenderable as markdown };
+    export { SpanRenderable as span };
+    export { BoldSpanRenderable as strong };
+    export { BoldSpanRenderable as b };
+    export { ItalicSpanRenderable as em };
+    export { ItalicSpanRenderable as i };
+    export { UnderlineSpanRenderable as u };
+    export { LineBreakRenderable as br };
+    export { LinkRenderable as a };
+}
+export namespace baseComponents { }
+export function _render(code: any, element: any): undefined;
+export class UnderlineSpanRenderable extends TextModifierRenderable {
+    constructor(options: any);
+}
+export function TimeToFirstDraw(props: any): any;
+export class TextSlotRenderable extends TextNodeRenderable3 {
+    constructor(id: any, parent: any);
+    slotParent: any;
+    destroyed: boolean;
+}
+export class SlotRenderable extends SlotBaseRenderable {
+    layoutNode: any;
+    textNode: any;
+    destroyed: boolean;
+    getSlotChild(parent: any): any;
+}
+export function Slot(props: any): import("solid-js").Accessor<any>;
+export var RendererContext: import("solid-js").Context<any>;
+export function Portal(props: any): SlotRenderable;
+export class LinkRenderable extends SpanRenderable {
+}
+export class LineBreakRenderable extends SpanRenderable {
+    add(): number;
+}
+export class LayoutSlotRenderable extends SlotBaseRenderable {
+    constructor(id: any, parent: any);
+    yogaNode: Yoga.Node;
+    slotParent: any;
+    destroyed: boolean;
+    getLayoutNode(): Yoga.Node;
+    updateFromLayout(): void;
+    updateLayout(): void;
+    onRemove(): void;
+}
+export class ItalicSpanRenderable extends TextModifierRenderable {
+    constructor(options: any);
+}
+export function Dynamic(props: any): import("solid-js").Accessor<any>;
+export class BoldSpanRenderable extends TextModifierRenderable {
+    constructor(options: any);
+}
+import { Timeline } from "@jitl/opentui-core";
+import { mergeProps } from "solid-js";
+import { BoxRenderable } from "@jitl/opentui-core";
+import { TextRenderable as TextRenderable3 } from "@jitl/opentui-core";
+import { InputRenderable as InputRenderable2 } from "@jitl/opentui-core";
+import { SelectRenderable as SelectRenderable2 } from "@jitl/opentui-core";
+import { TextareaRenderable } from "@jitl/opentui-core";
+import { ASCIIFontRenderable } from "@jitl/opentui-core";
+import { TabSelectRenderable as TabSelectRenderable2 } from "@jitl/opentui-core";
+import { ScrollBoxRenderable as ScrollBoxRenderable2 } from "@jitl/opentui-core";
+import { CodeRenderable } from "@jitl/opentui-core";
+import { DiffRenderable } from "@jitl/opentui-core";
+import { LineNumberRenderable } from "@jitl/opentui-core";
+import { MarkdownRenderable } from "@jitl/opentui-core";
+declare class SpanRenderable extends TextNodeRenderable3 {
+    constructor(_ctx: any, options: any);
+    _ctx: any;
+}
+import { createRenderEffect } from "solid-js";
+import { createComponent } from "solid-js";
+declare class TextModifierRenderable extends SpanRenderable {
+}
+import { TextNodeRenderable as TextNodeRenderable3 } from "@jitl/opentui-core";
+declare class SlotBaseRenderable extends BaseRenderable {
+    constructor(id: any);
+    add(obj: any, index: any): void;
+    remove(id: any): void;
+    insertBefore(obj: any, anchor: any): void;
+    getRenderable(id: any): void;
+    findDescendantById(id: any): void;
+}
+import { Yoga } from "@jitl/opentui-core";
+import { BaseRenderable } from "@jitl/opentui-core";
+export { mergeProps3 as mergeProps, memo2 as memo, createComponent2 as createComponent };

package/index.d.ts

@@ -0,0 +1,19 @@
+import { CliRenderer, type CliRendererConfig } from "@jitl/opentui-core";
+import { type TestRendererOptions } from "@jitl/opentui-core/testing";
+import type { JSX } from "./jsx-runtime";
+export declare const render: (node: () => JSX.Element, rendererOrConfig?: CliRenderer | CliRendererConfig) => Promise<void>;
+export declare const testRender: (node: () => JSX.Element, renderConfig?: TestRendererOptions) => Promise<{
+    renderer: import("@jitl/opentui-core/testing").TestRenderer;
+    mockInput: import("@jitl/opentui-core/testing").MockInput;
+    mockMouse: import("@jitl/opentui-core/testing").MockMouse;
+    renderOnce: () => Promise<void>;
+    captureCharFrame: () => string;
+    captureSpans: () => import("@jitl/opentui-core").CapturedFrame;
+    resize: (width: number, height: number) => void;
+}>;
+export * from "./src/reconciler.js";
+export * from "./src/elements/index.js";
+export * from "./src/time-to-first-draw.js";
+export * from "./src/plugins/slot.js";
+export * from "./src/types/elements.js";
+export { type JSX };