API and symbol index

Use this page to find every published OpenTUI entry point and named export. The tables come from the generated publish maps and source barrels. They include runtime values and type-only exports.

The API reference lists the same exports with their signatures and the release that added each one. Releases lists the API changes of each release.

Support classes#

A row can have more than one class. Read Runtime and platform support for the supported Bun and Node.js versions.

Entry point index#

The runtime column describes the published target. A Node stub throws during import for each Bun-only support entry point.

See Package entry points for each entry point’s role and import constraints.

@opentui/core#

The root works in Bun and supported Node.js releases. A class in these tables applies to every symbol in its row.

Renderer and render tree#

Input and selection#

Text, color, links, and clipboard#

Tree-sitter and syntax styles#

Plugins, console, and process services#

Components and component helpers#

Buffers, editing, animation, and effects#

Images, audio, and native span output#

Low-level native binding exports#

These names expose the TypeScript side of the native binding. Use the higher-level API unless a low-level guide requires one of them.

Start with Native rendering for the scene model. The C and Zig guides cover their native interfaces, which are separate from npm entry points.

Other @opentui/core entry points#

Testing#

@opentui/core/testing works in Bun and Node.js.

Runtime plugin support#

These entry points are Bun-only. Their Node.js targets are stubs that throw during import.

Yoga#

@opentui/core/yoga works in Bun and Node.js. The root Yoga namespace exposes this module. See Yoga API for methods and ownership.

Tree-sitter assets, worker, and Node assets#

@opentui/react#

The root and compiler-selected JSX entry points work in Bun and Node.js.

Root exports#

Other React entry points#

The generated React map points /renderer runtime imports to index.js. Its declaration path points to reconciler/renderer.d.ts. Treat root values outside the four declared names as a build leak.

@opentui/solid#

The root, /components, and compiler-selected JSX entry points work in Bun and Node.js.

Root exports#

Other Solid entry points#

@opentui/keymap#

Root engine#

The root engine is host-agnostic. Use an adapter entry point to connect it to a browser or OpenTUI renderer.

Extras and graph#

Addons#

Testing and hosts#

Frameworks and runtime modules#

The runtimeModules map contains the root, both extras paths, both addon paths, and both host adapters. It loads the React and Solid paths lazily. It does not contain /testing or /runtime-modules.

@opentui/qrcode#

The package root works in Bun and Node.js. Each framework path re-exports the full root and adds its registration function.

@opentui/ssh#

The package supports Bun 1.3.14 or later and Node.js 26.4.0 or later. Use Bun 1.4.0 or later on native Windows arm64. It has one public entry point.

@opentui/three#

Both entry points are Bun-only.

The THREE namespace exposes the installed Three.js module. The runtimeModules map contains only the @opentui/three root.

Native distribution packages#

The build generates eight platform packages:

• @opentui/core-darwin-x64
• @opentui/core-darwin-arm64
• @opentui/core-linux-x64
• @opentui/core-linux-arm64
• @opentui/core-linux-x64-musl
• @opentui/core-linux-arm64-musl
• @opentui/core-win32-x64
• @opentui/core-win32-arm64

Each package has one default export that resolves the native library path. These packages are internal distribution surfaces, not application APIs. Let @opentui/core select the correct package. See Runtime and platform support.

opentui.h#

The npm API and the native application binary interface (ABI) are separate surfaces. opentui.h declares the experimental C ABI. See C. The C ABI reference lists every declaration with the release that added it.

OpenTUI’s TypeScript packages call the native library through internal bindings that can change with them. Use the TypeScript exports indexed above for application code.

These rows name the declarations that the native guides document. The comments in opentui.h document every declaration.

Changes since 0.5.14#

Layout, hit testing, and painting now run in a native scene. Native resources belong to an owner Context. This section lists each 0.5.14 API and behavior that was removed or changed, and what to use instead. Each item names the changed API or behavior first. New APIs are in the tables above.

Renderer#

• addToHitGrid(), pushHitGridScissorRect(), popHitGridScissorRect(), and clearHitGridScissorRects(): removed from the renderer and RenderContext. Native code adds a hit area for each visible node and clips it to overflow ancestors. Use renderer.hitTest(x, y) to query the hit grid.
• dumpBuffers() and dumpOutputBuffer(): removed. Use test frame capture, renderer.currentRenderBuffer.withBuffers(), or a custom stdout. dumpHitGrid() remains.
• renderer.useThread and the useThread option of createCliRenderer() and createTestRenderer(): removed. Core writes output on the JavaScript thread. Remove the option.
• renderer.rendererPtr: removed, with no replacement.
• OTUI_NO_NATIVE_RENDER environment variable: removed. Use createTestRenderer().
• suspend() and resume(): now return a Promise<void>. Await them. They throw when the terminal is not set up (also after destroy()) or a transition is pending. resume() also throws when the renderer is not suspended.
• useMouse, enableKittyKeyboard(), and disableKittyKeyboard(): now throw during terminal setup, suspend, or resume, and while the renderer is suspended. screenMode now throws during setup, suspend, or resume. Change them after the transition completes.
• enableKittyKeyboard(flags): now throws RangeError when flags is not an integer from 0 to 31.
• Output stream error event: now closes the renderer and rejects renderer.closed. Handle the rejection of closed. In 0.5.14, the renderer handled the event only while Kitty file transport was active. It cancelled file transport and kept running. A failed Kitty temporary-file write still falls back to inline transport.
• Renderer methods after destroy(): setTerminalTitle(), resetTerminalBgColor(), copyToClipboardOSC52(), clearClipboardOSC52(), isOsc52Supported(), setCursorPosition(), setCursorStyle(), setCursorColor(), setMousePointer(), getCursorState(), getStats(), getNativeStats(), configureDebugOverlay(), toggleDebugOverlay(), dumpHitGrid(), hitTest(), and console.show() (also through console.toggle()) throw. getPalette() rejects. requestRender(), resize(), triggerNotification(), and getLinkAt() do nothing. Check renderer.isDestroyed first.
• getPalette(): now rejects before the terminal is set up, for example on a createTestRenderer() renderer. It also rejects while a setup, suspend, or resume is pending. Its size must be an integer from 1 to 256.
• Renderable constructors and engine.attach(): now throw for a destroyed renderer. Create renderables before you destroy the renderer.
• destroy(): restores the terminal and releases the streams asynchronously. Await renderer.closed before you reuse the streams.
• Scrollback snapshots and commits: one snapshot or commit larger than the output capacity divided by 24 bytes (about 349,000 cells by default) throws. A rowColumns value that is not an integer from 0 to the snapshot width throws RangeError. In 0.5.14, Core truncated and clamped rowColumns.

Renderables and layout#

• RootRenderable.calculateLayout(): removed. Layout runs in the native frame step. Read getLayout() after renderOnce() or await renderer.idle().
• Renderable.getLayoutNode() and the protected yogaNode: removed. Use layout properties, setMeasureProvider(), invalidateIntrinsicSize(), and getLayout(). Renderables cannot use Display.Contents. The standalone Yoga API remains.
• render(), updateLayout(), updateFromLayout(), canReuseRenderCommandList(), and the RenderCommand type: removed. Override renderSelf(buffer, deltaTime), or use the renderBefore and renderAfter paint hooks. In a subclass of TextBufferRenderable or EditBufferRenderable, the override has one parameter: renderSelf(buffer).
• Protected _x, _y, _widthValue, _heightValue, _childrenInZIndexOrder, _getVisibleChildren(), _hasVisibleChildFilter(), and getScissorRect(): removed. Use x, y, width, height, screenX, and screenY. For child culling, use the viewportCulling option of ScrollBox.
• Protected renderCursor() of edit buffer renderables: removed. Use the cursor options.
• Protected updateViewportOffset(): TextRenderable no longer calls it when it scrolls or resizes. Native code applies the viewport.
• Protected color fields of ASCIIFontRenderable: now hold RGBA values.
• Custom RenderContext: must now implement nativeScene, requestAnimationFrame(), and cancelAnimationFrame().
• Paint hooks (renderBefore, renderSelf, and renderAfter): now receive a recording buffer. buffers, withBuffers(), getRealCharBytes(), and getSpanLines() throw in a hook. Draw into a buffer that you own and compose it, or use a post-process function. A buffered: true custom renderable is different: its hooks receive its own frame buffer.
• Changes made in a paint hook: a layout, position, visibility, child, or zIndex change takes effect in the next frame. Color and text changes paint in the same frame.
• on("resized") and on("layout-changed"): now throw on a renderable that is not the root. These listeners never ran in 0.5.14. Use onSizeChange.
• Geometry after destroy(): x, y, screenX, screenY, width, and height of a renderable that is not selectable return 0 or the styled size, not the last layout. Read them before you destroy the renderable.
• RenderContext.getLifecyclePasses(): now contains only renderables whose lifecycle pass is active.
• Box customBorderChars: wide, combining, or control characters now throw.

Buffers#

• OptimizedBuffer.create(width, height, widthMethod, options): now requires options.owner. Pass renderer.nativeScene or a ResourceContext.
• buffer.buffers: works only in a post-process function. Use buffer.withBuffers(callback) elsewhere.
• Drawing into renderer.nextRenderBuffer: works only in a post-process function. renderer.currentRenderBuffer does not accept drawing. In 0.5.14, frame callbacks could draw into nextRenderBuffer, for example with ThreeCliRenderer.drawScene(). Draw into a FrameBufferRenderable instead.
• encodeUnicode(text): now returns { data } and never null. Its char values are opaque tokens for drawChar() on a buffer with the same owner. A tab encodes as two one-cell spaces.
• buffer.ptr and getNativeId(): removed. Keep the buffer object. buffer.id is only a label.
• Drawing methods: now throw RangeError for fractional, NaN, or infinite coordinates and sizes. Round them first.
• drawText() and box titles: now throw RangeError for text larger than 64 KiB of UTF-8.
• pushOpacity() and color-matrix strength: a non-finite value now throws.
• Composing a buffer into itself now throws. setRespectAlpha() on a renderer buffer throws.
• setCell(), setCellWithAlphaBlending(), drawChar(), and drawText(): now reject attribute bits 8 to 31. Pass only text attributes. Use the styled-text link() helper for hyperlinks.

Text and editing#

• SyntaxStyle.create(), fromStyles(styles), and fromTheme(theme): now create(owner), fromStyles(styles, owner), and fromTheme(theme, owner). Pass renderer.nativeScene, or a ResourceContext for standalone use.
• TextBuffer.create(widthMethod) and EditBuffer.create(widthMethod): now create(widthMethod, owner).
• .ptr on TextBuffer, TextBufferView, EditBuffer, EditorView, and SyntaxStyle: removed. Their constructors take Context handles. Use the create() factories.
• EditBuffer.setText(), insertText(), and replaceText(), the same Textarea and Input methods, Textarea initialValue, Input.value, and the placeholder of both: now throw for control characters other than tab, carriage return, and line feed. Remove them first. Paste handlers remove them.
• TextBuffer.loadFile(): now rejects invalid UTF-8.
• Text buffer and text view offsets: must be integers. Other values throw RangeError.
• Highlight priority above 255 or hlRef above 65535: now throws. In 0.5.14, the value wrapped.
• Color getters of text, text table, ASCII font, Markdown, Diff, line number, and QR code renderables, and the SyntaxStyle style getters: now return copies. Change a color through its setter. ASCIIFont.color returns an RGBA.

Resources and native bindings#

• Minimum Bun version: now 1.3.14 (was 1.3.0), the tested minimum. Bun 1.3.0 to 1.3.3 convert some FFI pointer arguments to wrong addresses. Bun 1.3.4 to 1.3.6 can crash after a Worker exits. Bun 1.3.7 intermittently hangs while it loads modules.
• Clipboard class: removed. Use renderer.copyToClipboardOSC52() and clearClipboardOSC52(), or createClipboard() with createHostClipboard() and createRendererClipboardAdapter(renderer).
• Native resources: each resource now belongs to one owner Context. Resources from different owners cannot be used together. Drawing a NativeImage into a renderer copies it into the renderer’s Context.
• Images that ImageRenderable loads: belong to the renderer’s Context and throw after renderer.destroy(). To keep an image, load it yourself, for example with NativeImage.load(), and pass it as source.
• getAllocatorStats(): does not count Context memory. getArenaAllocatedBytes() always returns 0. Use process.memoryUsage().rss for total memory.
• Handle types RendererHandle, OptimizedBufferHandle, TextBufferHandle, TextBufferViewHandle, EditBufferHandle, EditorViewHandle, SyntaxStyleHandle, EventSinkHandle, NativeRenderableHandle, EmbeddedTerminalHandle, NativeMeasureTargetHandle, NativeMeasureTargetKind, NativeRenderOperationResult, and NativeRendererCreateOptions: removed. Use the Context*Handle types, SessionHandle, and SceneNodeHandle. ImageHandle is now an alias of ContextImageHandle.
• Pointer-based RenderLib methods, such as createRenderer, createOptimizedBuffer, bufferDrawText, setUseThread, and nativeRenderableSetMeasureTarget: removed. Use the public classes. Standalone Yoga nodes measure only with JavaScript measure functions.
• Standalone Yoga: Config.free() now throws while nodes from that config remain. Invalid arguments, such as an out-of-range child index or enum value, throw YogaError. Measure and dirtied functions must return synchronously and must not change Yoga nodes. See Yoga API.

SSH#

• @opentui/ssh session.write(): can now throw OutputPressureError or RangeError. cols and rows hold the requested size until the renderer attaches. onClose runs at logical close, before the renderer finishes closing.

Native libraries#

• Legacy native exports, such as createRenderer and bufferDrawText: removed. Use the ot_* C ABI in opentui.h. See C.
• Zig GraphemePool.alloc(), GraphemePool.allocUnowned(), and LinkPool.alloc(): replaced by acquire(). It copies the bytes and returns an ID that holds one reference. Call decref() to release it. alloc() returned an ID with no references, and allocUnowned() did not copy.
• Zig GraphemePool.freeUnreferenced() and the global pools (initGlobalPool(), initGlobalPoolWithOptions(), deinitGlobalPool(), initGlobalLinkPool(), and deinitGlobalLinkPool()): removed. Use explicit pools or opentui.Context. See Zig.
• Zig UnifiedTextBuffer.setStyledText() and StyledChunk: removed. Use replaceOwnedStyledText() with OwnedStyledChunk. clear() and reset() can now return errors.
• Zig CliRenderer.dumpBuffers() and dumpOutputBuffer(): removed.