Feedback

TerminalFrame

Frame a consumer-owned real PTY with terminal chrome, connection status, reload handling, and character-cell resize reporting.

import { TerminalFrame } from '@lostgradient/cinder/terminal-frame';
terminalptyshell
01

Overview

TerminalFrame supplies chrome, connection state, recovery UI, and character-cell resize reporting around a consumer-owned real PTY renderer. It does not implement a terminal emulator or own a transport. Resize callbacks receive { cols, rows }.

Use TerminalOutput for read-only ANSI streams. Use TerminalFrame when the child content is an interactive terminal implementation whose backend needs { cols, rows } resize updates.

svelte 
<TerminalFrame title="Build shell" status="connected" onDimensionsChange={resizePty}>
  <PtyRenderer />
</TerminalFrame>
Live preview

Build shell

connected
$ bun run build
Build complete.
02

When to use

Use when
  • Hosting a real interactive terminal implementation that needs consistent chrome and resize dimensions.
Avoid when
  • Rendering a read-only stream — use TerminalOutput.
03

Examples

Basic terminal frame

Frame a connected terminal surface with status chrome.

04

Props

Props for terminal-frame
Name
Type
Default
Description
title required text
status 'connecting' | 'connected' | 'disconnected' | 'error' 'connecting'
error text
onReloadRequest () => void
onDimensionsChange (dimensions: TerminalFrameDimensions) => void
columnWidth number 8
rowHeight number 18
children required snippet