Shell Core

Interfaces

Interfaces

TerminalSession

Properties:

PropertyTypeRequiredDescription
idstringYes
titlestringYes
activebooleanYes
createdAtDateYes

TerminalSize

Properties:

PropertyTypeRequiredDescription
colsnumberYes
rowsnumberYes

ITerminalAdapter

Platform-agnostic terminal adapter interface. Implementations handle platform-specific I/O (Electron IPC, WebSocket, etc.)

TerminalProps

Properties:

PropertyTypeRequiredDescription
adapterITerminalAdapterYes
onTitleChange((title: string) => void) | undefinedNo
themeITheme | undefinedNo

TerminalTabsProps

Properties:

PropertyTypeRequiredDescription
createAdapter() => ITerminalAdapterYes
onSessionsChange((sessions: TerminalSession[]) => void) | undefinedNo

TerminalThemePreset

Properties:

PropertyTypeRequiredDescription
idstringYes
namestringYes
descriptionstringYes
themeIThemeYes

UseTerminalThemeReturn

Properties:

PropertyTypeRequiredDescription
themeIThemeYesCurrent xterm.js theme object
themeIdstringYesCurrent preset ID
presetTerminalThemePresetYesCurrent preset metadata
presetsreadonly TerminalThemePreset[]YesAll available presets
setThemeId(id: string) => voidYesSet theme by preset ID
Previous
API Reference