Interface: LiveTerminalOptions

Configuration options for the LiveTerminal component.

Extends

• ElementOptions

Properties

Property	Type	Description
align?	Align	-
autoFocus?	boolean	Whether the terminal takes keyboard focus on scene entry. Default: false.
blur?	number	Blur in virtual pixels (default: 0).
brightness?	number	Brightness multiplier (default: 1).
className?	string	-
color?	string	Foreground CSS color (default: component/theme color).
customPositioned?	boolean	Whether this element manages its own CSS transform / positioning (disables stage translate3d).
cwd?	string	Working directory for the shell, relative to the project root. Default: project root.
enterDelay?	number	Delay in seconds before entering scene transition begins.
enterDuration?	number	Duration in seconds for entering scene transition.
env?	Record<string, string>	Environment variables passed to the shell process (e.g. { PS1: "$ " }).
exitDelay?	number	Delay in seconds before exiting scene transition begins.
exitDuration?	number	Duration in seconds for exiting scene transition.
fontSize?	number	Font size in layout pixels before viewport scaling. Default: theme code size (1.25rem × stage scale).
height?	Size	Height in stage units or CSS length (default: content size).
id?	string	-
interactive?	boolean	Whether keystrokes typed into the terminal reach the process. Default: true.
onActivate?	() => void	-
onDeactivate?	() => void	-
onMount?	() => void	-
onUnmount?	() => void	-
opacity?	number	Whole-element opacity from 0 to 1 (default: 1).
origin?	ElementAnchor	Which point of the element sits on its coordinate (default: "top-left").
position?	Position	-
restartButton?	boolean	Whether the window header offers a button that starts a fresh session. Default: false.
rotation?	number	Rotation in degrees (default: 0).
rows?	number	Terminal rows. Default: fit to height (44 stage units by default).
scale?	number	Scale multiplier (default: 1).
shell?	string[]	Shell command and arguments. Default: the user's login shell. Example: ["bash", "--norc", "--noprofile"].
size?	Size	Both dimensions in stage units or CSS length (default: unset).
style?	Properties<0 | string & object, string & object>	-
theme?	Partial<ThemeConfig>	-
title?	string	Header label. Default: "shell".
transcript?	string[]	Fallback transcript shown when the terminal server is unavailable. Default: none.
width?	Size	Width in stage units or CSS length (default: content size).
x?	PositionCoord	Horizontal position in stage units (default: 0).
y?	PositionCoord	Vertical position in stage units (default: 0).