gespenst API - v0.1.0
    Preparing search index...

    Module index

    GespenstTerminal

    Browser terminal combining Ghostty VT state, worker isolation, rendering, DOM input, and PTY streams.

    ThemeValidationError

    Error thrown when a theme contains an unsupported or malformed color.

    BrowserTerminal

    High-level browser terminal API.

    RendererInfo

    Selected rendering implementation and shaping strategy.

    TerminalAddon

    Extension activated against a browser terminal and disposed with it.

    TerminalBufferChangeEvent

    Notification that consumers of BrowserTerminal.readBuffer must refresh their data.

    TerminalConnection

    Active connection between terminal input/output and a transport.

    TerminalConnectionOptions

    Backpressure and cancellation policy for a terminal transport.

    TerminalFontFace

    Font face loaded into the document and terminal worker.

    TerminalFontOptions

    Complete font metrics configuration for the browser renderer.

    TerminalOptions

    Options used to create a browser terminal.

    TerminalTransport

    Bidirectional byte streams connecting a terminal to a PTY or remote shell.

    BrowserTerminalEventMap

    Event payloads emitted by a browser terminal.

    PaletteGenerator

    Function that completes a 256-color palette from base colors and explicit indices.

    RendererBackend

    Concrete renderer backend selected at runtime.

    RendererPreference

    Renderer requested by an application, including automatic capability selection.

    TerminalBufferChangeReason

    Operation that changed retained terminal text or its physical row layout.

    TerminalConnectionStatus

    Lifecycle state of a terminal transport connection.

    ANSI_COLOR_NAMES

    Ordered xterm-compatible names for ANSI palette entries 0 through 15.

    DEFAULT_THEME

    Default terminal theme used when individual colors are not supplied.

    KeyModifiers

    Bit flags accepted by key and pointer input APIs.

    TERMINAL_PROTOCOL_VERSION

    Version of the internal main-thread/worker message protocol.

    cloneTerminalTheme

    Returns a detached theme patch suitable for storing or exposing publicly.

    createTerminal

    Creates and asynchronously initializes a browser terminal.

    mergeTerminalTheme

    Merges a theme patch without mutating either input.

    parseTerminalColor

    Parses a color accepted by the portable Gespenst theme API.

    preloadGhostty

    Compiles and caches the Ghostty WASM module without creating a terminal.

    resolveTerminalTheme

    Resolves defaults, validates colors, and produces a complete palette.

    terminalColorToCss

    Serializes a terminal color as a portable CSS rgba() value.

    CellColor → CellColor
    ClipboardContent → ClipboardContent
    ClipboardLocation → ClipboardLocation
    ClipboardPasteRequest → ClipboardPasteRequest
    ClipboardPasteResult → ClipboardPasteResult
    ClipboardProtocolOptions → ClipboardProtocolOptions
    ClipboardWriteRequest → ClipboardWriteRequest
    CoreTerminalOptions → CoreTerminalOptions
    Disposable → Disposable
    GHOSTTY_BUILD → GHOSTTY_BUILD
    GhosttyBuildMetadata → GhosttyBuildMetadata
    InputSource → InputSource
    KeyAction → KeyAction
    KeyInput → KeyInput
    MouseAction → MouseAction
    MouseButton → MouseButton
    PointerInput → PointerInput
    ProgressState → ProgressState
    RenderCell → RenderCell
    RenderColor → RenderColor
    RenderColors → RenderColors
    RenderCursor → RenderCursor
    RenderFrame → RenderFrame
    RenderRow → RenderRow
    ResolvedTerminalTheme → ResolvedTerminalTheme
    RgbaColor → RgbaColor
    RgbColor → RgbColor
    TerminalBufferRange → TerminalBufferRange
    TerminalBufferRow → TerminalBufferRow
    TerminalBufferSnapshot → TerminalBufferSnapshot
    TerminalBufferState → TerminalBufferState
    TerminalColor → TerminalColor
    TerminalCursorAttributes → TerminalCursorAttributes
    TerminalEventMap → TerminalEventMap
    TerminalGeometry → TerminalGeometry
    TerminalInputEvent → TerminalInputEvent
    TerminalModeState → TerminalModeState
    TerminalTheme → TerminalTheme
    TerminalViewportChangeEvent → TerminalViewportChangeEvent
    ViewportSnapshot → ViewportSnapshot