Something went wrong. Try again.
Ghostty for the web with xterm.js API compatibility
Something went wrong. Try again.
5.5 kB · 195 lines
TypeScript
at menu
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196/** * xterm.js-compatible interfaces */
export interface ITerminalOptions { cols?: number; // Default: 80 rows?: number; // Default: 24 cursorBlink?: boolean; // Default: false cursorStyle?: 'block' | 'underline' | 'bar'; theme?: ITheme; scrollback?: number; // Default: 1000 fontSize?: number; // Default: 15 fontFamily?: string; // Default: 'monospace' allowTransparency?: boolean; wasmPath?: string; // Optional: custom WASM path (auto-detected by default)
// Phase 1 additions convertEol?: boolean; // Convert \n to \r\n (default: false) disableStdin?: boolean; // Disable keyboard input (default: false)}
export interface ITheme { foreground?: string; background?: string; cursor?: string; cursorAccent?: string; selectionBackground?: string; selectionForeground?: string;
// ANSI colors (0-15) black?: string; red?: string; green?: string; yellow?: string; blue?: string; magenta?: string; cyan?: string; white?: string; brightBlack?: string; brightRed?: string; brightGreen?: string; brightYellow?: string; brightBlue?: string; brightMagenta?: string; brightCyan?: string; brightWhite?: string;}
export interface IDisposable { dispose(): void;}
export type IEvent<T> = (listener: (arg: T) => void) => IDisposable;
export interface ITerminalAddon { activate(terminal: ITerminalCore): void; dispose(): void;}
export interface ITerminalCore { cols: number; rows: number; element?: HTMLElement; textarea?: HTMLTextAreaElement;}
/** * Buffer range for selection coordinates */export interface IBufferRange { start: { x: number; y: number }; end: { x: number; y: number };}
/** * Keyboard event with key and DOM event */export interface IKeyEvent { key: string; domEvent: KeyboardEvent;}
// ============================================================================// Buffer API Interfaces (xterm.js compatibility)// ============================================================================
/** * Top-level buffer API namespace * Provides access to active, normal, and alternate screen buffers */export interface IBufferNamespace { /** The currently active buffer (normal or alternate) */ readonly active: IBuffer; /** The normal buffer (primary screen) */ readonly normal: IBuffer; /** The alternate buffer (used by full-screen apps like vim) */ readonly alternate: IBuffer;
/** Event fired when buffer changes (normal ↔ alternate) */ readonly onBufferChange: IEvent<IBuffer>;}
/** * A terminal buffer (normal or alternate screen) */export interface IBuffer { /** Buffer type: 'normal' or 'alternate' */ readonly type: 'normal' | 'alternate'; /** Cursor X position (0-indexed) */ readonly cursorX: number; /** Cursor Y position (0-indexed, relative to viewport) */ readonly cursorY: number; /** Viewport Y position (scroll offset, 0 = bottom of scrollback) */ readonly viewportY: number; /** Base Y position (always 0 for normal buffer, may vary for alternate) */ readonly baseY: number; /** Total buffer length (rows + scrollback for normal, just rows for alternate) */ readonly length: number;
/** * Get a line from the buffer * @param y Line index (0 = top of scrollback for normal buffer) * @returns Line object or undefined if out of bounds */ getLine(y: number): IBufferLine | undefined;
/** * Get the null cell (used for empty/uninitialized cells) */ getNullCell(): IBufferCell;}
/** * A single line in the buffer */export interface IBufferLine { /** Length of the line (in columns) */ readonly length: number; /** Whether this line wraps to the next line */ readonly isWrapped: boolean;
/** * Get a cell from this line * @param x Column index (0-indexed) * @returns Cell object or undefined if out of bounds */ getCell(x: number): IBufferCell | undefined;
/** * Translate the line to a string * @param trimRight Whether to trim trailing whitespace (default: false) * @param startColumn Start column (default: 0) * @param endColumn End column (default: length) * @returns String representation of the line */ translateToString(trimRight?: boolean, startColumn?: number, endColumn?: number): string;}
/** * A single cell in the buffer */export interface IBufferCell { /** Character(s) in this cell (may be empty, single char, or emoji) */ getChars(): string; /** Unicode codepoint (0 for null cell) */ getCode(): number; /** Character width (1 = normal, 2 = wide/emoji, 0 = combining) */ getWidth(): number;
/** Foreground color index (for palette colors) or -1 for RGB */ getFgColorMode(): number; /** Background color index (for palette colors) or -1 for RGB */ getBgColorMode(): number; /** Foreground RGB color (or 0 for default) */ getFgColor(): number; /** Background RGB color (or 0 for default) */ getBgColor(): number;
/** Whether cell has bold style */ isBold(): number; /** Whether cell has italic style */ isItalic(): number; /** Whether cell has underline style */ isUnderline(): number; /** Whether cell has strikethrough style */ isStrikethrough(): number; /** Whether cell has blink style */ isBlink(): number; /** Whether cell has inverse video style */ isInverse(): number; /** Whether cell has invisible style */ isInvisible(): number; /** Whether cell has faint/dim style */ isFaint(): number;}