Skip to main content

Function: TerminalBlock()

TerminalBlock(options?: object): TerminalBlockElement

Terminal block component with macOS-style window controls and line-by-line interactive focus.

Parameters​

ParameterTypeDescription
options{ align?: Align; blur?: number; brightness?: number; className?: string; color?: string; customPositioned?: boolean; enterDelay?: number; enterDuration?: number; exitDelay?: number; exitDuration?: number; height?: Size; id?: string; interactive?: boolean; lines?: readonly string[]; onActivate?: () => void; onDeactivate?: () => void; onMount?: () => void; onUnmount?: () => void; opacity?: number; origin?: ElementAnchor; position?: Position; rotation?: number; scale?: number; size?: Size; style?: Properties<0 | string & object, string & object>; theme?: Partial<ThemeConfig>; title?: string; width?: Size; x?: PositionCoord; y?: PositionCoord; }-
options.align?Align-
options.blur?numberBlur in virtual pixels (default: 0).
options.brightness?numberBrightness multiplier (default: 1).
options.className?stringAdditional CSS class name.
options.color?stringForeground CSS color (default: component/theme color).
options.customPositioned?booleanWhether this element manages its own CSS transform / positioning (disables stage translate3d).
options.enterDelay?numberDelay in seconds before entering scene transition begins.
options.enterDuration?numberDuration in seconds for entering scene transition.
options.exitDelay?numberDelay in seconds before exiting scene transition begins.
options.exitDuration?numberDuration in seconds for exiting scene transition.
options.height?SizeHeight in stage units or CSS length (default: content size).
options.id?string-
options.interactive?booleanWhether clicking or dragging lines focuses them interactively (default: true).
options.lines?readonly string[]Command-line output lines to display.
options.onActivate?() => void-
options.onDeactivate?() => void-
options.onMount?() => void-
options.onUnmount?() => void-
options.opacity?numberWhole-element opacity from 0 to 1 (default: 1).
options.origin?ElementAnchorWhich point of the element sits on its coordinate (default: "top-left").
options.position?Position-
options.rotation?numberRotation in degrees (default: 0).
options.scale?numberScale multiplier (default: 1).
options.size?SizeBoth dimensions in stage units or CSS length (default: unset).
options.style?Properties<0 | string & object, string & object>-
options.theme?Partial<ThemeConfig>-
options.title?stringWindow title bar label (default: "bash - 80x24").
options.width?SizeWidth in stage units or CSS length (default: content size).
options.x?PositionCoordHorizontal position in stage units (default: 0).
options.y?PositionCoordVertical position in stage units (default: 0).

Returns​

TerminalBlockElement