@opentui/core

Every export of @opentui/core in the main-branch source, from its type declarations. A version names the release that added an export after the module's first release.

Functions#

function acquireSessionBufferLease(lib: RenderLib, context: NativeContextHandle, session: SessionHandle, which: SessionBuffer, frame?: NativeSceneFrameRequest | null): NativeContextBufferLease

Added in 0.6.0Overview

function addDefaultParsers(parsers: FiletypeParserOptions[]): void

Tree-sitter

function ansi256IndexToRgb(index: number): RGBTriplet

Colors

function applyAsciiArt(buffer: OptimizedBuffer, ramp?: string, fgColor?: { r: number; g: number; b: number; }, bgColor?: { r: number; g: number; b: number; }): void

Post-processing effects

function applyBrightness(buffer: OptimizedBuffer, brightness?: number, cellMask?: Float32Array): void

Post-processing effects

function applyChromaticAberration(buffer: OptimizedBuffer, strength?: number): void

Post-processing effects

function applyGain(buffer: OptimizedBuffer, gain?: number, cellMask?: Float32Array): void

Post-processing effects

function applyInvert(buffer: OptimizedBuffer, strength?: number): void

Post-processing effects

function applyNoise(buffer: OptimizedBuffer, strength?: number): void

Post-processing effects

function applySaturation(buffer: OptimizedBuffer, cellMask?: Float32Array, strength?: number): void

Post-processing effects

function applyScanlines(buffer: OptimizedBuffer, strength?: number, step?: number): void

Post-processing effects

function ASCIIFont(props?: ASCIIFontOptions, ...children: VChild[]): ProxiedVNode<typeof ASCIIFontRenderable>

Renderables

function attributesWithLink(baseAttributes: number, linkId: number): number

Text and terminal cells

function borderCharsToArray(chars: BorderCharacters): Uint32Array

Box

function Box(props?: BoxOptions, ...children: VChild[]): ProxiedVNode<typeof BoxRenderable>

Renderables

function buildKittyKeyboardFlags(config: KittyKeyboardOptions | null | undefined): number

Keyboard input

function buildTerminalPaletteSignature(colors?: TerminalColors | null): string

Terminal capabilities

function clearEnvCache(): void

Environment variables

function Code(props: CodeOptions, ...children: VChild[]): ProxiedVNode<typeof CodeRenderable>

Renderables

function convertGlobalToLocalSelection(globalSelection: Selection | null, localX: number, localY: number): LocalSelectionBounds | null

Interaction

function convertThemeToStyles(theme: ThemeTokenStyle[]): Record<string, StyleDefinition>

Tree-sitter

function coordinateToCharacterIndex(x: number, text: string, font?: keyof typeof fonts): number

ASCIIFont

function createCliRenderer(config?: CliRendererConfig): Promise<CliRenderer>

Renderer

function createCoreSlotRegistry<TSlotName extends string, TContext extends PluginContext = PluginContext, TData extends object = Record<string, unknown>>(renderer: CliRenderer, context: TContext, options?: SlotRegistryOptions): CoreSlotRegistry<TSlotName, TContext, TData>

Core

function createExtmarksController(editBuffer: EditBuffer, editorView: EditorView): ExtmarksController

Editing buffers and views

function createIcyStreamDemuxer(options: IcyStreamDemuxerOptions): AudioStreamDemuxer<AudioStreamMetadata>

Added in 0.4.4Streaming audio

function createMarkdownCodeBlockRenderer(renderers: MarkdownCodeBlockRendererMap): MarkdownOptions["renderNode"]

Added in 0.3.2Markdown

function createSlotRegistry<TNode, TSlots extends object, TContext extends PluginContext = PluginContext>(renderer: CliRenderer, key: string, context: TContext, options?: SlotRegistryOptions): SlotRegistry<TNode, TSlots, TContext>

Overview

function createTerminalPalette(options: TerminalPaletteOptions): TerminalPaletteDetector

Terminal capabilities

function createTextAttributes({ bold, italic, underline, dim, blink, inverse, reverse, hidden, strikethrough, }?: { bold?: boolean; italic?: boolean; underline?: boolean; dim?: boolean; blink?: boolean; inverse?: boolean; reverse?: boolean; hidden?: boolean; strikethrough?: boolean; }): number

Text and terminal cells

function createTimeline(options?: TimelineOptions, renderer?: CliRenderer): Timeline

Animation and Timeline

function decodePasteBytes(bytes: Uint8Array): string

Keyboard input

function delegate<ConstructorType extends RenderableConstructor<any>, TargetMap extends Record<keyof InstanceType<ConstructorType>, string>, const Mapping extends Partial<TargetMap>>(mapping: ValidateShape<Mapping, TargetMap>, vnode: ProxiedVNode<ConstructorType>): ProxiedVNode<ConstructorType>function delegate<ConstructorType extends RenderableConstructor<any>, const Mapping extends DelegateMap<InstanceType<ConstructorType>>>(mapping: ValidateShape<Mapping, string>, vnode: VNode & { type: ConstructorType; }): VNodefunction delegate<Factory extends InstantiateFn<any>, InnerNode extends InferNode<Factory>, TargetMap extends Record<keyof InnerNode, string>, const Mapping extends Partial<TargetMap>>(mapping: ValidateShape<Mapping, TargetMap>, vnode: Factory): Renderable

Renderables

function destroyTreeSitterClient(): Promise<void>

Added in 0.4.0Tree-sitter

function detectLinks(chunks: TextChunk[], context: { content: string; highlights: SimpleHighlight[]; sourceRanges?: Array<{ start: number; end: number; }>; }): TextChunk[]

Text and terminal cells

function extToFiletype(extension: string): string | undefined

Tree-sitter

function FrameBuffer(props: FrameBufferOptions, ...children: VChild[]): ProxiedVNode<typeof FrameBufferRenderable>

Renderables

function generateEnvColored(): string

Environment variables

function generateEnvMarkdown(): string

Environment variables

function Generic(props?: VRenderableOptions, ...children: VChild[]): ProxiedVNode<typeof VRenderable>

Renderables

function getBaseAttributes(attr: number): number

Text and terminal cells

function getBorderFromSides(sides: BorderSidesConfig): boolean | BorderSides[]

Box

function getBorderSides(border: boolean | BorderSides[]): BorderSidesConfig

Box

function getCharacterPositions(text: string, font?: keyof typeof fonts): number[]

ASCIIFont

function getDataPaths(): DataPathsManager

Application data paths

function getLinkId(attributes: number): number

Text and terminal cells

function getTimelineEngine(renderer: CliRenderer): TimelineEngine

Added in 0.6.0Animation and Timeline

function getTreeSitterClient(): TreeSitterClient

Tree-sitter

function h<P>(type: Construct<P>, props?: P, ...children: VChild[]): VNode<P> | ProxiedVNode<any>function h<P>(type: FunctionalConstruct<P>, props?: P, ...children: VChild[]): VNode<P>function h<TCtor extends RenderableConstructor<any>>(type: TCtor, props?: TCtor extends RenderableConstructor<infer P> ? P : never, ...children: VChild[]): ProxiedVNode<TCtor>

Renderables

function hastToStyledText(hast: HASTNode, syntaxStyle: SyntaxStyle): StyledText

Text and terminal cells

function hexToRgb(hex: string): RGBA

Colors

function hsvToRgb(h: number, s: number, v: number): RGBA

Colors

function imageInfo(data: Uint8Array | ArrayBuffer, options?: ImageCreateOptions): ImageInfo

Added in 0.5.0Native images

function infoStringToFiletype(infoString: string): string | undefined

Tree-sitter

function Input(props?: InputRenderableOptions, ...children: VChild[]): ProxiedVNode<typeof InputRenderable>

Renderables

function instantiate<NodeType extends VNode | Renderable>(ctx: RenderContext, node: NodeType): InstantiateFn<NodeType>

Renderables

function isEditBufferRenderable(obj: unknown): obj is EditBufferRenderable

Editing buffers and views

function isRenderable(obj: any): obj is Renderable

Renderables

function isStyledText(obj: any): obj is StyledText

Text and terminal cells

function isTextNodeRenderable(obj: any): obj is TextNodeRenderable

Text and terminal cells

function isValidBorderStyle(value: unknown): value is BorderStyle

Box

function isVNode(node: any): node is VNode

Renderables

function maybeMakeRenderable(ctx: RenderContext, node: Renderable | VNode<any, any[]> | unknown): Renderable | null

Renderables

function measureText({ text, font }: { text: string; font?: keyof typeof fonts; }): { width: number; height: number; }

ASCIIFont

function normalizeColorValue(value: ColorInput | null | undefined): NormalizedColorValue | null

Colors

function normalizeIndexedColorIndex(index: number): number

Colors

function normalizeTerminalPalette(colors?: TerminalColors | null): NormalizedTerminalPalette

Terminal capabilities

function parseAlign(value: string | null | undefined): Align

Layout

function parseAlignItems(value: string | null | undefined): Align

Layout

function parseBorderStyle(value: unknown, fallback?: BorderStyle): BorderStyle

Box

function parseBoxSizing(value: string): BoxSizing

Layout

function parseColor(color: ColorInput): RGBA

Colors

function parseDimension(value: string): Dimension

Layout

function parseDirection(value: string): Direction

Layout

function parseDisplay(value: string): Display

Layout

function parseEdge(value: string): Edge

Layout

function parseFlexDirection(value: string | null | undefined): FlexDirection

Layout

function parseGutter(value: string): Gutter

Layout

function parseJustify(value: string | null | undefined): Justify

Layout

function parseLogLevel(value: string): LogLevel

Layout

function parseMeasureMode(value: string): MeasureMode

Layout

function parseOverflow(value: string | null | undefined): Overflow

Layout

function parsePositionType(value: string | null | undefined): PositionType

Layout

function parseUnit(value: string): Unit

Layout

function parseWrap(value: string | null | undefined): Wrap

Layout

function pathToFiletype(path: string): string | undefined

Tree-sitter

function registerCorePlugin<TSlotName extends string, TContext extends PluginContext = PluginContext, TData extends object = Record<string, unknown>>(registry: CoreSlotRegistry<TSlotName, TContext, TData>, plugin: CorePlugin<TSlotName, TContext, TData>): () => void

Core

function registerEnvVar(config: EnvVarConfig): void

Environment variables

function renderFontToFrameBuffer(buffer: OptimizedBuffer, { text, x, y, color, backgroundColor, font, }: { text: string; x?: number; y?: number; color?: ColorInput | ColorInput[]; backgroundColor?: ColorInput; font?: keyof typeof fonts; }): { width: number; height: number; }

ASCIIFont

function resolveBundledFilePath(key: string, loadBundledFile: () => Promise<FileImportModule>, fallbackPath: FilePathFallback, metaUrl: string, options?: ResolveBundledFilePathOptions): Promise<string>

Added in 0.4.5Standalone executables

function resolveCoreSlot<TSlotName extends string, K extends TSlotName, TContext extends PluginContext = PluginContext, TData extends object = Record<string, unknown>>(registry: CoreSlotRegistry<TSlotName, TContext, TData>, slot: K): Array<CoreResolvedSlotRenderer<TContext, TData>>

Core

function resolveImageRenderProtocol(requested: ImageRenderProtocol, capabilities: TerminalCapabilities | null, hasResolution: boolean): Exclude<ImageRenderProtocol, "auto">

Added in 0.5.0Image

function resolveRenderLib(): RenderLib

Overview

function rgbToHex(rgb: RGBA): string

Colors

function ScrollBox(props?: ScrollBoxOptions, ...children: VChild[]): ProxiedVNode<typeof ScrollBoxRenderable>

Renderables

function Select(props?: SelectRenderableOptions, ...children: VChild[]): ProxiedVNode<typeof SelectRenderable>

Renderables

function setRenderLibPath(libPath: string): void

Overview

function setupAudio(options?: AudioSetupOptions): Audio

Audio

function stringToStyledText(content: string): StyledText

Text and terminal cells

function stripAnsiSequences(text: string): string

Keyboard input

function t(strings: TemplateStringsArray, ...values: StylableInput[]): StyledText

Text and terminal cells

function TabSelect(props?: TabSelectRenderableOptions, ...children: VChild[]): ProxiedVNode<typeof TabSelectRenderable>

Renderables

function Text(props?: TextOptions & { content?: any; }, ...children: VChild[] | TextNodeRenderable[]): ProxiedVNode<typeof TextRenderable>

Renderables

function treeSitterToStyledText(content: string, filetype: string, syntaxStyle: SyntaxStyle, client: TreeSitterClient, options?: TreeSitterToStyledTextOptions): Promise<StyledText>

Tree-sitter

function treeSitterToTextChunks(content: string, highlights: SimpleHighlight[], syntaxStyle: SyntaxStyle, options?: TextChunkOptions): TextChunk[]

Tree-sitter

function visualizeRenderableTree(renderable: Renderable, maxDepth?: number): void

Renderables

function wrapWithDelegates<T extends InstanceType<RenderableConstructor>>(instance: T, delegateMap: Record<string, string> | undefined): T

Renderables

Classes#

class ArrowRenderable extends Renderableconstructor ArrowRenderable(ctx: RenderContext, options: ArrowOptions)

ScrollBar

• property ArrowRenderable.arrowChars: ArrowOptions["arrowChars"]
• property ArrowRenderable.attributes: number
• property ArrowRenderable.backgroundColor: RGBA
• property ArrowRenderable.direction: "up" | "down" | "left" | "right"
• property ArrowRenderable.foregroundColor: RGBA
• protected method ArrowRenderable.renderSelf(buffer: OptimizedBuffer): void
• static readonly property ArrowRenderable.nativeIntegration: NativeRenderableIntegration0.6.0

class ASCIIFontRenderable extends FrameBufferRenderableconstructor ASCIIFontRenderable(ctx: RenderContext, options: ASCIIFontOptions)

ASCIIFont

• method ASCIIFontRenderable.getSelectedText(): string
• method ASCIIFontRenderable.hasSelection(): boolean
• method ASCIIFontRenderable.onSelectionChanged(selection: Selection | null): boolean
• method ASCIIFontRenderable.shouldStartSelection(x: number, y: number): boolean
• property ASCIIFontRenderable.backgroundColor: ColorInput
• property ASCIIFontRenderable.color: ColorInput | ColorInput[]
• property ASCIIFontRenderable.font: keyof typeof fonts
• property ASCIIFontRenderable.selectable: boolean
• property ASCIIFontRenderable.text: string
• protected method ASCIIFontRenderable.onResize(width: number, height: number): void
• protected property ASCIIFontRenderable._backgroundColor: RGBA
• protected property ASCIIFontRenderable._color: RGBA | RGBA[]
• protected property ASCIIFontRenderable._font: keyof typeof fonts
• protected property ASCIIFontRenderable._selectionBg: RGBA | undefined
• protected property ASCIIFontRenderable._selectionFg: RGBA | undefined
• protected property ASCIIFontRenderable._text: string
• protected property ASCIIFontRenderable.lastLocalSelection: LocalSelectionBounds | null
• static protected readonly property ASCIIFontRenderable._defaultOptions: { text: string; font: "tiny"; color: string; backgroundColor: string; selectionBg: undefined; selectionFg: undefined; selectable: true; }

class ASCIIFontSelectionHelperconstructor ASCIIFontSelectionHelper(getText: () => string, getFont: () => keyof typeof fonts)

Interaction

• method ASCIIFontSelectionHelper.getSelection(): { start: number; end: number; } | null
• method ASCIIFontSelectionHelper.hasSelection(): boolean
• method ASCIIFontSelectionHelper.onLocalSelectionChanged(localSelection: LocalSelectionBounds | null, width: number, height: number): boolean
• method ASCIIFontSelectionHelper.shouldStartSelection(localX: number, localY: number, width: number, height: number): boolean

class Audio extends EventEmitter<AudioEvents>

Audio

• method Audio.clearCaptureDeviceSelection(): void0.5.0
• method Audio.clearPlaybackDeviceSelection(): void
• method Audio.disableTap(): boolean
• method Audio.dispose(): void
• method Audio.enableTap(capacityFrames?: number): boolean
• method Audio.getCaptureStats(): AudioCaptureStats | null0.5.0
• method Audio.getStats(): AudioStats | null
• method Audio.group(name: string): AudioGroup | null
• method Audio.isCapturing(): boolean0.5.0
• method Audio.isMixerStarted(): boolean
• method Audio.isStarted(): boolean
• method Audio.listCaptureDevices(): AudioCaptureDevice[] | null0.5.0
• method Audio.listPlaybackDevices(): AudioPlaybackDevice[] | null
• method Audio.loadSound(data: Uint8Array | ArrayBuffer): AudioSound | null
• method Audio.loadSoundFile(filePath: string): Promise<AudioSound | null>
• method Audio.mixFrames(frameCount: number, channels?: number): Float32Array | null
• method Audio.openCapture(options?: AudioCaptureStreamOptions): Promise<AudioCaptureStream>0.5.0
• method Audio.play(sound: AudioSound, options?: AudioPlayOptions): AudioVoice | null
• method Audio.playStream<M = AudioStreamMetadata>(source: AudioStreamBody, options?: AudioStreamBodyOptions<M>): Promise<AudioStream<M>>0.4.4
• method Audio.playStreamSource<I, M = AudioStreamMetadata>(connector: AudioStreamConnector<I>, options?: AudioStreamSourceOptions<I, M>): Promise<AudioStream<M>>0.4.4
• method Audio.playStreamUrl(source: string | URL, options?: AudioStreamUrlOptions): Promise<AudioStream<AudioStreamMetadata>>0.4.4
• method Audio.readCaptureFrames(frameCount: number): AudioCaptureReadResult | null0.5.0
• method Audio.readTapFrames(frameCount: number, channels?: number): { frames: Float32Array; framesRead: number; } | null
• method Audio.recordToFile(filePath: string, options?: AudioRecordToFileOptions): Promise<AudioRecorder>0.5.0
• method Audio.selectCaptureDevice(index: number): boolean0.5.0
• method Audio.selectPlaybackDevice(index: number): boolean
• method Audio.setGroupVolume(group: AudioGroup, volume: number): boolean
• method Audio.setMasterVolume(volume: number): boolean
• method Audio.setVoiceGroup(voice: AudioVoice, group: AudioGroup): boolean
• method Audio.start(options?: AudioStartOptions): boolean
• method Audio.startCapture(options?: AudioCaptureOptions): boolean0.5.0
• method Audio.startMixer(): boolean
• method Audio.stop(): boolean
• method Audio.stopCapture(): boolean0.5.0
• method Audio.stopVoice(voice: AudioVoice): boolean
• method Audio.unloadSound(sound: AudioSound): boolean
• readonly property Audio.sampleRate: number0.4.4
• static method Audio.create(options?: AudioSetupOptions): Audio

class AudioCaptureStream extends EventEmitter<AudioCaptureStreamEvents>

Added in 0.5.0Audio capture

• method AudioCaptureStream.dispose(): void0.5.0
• method AudioCaptureStream.getStats(): AudioCaptureStreamStats0.5.0
• method AudioCaptureStream.stop(): void0.5.0
• readonly property AudioCaptureStream.channels: number0.5.0
• readonly property AudioCaptureStream.chunkFrames: number0.5.0
• readonly property AudioCaptureStream.closed: Promise<void>0.5.0
• readonly property AudioCaptureStream.readable: ReadableStream<Float32Array>0.5.0
• readonly property AudioCaptureStream.sampleRate: number0.5.0
• readonly property AudioCaptureStream.state: AudioCaptureStreamState0.5.0

class AudioCaptureStreamError extends Errorconstructor AudioCaptureStreamError(message: string, context: AudioCaptureStreamErrorContext, cause?: unknown)

Added in 0.5.0Audio capture

• readonly property AudioCaptureStreamError.context: AudioCaptureStreamErrorContext0.5.0

class AudioInitializationError extends Errorconstructor AudioInitializationError(action: AudioInitializationAction, message: string, status?: number, cause?: unknown)

Added in 0.4.4Audio

• readonly property AudioInitializationError.action: AudioInitializationAction0.4.4
• readonly property AudioInitializationError.status?: number0.4.4

class AudioRecorder extends EventEmitter<AudioRecorderEvents>

Added in 0.5.0Audio capture

• method AudioRecorder.dispose(): void0.5.0
• method AudioRecorder.getStats(): AudioRecorderStats0.5.0
• method AudioRecorder.stop(): void0.5.0
• readonly property AudioRecorder.channels: number0.5.0
• readonly property AudioRecorder.closed: Promise<void>0.5.0
• readonly property AudioRecorder.filePath: string0.5.0
• readonly property AudioRecorder.format: "wav"0.5.0
• readonly property AudioRecorder.sampleRate: number0.5.0
• readonly property AudioRecorder.state: AudioRecorderState0.5.0

class AudioRecorderError extends Errorconstructor AudioRecorderError(message: string, context: AudioRecorderErrorContext, cause?: unknown)

Added in 0.5.0Audio capture

• readonly property AudioRecorderError.context: AudioRecorderErrorContext0.5.0

class AudioStream<M = AudioStreamMetadata> extends EventEmitter<AudioStreamEvents<M>>

Added in 0.4.4Streaming audio

• method AudioStream.dispose(): void0.4.4
• method AudioStream.getMetadata(): M | null0.4.4
• method AudioStream.getStats(): AudioStreamStats0.4.4
• method AudioStream.setGroup(groupId: number): boolean0.4.4
• method AudioStream.setPan(pan: number): boolean0.4.4
• method AudioStream.setVolume(volume: number): boolean0.4.4
• readonly property AudioStream.closed: Promise<void>0.4.4
• readonly property AudioStream.format: AudioStreamFormat0.4.4
• readonly property AudioStream.state: AudioStreamState0.4.4

class AudioStreamError extends Errorconstructor AudioStreamError(message: string, context: AudioStreamErrorContext, cause?: unknown)

Added in 0.4.4Streaming audio

• readonly property AudioStreamError.context: AudioStreamErrorContext0.4.4

abstract class BaseRenderable extends EventEmitterconstructor BaseRenderable(options: BaseRenderableOptions)

Renderables

• abstract method BaseRenderable.add(obj: BaseRenderable | unknown, index?: number): number
• abstract method BaseRenderable.findDescendantById(id: string): BaseRenderable | undefined
• abstract method BaseRenderable.getChildren(): BaseRenderable[]
• abstract method BaseRenderable.getChildrenCount(): number
• abstract method BaseRenderable.getRenderable(id: string): BaseRenderable | undefined
• abstract method BaseRenderable.insertBefore(obj: BaseRenderable | unknown, anchor: BaseRenderable | unknown): void
• abstract method BaseRenderable.remove(child: BaseRenderable): void
• abstract method BaseRenderable.requestRender(): void
• method BaseRenderable.destroy(): void
• method BaseRenderable.destroyRecursively(): void
• property BaseRenderable.[BrandedRenderable]: boolean
• property BaseRenderable.id: string
• property BaseRenderable.parent: BaseRenderable | null
• property BaseRenderable.visible: boolean
• protected method BaseRenderable.markClean(): void
• protected method BaseRenderable.markDirty(): void
• protected property BaseRenderable._dirty: boolean
• protected property BaseRenderable._id: string
• protected property BaseRenderable._visible: boolean
• readonly property BaseRenderable.isDirty: boolean
• readonly property BaseRenderable.num: number

class BloomEffectconstructor BloomEffect(threshold?: number, strength?: number, radius?: number)

Post-processing effects

• method BloomEffect.apply(buffer: OptimizedBuffer): void
• property BloomEffect.radius: number
• property BloomEffect.strength: number
• property BloomEffect.threshold: number

class BoxRenderable extends Renderableconstructor BoxRenderable(ctx: RenderContext, options: BoxOptions)

Box

• property BoxRenderable.backgroundColor: RGBA
• property BoxRenderable.border: boolean | BorderSides[]
• property BoxRenderable.borderColor: RGBA
• property BoxRenderable.borderStyle: BorderStyle
• property BoxRenderable.bottomTitle: string | undefined
• property BoxRenderable.bottomTitleAlignment: "left" | "center" | "right"
• property BoxRenderable.columnGap: number | `${number}%` | undefined
• property BoxRenderable.customBorderChars: BorderCharacters | undefined
• property BoxRenderable.focusedBorderColor: RGBA
• property BoxRenderable.gap: number | `${number}%` | undefined
• property BoxRenderable.rowGap: number | `${number}%` | undefined
• property BoxRenderable.shouldFill: boolean
• property BoxRenderable.title: string | undefined
• property BoxRenderable.titleAlignment: "left" | "center" | "right"
• property BoxRenderable.titleColor: RGBA | undefined0.3.3
• protected method BoxRenderable.getNativeScenePaint(): NativeScenePaint0.6.0
• protected method BoxRenderable.renderSelf(buffer: OptimizedBuffer): void
• protected property BoxRenderable._backgroundColor: RGBA
• protected property BoxRenderable._border: boolean | BorderSides[]
• protected property BoxRenderable._borderColor: RGBA
• protected property BoxRenderable._borderStyle: BorderStyle
• protected property BoxRenderable._bottomTitle?: string
• protected property BoxRenderable._bottomTitleAlignment: "left" | "center" | "right"
• protected property BoxRenderable._customBorderChars?: Uint32Array
• protected property BoxRenderable._defaultOptions: { backgroundColor: string; borderStyle: "single"; border: false; borderColor: string; shouldFill: true; titleAlignment: "left"; bottomTitleAlignment: "left"; focusedBorderColor: string; }
• protected property BoxRenderable._focusedBorderColor: RGBA
• protected property BoxRenderable._title?: string
• protected property BoxRenderable._titleAlignment: "left" | "center" | "right"
• protected property BoxRenderable._titleColor?: RGBA0.3.3
• protected property BoxRenderable.borderSides: BorderSidesConfig
• static readonly property BoxRenderable.nativeIntegration: NativeRenderableIntegration0.6.0

class CliRenderer extends EventEmitter implements RenderContextconstructor CliRenderer(stdin: NodeJS.ReadStream, stdout: NodeJS.WriteStream, width: number, height: number, config?: CliRendererConfig)

Renderer

• method CliRenderer.addInputHandler(handler: (sequence: string) => boolean): void
• method CliRenderer.addPostProcessFn(processFn: (buffer: OptimizedBuffer, deltaTime: number) => void): void
• method CliRenderer.auto(): void
• method CliRenderer.blurRenderable(renderable: Renderable): void
• method CliRenderer.cancelAnimationFrame(handle: number): void0.6.0
• method CliRenderer.cancelKittyImageTransport(): void0.5.10
• method CliRenderer.clearClipboardOSC52(target?: ClipboardTarget): boolean
• method CliRenderer.clearFrameCallbacks(): void
• method CliRenderer.clearPaletteCache(): void
• method CliRenderer.clearPostProcessFns(): void
• method CliRenderer.clearSelection(): void
• method CliRenderer.configureDebugOverlay(options: { enabled?: boolean; corner?: DebugOverlayCorner; }): void
• method CliRenderer.copyToClipboardOSC52(text: string, target?: ClipboardTarget): boolean
• method CliRenderer.createScrollbackSurface(options?: ScrollbackSurfaceOptions): ScrollbackSurface
• method CliRenderer.destroy(): void
• method CliRenderer.disableKittyKeyboard(): void
• method CliRenderer.dropLive(): void
• method CliRenderer.dumpHitGrid(): void
• method CliRenderer.enableKittyKeyboard(flags?: number): void
• method CliRenderer.focusRenderable(renderable: Renderable): void
• method CliRenderer.getCursorState(): CursorState
• method CliRenderer.getDebugInputs(): Array<{ timestamp: string; sequence: string; }>
• method CliRenderer.getLifecyclePasses(): Set<Renderable>
• method CliRenderer.getLinkAt(x: number, y: number): string | null0.5.11
• method CliRenderer.getLinkIdAt(x: number, y: number): number0.5.11
• method CliRenderer.getNativeStats(): NativeRenderStats
• method CliRenderer.getPalette(options?: GetPaletteOptions): Promise<TerminalColors>
• method CliRenderer.getSchedulerState(): RendererSchedulerState
• method CliRenderer.getSelection(): Selection | null
• method CliRenderer.getSelectionContainer(): Renderable | null
• method CliRenderer.getStats(): CliRendererStats
• method CliRenderer.hasFrameCallback(callback: (deltaTime: number) => Promise<void>): boolean0.6.0
• method CliRenderer.hitTest(x: number, y: number): number
• method CliRenderer.idle(): Promise<void>
• method CliRenderer.intermediateRender(): void
• method CliRenderer.isOsc52Supported(): boolean
• method CliRenderer.pause(): void
• method CliRenderer.prependInputHandler(handler: (sequence: string) => boolean): void
• method CliRenderer.registerLifecyclePass(renderable: Renderable): void
• method CliRenderer.removeFrameCallback(callback: (deltaTime: number) => Promise<void>): void
• method CliRenderer.removeInputHandler(handler: (sequence: string) => boolean): void
• method CliRenderer.removePostProcessFn(processFn: (buffer: OptimizedBuffer, deltaTime: number) => void): void
• method CliRenderer.requestAnimationFrame(callback: FrameRequestCallback): number0.6.0
• method CliRenderer.requestLive(): void
• method CliRenderer.requestRender(): void
• method CliRenderer.requestResize(width: number, height: number): void0.6.0
• method CliRenderer.requestSelectionUpdate(): void
• method CliRenderer.resetSplitFooterForReplay(options?: SplitFooterReplayResetOptions): void0.3.1
• method CliRenderer.resetStats(): void
• method CliRenderer.resetTerminalBgColor(): void
• method CliRenderer.resize(width: number, height: number): void
• method CliRenderer.resume(): Promise<void>
• method CliRenderer.setBackgroundColor(color: ColorInput): void
• method CliRenderer.setCursorColor(color: RGBA): void
• method CliRenderer.setCursorPosition(x: number, y: number, visible?: boolean): void
• method CliRenderer.setCursorStyle(options: CursorStyleOptions): void
• method CliRenderer.setFrameCallback(callback: (deltaTime: number) => Promise<void>): void
• method CliRenderer.setGatherStats(enabled: boolean): void
• method CliRenderer.setMemorySnapshotInterval(interval: number): void
• method CliRenderer.setMousePointer(style: MousePointerStyle): void
• method CliRenderer.setTerminalTitle(title: string): void
• method CliRenderer.setupTerminal(): Promise<void>
• method CliRenderer.start(): void
• method CliRenderer.startSelection(renderable: Renderable, x: number, y: number, behavior?: SelectionBehavior): void
• method CliRenderer.stop(): void
• method CliRenderer.subscribeOsc(handler: (sequence: string) => void): () => void
• method CliRenderer.suspend(): Promise<void>
• method CliRenderer.toggleDebugOverlay(): void
• method CliRenderer.triggerNotification(message: string, title?: string): boolean
• method CliRenderer.unregisterLifecyclePass(renderable: Renderable): void
• method CliRenderer.updateSelection(currentRenderable: Renderable | undefined, x: number, y: number, options?: { finishDragging?: boolean; }): void
• method CliRenderer.waitForThemeMode(timeoutMs?: number): Promise<ThemeMode | null>
• method CliRenderer.writeToScrollback(write: ScrollbackWriter): void
• property CliRenderer.consoleMode: ConsoleMode
• property CliRenderer.currentRenderBuffer: OptimizedBuffer
• property CliRenderer.debugOverlay: { enabled: any; corner: DebugOverlayCorner; }
• property CliRenderer.externalOutputMode: ExternalOutputMode
• property CliRenderer.footerHeight: number
• property CliRenderer.height: number
• property CliRenderer.kittyImageTransport: KittyImageTransport0.5.10
• property CliRenderer.maxFps: number
• property CliRenderer.nextRenderBuffer: OptimizedBuffer
• property CliRenderer.screenMode: ScreenMode
• property CliRenderer.stdin: NodeJS.ReadStream
• property CliRenderer.targetFps: number
• property CliRenderer.useKittyKeyboard: boolean
• property CliRenderer.useMouse: boolean
• property CliRenderer.width: number
• readonly property CliRenderer.capabilities: TerminalCapabilities | null
• readonly property CliRenderer.clock: Clock0.6.0
• readonly property CliRenderer.closed: Promise<void>0.6.0
• readonly property CliRenderer.console: TerminalConsole
• readonly property CliRenderer.controlState: RendererControlState
• readonly property CliRenderer.currentControlState: string
• readonly property CliRenderer.currentFocusedEditor: EditBufferRenderable | null
• readonly property CliRenderer.currentFocusedRenderable: Renderable | null
• readonly property CliRenderer.frameId: number
• readonly property CliRenderer.hasSelection: boolean
• readonly property CliRenderer.isDestroyed: boolean
• readonly property CliRenderer.isRunning: boolean
• readonly property CliRenderer.keyInput: KeyHandler
• readonly property CliRenderer.kittyImageTransportStatus: KittyImageTransportStatus0.5.10
• readonly property CliRenderer.lastSceneTimeMs: number0.6.0
• readonly property CliRenderer.liveRequestCount: number
• readonly property CliRenderer.nativeScene: NativeScene0.6.0
• readonly property CliRenderer.paletteDetectionStatus: "idle" | "detecting" | "cached"
• readonly property CliRenderer.resolution: PixelResolution | null
• readonly property CliRenderer.root: RootRenderable
• readonly property CliRenderer.terminalHeight: number
• readonly property CliRenderer.terminalWidth: number
• readonly property CliRenderer.themeMode: ThemeMode | null
• readonly property CliRenderer.widthMethod: WidthMethod
• static method CliRenderer.setCursorColor(renderer: CliRenderer, color: RGBA): void
• static method CliRenderer.setCursorPosition(renderer: CliRenderer, x: number, y: number, visible?: boolean): void
• static method CliRenderer.setCursorStyle(renderer: CliRenderer, options: CursorStyleOptions): void

class CloudsEffectconstructor CloudsEffect(scale?: number, speed?: number, density?: number, darkness?: number)

Post-processing effects

• method CloudsEffect.apply(buffer: OptimizedBuffer, deltaTime: number): void
• property CloudsEffect.darkness: number
• property CloudsEffect.density: number
• property CloudsEffect.scale: number
• property CloudsEffect.speed: number

class CodeRenderable extends TextBufferRenderableconstructor CodeRenderable(ctx: RenderContext, options: CodeOptions)

Code

• method CodeRenderable.getLineHighlights(lineIdx: number): Highlight[]
• method CodeRenderable.getLineSources(startLine: number, lineCount: number): number[]0.5.11
• method CodeRenderable.updateStreamingPreview(content: string, initialStyledText: StyledText): void0.5.11
• property CodeRenderable.baseHighlight: string | undefined
• property CodeRenderable.conceal: boolean
• property CodeRenderable.content: string
• property CodeRenderable.drawUnstyledText: boolean
• property CodeRenderable.filetype: string | undefined
• property CodeRenderable.initialStyledText: StyledText | undefined0.3.4
• property CodeRenderable.onChunks: OnChunksCallback | undefined
• property CodeRenderable.onHighlight: OnHighlightCallback | undefined
• property CodeRenderable.streaming: boolean
• property CodeRenderable.syntaxStyle: SyntaxStyle
• property CodeRenderable.treeSitterClient: TreeSitterClient
• property CodeRenderable.wrapMode: "none" | "char" | "word"0.3.2
• protected method CodeRenderable.destroyOwnedResources(): void0.6.0
• protected method CodeRenderable.onResize(width: number, height: number): void0.3.2
• protected method CodeRenderable.onUpdate(deltaTime: number): void0.6.0
• protected method CodeRenderable.renderSelf(buffer: OptimizedBuffer): void
• protected method CodeRenderable.transformChunks(chunks: TextChunk[], context: ChunkRenderContext): Promise<TextChunk[]>
• protected method CodeRenderable.updateTextInfo(): void0.3.2
• protected property CodeRenderable._contentDefaultOptions: { content: string; conceal: true; drawUnstyledText: true; streaming: false; }
• readonly property CodeRenderable.highlightingDone: Promise<void>
• readonly property CodeRenderable.isHighlighting: boolean
• readonly property CodeRenderable.lineInfo: LineInfo0.3.2
• static readonly property CodeRenderable.nativeIntegration: NativeRenderableIntegration0.6.0

class CRTRollingBarEffectconstructor CRTRollingBarEffect(speed?: number, height?: number, intensity?: number, fadeDistance?: number)

Post-processing effects

• method CRTRollingBarEffect.apply(buffer: OptimizedBuffer, deltaTime: number): void
• property CRTRollingBarEffect.fadeDistance: number
• property CRTRollingBarEffect.height: number
• property CRTRollingBarEffect.intensity: number
• property CRTRollingBarEffect.speed: number

class DataPathsManager extends EventEmitter<DataPathsEvents>constructor DataPathsManager()

Application data paths

• method DataPathsManager.toObject(): DataPaths
• property DataPathsManager.appName: string
• readonly property DataPathsManager.globalConfigFile: string
• readonly property DataPathsManager.globalConfigPath: string
• readonly property DataPathsManager.globalDataPath: string
• readonly property DataPathsManager.localConfigFile: string

class DiffRenderable extends Renderableconstructor DiffRenderable(ctx: RenderContext, options: DiffRenderableOptions)

Diff

• method DiffRenderable.clearAllLineColors(): void
• method DiffRenderable.clearHighlightLines(startLine: number, endLine: number): void
• method DiffRenderable.clearLineColor(line: number): void
• method DiffRenderable.destroyRecursively(): void
• method DiffRenderable.getHunkRowOffsets(): number[]0.3.2
• method DiffRenderable.highlightLines(startLine: number, endLine: number, color: string | RGBA | LineColorConfig): void
• method DiffRenderable.setLineColor(line: number, color: string | RGBA | LineColorConfig): void
• method DiffRenderable.setLineColors(lineColors: Map<number, string | RGBA | LineColorConfig>): void
• property DiffRenderable.addedBg: RGBA
• property DiffRenderable.addedContentBg: RGBA | null
• property DiffRenderable.addedLineNumberBg: RGBA
• property DiffRenderable.addedSignColor: RGBA
• property DiffRenderable.conceal: boolean
• property DiffRenderable.contextBg: RGBA
• property DiffRenderable.contextContentBg: RGBA | null
• property DiffRenderable.diff: string
• property DiffRenderable.fg: RGBA | undefined
• property DiffRenderable.filetype: string | undefined
• property DiffRenderable.lineNumberBg: RGBA
• property DiffRenderable.lineNumberFg: RGBA
• property DiffRenderable.removedBg: RGBA
• property DiffRenderable.removedContentBg: RGBA | null
• property DiffRenderable.removedLineNumberBg: RGBA
• property DiffRenderable.removedSignColor: RGBA
• property DiffRenderable.selectionBg: RGBA | undefined
• property DiffRenderable.selectionFg: RGBA | undefined
• property DiffRenderable.showLineNumbers: boolean
• property DiffRenderable.syncScroll: boolean
• property DiffRenderable.syntaxStyle: SyntaxStyle | undefined
• property DiffRenderable.view: "unified" | "split"
• property DiffRenderable.wrapMode: "word" | "char" | "none" | undefined
• protected method DiffRenderable.destroySelf(): void0.5.15
• protected method DiffRenderable.onMouseEvent(event: MouseEvent): void
• static readonly property DiffRenderable.nativeIntegration: NativeRenderableIntegration0.6.0

class DistortionEffectconstructor DistortionEffect(options?: Partial<DistortionEffect>)

Post-processing effects

• method DistortionEffect.apply(buffer: OptimizedBuffer, deltaTime: number): void
• property DistortionEffect.colorGlitchChance: number
• property DistortionEffect.glitchChancePerSecond: number
• property DistortionEffect.maxGlitchDuration: number
• property DistortionEffect.maxGlitchLines: number
• property DistortionEffect.maxShiftAmount: number
• property DistortionEffect.minGlitchDuration: number
• property DistortionEffect.shiftFlipRatio: number

class EditBuffer extends EventEmitterconstructor EditBuffer(lib: RenderLib, handle: ContextEditBufferHandle, source: NativeResourceOwner)

Editing buffers and views

• method EditBuffer.addHighlight(lineIdx: number, highlight: Highlight): void
• method EditBuffer.addHighlightByCharRange(highlight: Highlight): void
• method EditBuffer.canRedo(): boolean
• method EditBuffer.canUndo(): boolean
• method EditBuffer.clear(): void
• method EditBuffer.clearAllHighlights(): void
• method EditBuffer.clearHistory(): void
• method EditBuffer.clearLineHighlights(lineIdx: number): void
• method EditBuffer.debugLogRope(): void
• method EditBuffer.deleteChar(): void
• method EditBuffer.deleteCharBackward(): void
• method EditBuffer.deleteLine(): void
• method EditBuffer.deleteRange(startLine: number, startCol: number, endLine: number, endCol: number): void
• method EditBuffer.destroy(): void
• method EditBuffer.getCursorPosition(): LogicalCursor
• method EditBuffer.getEOL(): LogicalCursor
• method EditBuffer.getLineCount(): number
• method EditBuffer.getLineHighlights(lineIdx: number): Array<Highlight>
• method EditBuffer.getLineStartOffset(row: number): number
• method EditBuffer.getNextWordBoundary(): LogicalCursor
• method EditBuffer.getPrevWordBoundary(): LogicalCursor
• method EditBuffer.getSyntaxStyle(): SyntaxStyle | null
• method EditBuffer.getTabWidth(): number0.5.9
• method EditBuffer.getText(): string
• method EditBuffer.getTextRange(startOffset: number, endOffset: number): string
• method EditBuffer.getTextRangeByCoords(startRow: number, startCol: number, endRow: number, endCol: number): string
• method EditBuffer.gotoLine(line: number): void
• method EditBuffer.insertChar(char: string): void
• method EditBuffer.insertText(text: string): void
• method EditBuffer.moveCursorDown(): void
• method EditBuffer.moveCursorLeft(): void
• method EditBuffer.moveCursorRight(): void
• method EditBuffer.moveCursorUp(): void
• method EditBuffer.newLine(): void
• method EditBuffer.offsetToPosition(offset: number): { row: number; col: number; } | null
• method EditBuffer.positionToOffset(row: number, col: number): number
• method EditBuffer.redo(): string | null
• method EditBuffer.removeHighlightsByRef(hlRef: number): void
• method EditBuffer.replaceText(text: string): void
• method EditBuffer.replaceTextOwned(text: string): void
• method EditBuffer.resetDefaults(): void
• method EditBuffer.runMutation<T>(operation: () => T): T0.6.0
• method EditBuffer.setCursor(line: number, col: number): void
• method EditBuffer.setCursorByOffset(offset: number): void
• method EditBuffer.setCursorToLineCol(line: number, col: number): void
• method EditBuffer.setDefaultAttributes(attributes: number | null): void
• method EditBuffer.setDefaultBg(bg: RGBA | null): void
• method EditBuffer.setDefaultFg(fg: RGBA | null): void
• method EditBuffer.setSyntaxStyle(style: SyntaxStyle | null): void
• method EditBuffer.setTabWidth(width: number): void0.5.9
• method EditBuffer.setText(text: string): void
• method EditBuffer.setTextOwned(text: string): void
• method EditBuffer.undo(): string | null
• readonly property EditBuffer.id: number
• static method EditBuffer.create(widthMethod: WidthMethod, source: NativeResourceOwner): EditBuffer

abstract class EditBufferRenderable extends Renderable implements LineInfoProviderconstructor EditBufferRenderable(ctx: RenderContext, options: EditBufferOptions)

Editing buffers and views

• method EditBufferRenderable.addHighlight(lineIdx: number, highlight: Highlight): void
• method EditBufferRenderable.addHighlightByCharRange(highlight: Highlight): void
• method EditBufferRenderable.blur(): void
• method EditBufferRenderable.clear(): void
• method EditBufferRenderable.clearAllHighlights(): void
• method EditBufferRenderable.clearLineHighlights(lineIdx: number): void
• method EditBufferRenderable.clearSelection(): boolean
• method EditBufferRenderable.deleteChar(): boolean
• method EditBufferRenderable.deleteCharBackward(): boolean
• method EditBufferRenderable.deleteLine(): boolean
• method EditBufferRenderable.deleteRange(startLine: number, startCol: number, endLine: number, endCol: number): void
• method EditBufferRenderable.deleteSelection(): boolean
• method EditBufferRenderable.deleteToLineEnd(): boolean
• method EditBufferRenderable.deleteToLineStart(): boolean
• method EditBufferRenderable.deleteWordBackward(): boolean
• method EditBufferRenderable.deleteWordForward(): boolean
• method EditBufferRenderable.focus(): void
• method EditBufferRenderable.getLineHighlights(lineIdx: number): Array<Highlight>
• method EditBufferRenderable.getSelectedText(): string
• method EditBufferRenderable.getSelection(): { start: number; end: number; } | null
• method EditBufferRenderable.getTextRange(startOffset: number, endOffset: number): string
• method EditBufferRenderable.getTextRangeByCoords(startRow: number, startCol: number, endRow: number, endCol: number): string
• method EditBufferRenderable.gotoBufferEnd(options?: { select?: boolean; }): boolean
• method EditBufferRenderable.gotoBufferHome(options?: { select?: boolean; }): boolean
• method EditBufferRenderable.gotoLine(line: number): void
• method EditBufferRenderable.gotoLineEnd(options?: { select?: boolean; }): boolean
• method EditBufferRenderable.gotoLineHome(options?: { select?: boolean; }): boolean
• method EditBufferRenderable.gotoLineStart(): void
• method EditBufferRenderable.gotoLineTextEnd(): void
• method EditBufferRenderable.gotoVisualLineEnd(options?: { select?: boolean; }): boolean
• method EditBufferRenderable.gotoVisualLineHome(options?: { select?: boolean; }): boolean
• method EditBufferRenderable.hasSelection(): boolean
• method EditBufferRenderable.insertChar(char: string): void
• method EditBufferRenderable.insertText(text: string): void
• method EditBufferRenderable.moveCursorDown(options?: { select?: boolean; }): boolean
• method EditBufferRenderable.moveCursorLeft(options?: { select?: boolean; }): boolean
• method EditBufferRenderable.moveCursorRight(options?: { select?: boolean; }): boolean
• method EditBufferRenderable.moveCursorUp(options?: { select?: boolean; }): boolean
• method EditBufferRenderable.moveWordBackward(options?: { select?: boolean; }): boolean
• method EditBufferRenderable.moveWordForward(options?: { select?: boolean; }): boolean
• method EditBufferRenderable.newLine(): boolean
• method EditBufferRenderable.onSelectionChanged(selection: Selection | null): boolean
• method EditBufferRenderable.redo(): boolean
• method EditBufferRenderable.removeHighlightsByRef(hlRef: number): void
• method EditBufferRenderable.replaceText(text: string): void
• method EditBufferRenderable.selectAll(): boolean
• method EditBufferRenderable.setCursor(row: number, col: number): void
• method EditBufferRenderable.setSelection(start: number, end: number): void
• method EditBufferRenderable.setSelectionInclusive(start: number, end: number): void
• method EditBufferRenderable.setText(text: string): void
• method EditBufferRenderable.shouldStartSelection(x: number, y: number): boolean
• method EditBufferRenderable.undo(): boolean
• property EditBufferRenderable.[BrandedEditBufferRenderable]: boolean
• property EditBufferRenderable.attributes: number
• property EditBufferRenderable.backgroundColor: RGBA
• property EditBufferRenderable.cursorColor: RGBA
• property EditBufferRenderable.cursorOffset: number
• property EditBufferRenderable.cursorStyle: CursorStyleOptions
• property EditBufferRenderable.onContentChange: ((event: ContentChangeEvent) => void) | undefined
• property EditBufferRenderable.onCursorChange: ((event: CursorChangeEvent) => void) | undefined
• property EditBufferRenderable.scrollSpeed: number
• property EditBufferRenderable.selectionBg: RGBA | undefined
• property EditBufferRenderable.selectionFg: RGBA | undefined
• property EditBufferRenderable.selectionOccupancy: SelectionOccupancy0.5.7
• property EditBufferRenderable.showCursor: boolean
• property EditBufferRenderable.syntaxStyle: SyntaxStyle | null
• property EditBufferRenderable.tabIndicator: string | number | undefined
• property EditBufferRenderable.tabIndicatorColor: RGBA | undefined
• property EditBufferRenderable.textColor: RGBA
• property EditBufferRenderable.traits: EditorTraits
• property EditBufferRenderable.wrapMode: "none" | "char" | "word"
• protected method EditBufferRenderable.destroyOwnedResources(): void0.6.0
• protected method EditBufferRenderable.handleScroll(event: any): void
• protected method EditBufferRenderable.onMouseEvent(event: any): void
• protected method EditBufferRenderable.onResize(width: number, height: number): void
• protected method EditBufferRenderable.onUpdate(deltaTime: number): void
• protected method EditBufferRenderable.refreshLocalSelection(): boolean
• protected method EditBufferRenderable.renderSelf(buffer: OptimizedBuffer): void
• protected method EditBufferRenderable.updateSelectionForMovement(shiftPressed: boolean, isBeforeMovement: boolean): void
• protected property EditBufferRenderable._backgroundColor: RGBA
• protected property EditBufferRenderable._cursorColor: RGBA
• protected property EditBufferRenderable._cursorStyle: CursorStyleOptions
• protected property EditBufferRenderable._defaultAttributes: number
• protected property EditBufferRenderable._defaultOptions: { textColor: RGBA; backgroundColor: string; selectionBg: undefined; selectionFg: undefined; selectable: true; attributes: number; wrapMode: "none" | "char" | "word"; scrollMargin: number; scrollSpeed: number; showCursor: true; cursorColor: RGBA; cursorStyle: { style: "block"; blinking: true; }; tabIndicator: undefined; tabIndicatorColor: undefined; }
• protected property EditBufferRenderable._scrollMargin: number
• protected property EditBufferRenderable._selectionBg: RGBA | undefined
• protected property EditBufferRenderable._selectionFg: RGBA | undefined
• protected property EditBufferRenderable._showCursor: boolean
• protected property EditBufferRenderable._tabIndicator?: string | number
• protected property EditBufferRenderable._tabIndicatorColor?: RGBA
• protected property EditBufferRenderable._textColor: RGBA
• protected property EditBufferRenderable._wrapMode: "none" | "char" | "word"
• protected property EditBufferRenderable.lastLocalSelection: LocalSelectionBounds | null
• readonly property EditBufferRenderable.cursorCharacterOffset: number | undefined
• readonly property EditBufferRenderable.editBuffer: EditBuffer
• readonly property EditBufferRenderable.editorView: EditorView
• readonly property EditBufferRenderable.lineCount: number
• readonly property EditBufferRenderable.lineInfo: LineInfo
• readonly property EditBufferRenderable.logicalCursor: LogicalCursor
• readonly property EditBufferRenderable.plainText: string
• readonly property EditBufferRenderable.scrollY: number
• readonly property EditBufferRenderable.virtualLineCount: number
• readonly property EditBufferRenderable.visualCursor: VisualCursor
• static protected readonly property EditBufferRenderable.defaultFocusable = true0.6.0
• static readonly property EditBufferRenderable.nativeIntegration: NativeRenderableIntegration0.6.0

class EditorViewconstructor EditorView(lib: RenderLib, handle: ContextEditorViewHandle, editBuffer: EditBuffer, source: NativeResourceOwner)

Editing buffers and views

• method EditorView.convertSelectionToCell(): boolean0.5.7
• method EditorView.deleteSelectedText(): void
• method EditorView.destroy(): void
• method EditorView.getCursor(): { row: number; col: number; }
• method EditorView.getEOL(): VisualCursor
• method EditorView.getLineInfo(): LineInfo
• method EditorView.getLogicalLineInfo(): LineInfo
• method EditorView.getNextWordBoundary(): VisualCursor
• method EditorView.getPrevWordBoundary(): VisualCursor
• method EditorView.getSelectedText(): string
• method EditorView.getSelection(): { start: number; end: number; } | null
• method EditorView.getSelectionOccupancy(): SelectionOccupancy0.5.7
• method EditorView.getText(): string
• method EditorView.getTotalVirtualLineCount(): number
• method EditorView.getViewport(): Viewport
• method EditorView.getVirtualLineCount(): number
• method EditorView.getVisualCursor(): VisualCursor
• method EditorView.getVisualEOL(): VisualCursor
• method EditorView.getVisualSOL(): VisualCursor
• method EditorView.gotoVisualLineEnd(): void0.5.7
• method EditorView.hasSelection(): boolean
• method EditorView.measureForDimensions(width: number, height: number): { lineCount: number; widthColsMax: number; } | null
• method EditorView.moveDownVisual(): void
• method EditorView.moveUpVisual(): void
• method EditorView.resetLocalSelection(): void
• method EditorView.resetSelection(): void
• method EditorView.setCursorByOffset(offset: number): void
• method EditorView.setLocalSelection(anchorX: number, anchorY: number, focusX: number, focusY: number, bgColor?: RGBA, fgColor?: RGBA, updateCursor?: boolean, followCursor?: boolean, behavior?: SelectionBehavior): boolean
• method EditorView.setPlaceholderStyledText(chunks: { text: string; fg?: RGBA; bg?: RGBA; attributes?: number; }[]): void
• method EditorView.setScrollMargin(margin: number): void
• method EditorView.setSelection(start: number, end: number, bgColor?: RGBA, fgColor?: RGBA): void
• method EditorView.setSelectionColors(bgColor?: RGBA, fgColor?: RGBA): void0.5.7
• method EditorView.setSelectionInclusive(start: number, end: number, bgColor?: RGBA, fgColor?: RGBA): void0.5.7
• method EditorView.setSelectionOccupancy(occupancy: SelectionOccupancy): void0.5.7
• method EditorView.setTabIndicator(indicator: string | number): void
• method EditorView.setTabIndicatorColor(color: RGBA): void
• method EditorView.setViewport(x: number, y: number, width: number, height: number, moveCursor?: boolean): void
• method EditorView.setViewportSize(width: number, height: number): void
• method EditorView.setWrapMode(mode: "none" | "char" | "word"): void
• method EditorView.updateLocalSelection(anchorX: number, anchorY: number, focusX: number, focusY: number, bgColor?: RGBA, fgColor?: RGBA, updateCursor?: boolean, followCursor?: boolean, behavior?: SelectionBehavior): boolean
• method EditorView.updateSelection(end: number, bgColor?: RGBA, fgColor?: RGBA): void
• readonly property EditorView.extmarks: any
• readonly property EditorView.isDestroyed: boolean0.5.12
• static method EditorView.create(editBuffer: EditBuffer, viewportWidth: number, viewportHeight: number): EditorView

class EmbeddedTerminalRenderable extends Renderableconstructor EmbeddedTerminalRenderable(ctx: RenderContext, options: EmbeddedTerminalOptions)

Added in 0.5.6Embedded terminal

• method EmbeddedTerminalRenderable.blur(): void0.5.6
• method EmbeddedTerminalRenderable.encodeKey(key: KeyEvent): Uint8Array0.5.6
• method EmbeddedTerminalRenderable.encodePaste(bytes: Uint8Array): Uint8Array0.5.6
• method EmbeddedTerminalRenderable.focus(): void0.5.6
• method EmbeddedTerminalRenderable.getSelectedText(): string0.5.6
• method EmbeddedTerminalRenderable.handleKeyPress(key: KeyEvent): boolean0.5.6
• method EmbeddedTerminalRenderable.handlePaste(event: PasteEvent): void0.5.6
• method EmbeddedTerminalRenderable.hasSelection(): boolean0.5.6
• method EmbeddedTerminalRenderable.invalidate(): void0.5.6
• method EmbeddedTerminalRenderable.onSelectionChanged(selection: Selection | null): boolean0.5.6
• method EmbeddedTerminalRenderable.screen(): EmbeddedTerminalScreen0.5.6
• method EmbeddedTerminalRenderable.shouldStartSelection(x: number, y: number): boolean0.5.6
• method EmbeddedTerminalRenderable.write(data: string | Uint8Array): void0.5.6
• property EmbeddedTerminalRenderable.onData: ((data: Uint8Array, source: EmbeddedTerminalDataSource) => void) | undefined0.5.6
• property EmbeddedTerminalRenderable.onScreenChange: (() => void) | undefined0.5.6
• property EmbeddedTerminalRenderable.onTerminalResize: ((cols: number, rows: number) => void) | undefined0.5.6
• property EmbeddedTerminalRenderable.selectable: boolean0.5.6
• property EmbeddedTerminalRenderable.transparentBackground: boolean0.5.12
• protected method EmbeddedTerminalRenderable._invokeNativePaint(buffer: OptimizedBuffer, deltaTime: number): void0.6.0
• protected method EmbeddedTerminalRenderable.destroySelf(): void0.5.6
• protected method EmbeddedTerminalRenderable.onRemove(): void0.5.6
• protected method EmbeddedTerminalRenderable.onResize(width: number, height: number): void0.5.6
• protected method EmbeddedTerminalRenderable.renderSelf(buffer: OptimizedBuffer): void0.5.6
• static readonly property EmbeddedTerminalRenderable.nativeIntegration: NativeRenderableIntegration0.6.0

class ExtmarksControllerconstructor ExtmarksController(editBuffer: EditBuffer, editorView: EditorView)

Editing buffers and views

• method ExtmarksController.adjustExtmarksAfterDeletion(deleteOffset: number, length: number, updateHighlights?: boolean): void
• method ExtmarksController.clear(): void
• method ExtmarksController.create(options: ExtmarkOptions): number
• method ExtmarksController.delete(id: number): boolean
• method ExtmarksController.destroy(): void
• method ExtmarksController.get(id: number): Extmark | null
• method ExtmarksController.getAll(): Extmark[]
• method ExtmarksController.getAllForTypeId(typeId: number): Extmark[]
• method ExtmarksController.getAtOffset(offset: number): Extmark[]
• method ExtmarksController.getMetadataFor(extmarkId: number): any
• method ExtmarksController.getTypeId(typeName: string): number | null
• method ExtmarksController.getTypeName(typeId: number): string | null
• method ExtmarksController.getVirtual(): Extmark[]
• method ExtmarksController.registerType(typeName: string): number

class FFIRenderLibconstructor FFIRenderLib(libPath?: string)

Added in 0.6.0Overview

• method FFIRenderLib.attachNativeSpanFeed(stream: Pointer): number0.6.0
• method FFIRenderLib.audioClearCaptureDeviceSelection(engine: AudioEngineHandle): void0.6.0
• method FFIRenderLib.audioClearPlaybackDeviceSelection(engine: AudioEngineHandle): void0.6.0
• method FFIRenderLib.audioCloseStream(engine: AudioEngineHandle, streamId: number, reason: NativeAudioStreamCloseReason): { status: number; stats: NativeAudioStreamStats | null; }0.6.0
• method FFIRenderLib.audioCreateGroup(engine: AudioEngineHandle, name: string): { status: number; groupId: number | null; }0.6.0
• method FFIRenderLib.audioCreateStream(engine: AudioEngineHandle, options: AudioStreamCreateOptions): { status: number; streamId: number | null; }0.6.0
• method FFIRenderLib.audioEnableTap(engine: AudioEngineHandle, enabled: boolean, capacityFrames: number): number0.6.0
• method FFIRenderLib.audioEndStream(engine: AudioEngineHandle, streamId: number): number0.6.0
• method FFIRenderLib.audioGetCaptureDeviceCount(engine: AudioEngineHandle): number0.6.0
• method FFIRenderLib.audioGetCaptureDeviceName(engine: AudioEngineHandle, index: number): string0.6.0
• method FFIRenderLib.audioGetCaptureStats(engine: AudioEngineHandle): { status: number; stats: NativeAudioCaptureStats | null; }0.6.0
• method FFIRenderLib.audioGetPlaybackDeviceCount(engine: AudioEngineHandle): number0.6.0
• method FFIRenderLib.audioGetPlaybackDeviceName(engine: AudioEngineHandle, index: number): string0.6.0
• method FFIRenderLib.audioGetStats(engine: AudioEngineHandle): AudioStats | null0.6.0
• method FFIRenderLib.audioGetStreamStats(engine: AudioEngineHandle, streamId: number): NativeAudioStreamStats | null0.6.0
• method FFIRenderLib.audioIsCaptureDeviceDefault(engine: AudioEngineHandle, index: number): boolean0.6.0
• method FFIRenderLib.audioIsCaptureRunning(engine: AudioEngineHandle): boolean0.6.0
• method FFIRenderLib.audioIsPlaybackDeviceDefault(engine: AudioEngineHandle, index: number): boolean0.6.0
• method FFIRenderLib.audioLoad(engine: AudioEngineHandle, data: Uint8Array): { status: number; soundId: number | null; }0.6.0
• method FFIRenderLib.audioMixToBuffer(engine: AudioEngineHandle, outBuffer: Float32Array, frameCount: number, channels: number): number0.6.0
• method FFIRenderLib.audioPlay(engine: AudioEngineHandle, soundId: number, options?: AudioVoiceOptions): { status: number; voiceId: number | null; }0.6.0
• method FFIRenderLib.audioReadCapture(engine: AudioEngineHandle, outBuffer: Float32Array, frameCount: number): { status: number; framesRead: number; }0.6.0
• method FFIRenderLib.audioReadTap(engine: AudioEngineHandle, outBuffer: Float32Array, frameCount: number, channels: number): { status: number; framesRead: number; }0.6.0
• method FFIRenderLib.audioRefreshCaptureDevices(engine: AudioEngineHandle): number0.6.0
• method FFIRenderLib.audioRefreshPlaybackDevices(engine: AudioEngineHandle): number0.6.0
• method FFIRenderLib.audioRestartStream(engine: AudioEngineHandle, streamId: number): number0.6.0
• method FFIRenderLib.audioSelectCaptureDevice(engine: AudioEngineHandle, index: number): number0.6.0
• method FFIRenderLib.audioSelectPlaybackDevice(engine: AudioEngineHandle, index: number): number0.6.0
• method FFIRenderLib.audioSetGroupVolume(engine: AudioEngineHandle, groupId: number, volume: number): number0.6.0
• method FFIRenderLib.audioSetMasterVolume(engine: AudioEngineHandle, volume: number): number0.6.0
• method FFIRenderLib.audioSetStreamGroup(engine: AudioEngineHandle, streamId: number, groupId: number): number0.6.0
• method FFIRenderLib.audioSetStreamPan(engine: AudioEngineHandle, streamId: number, pan: number): number0.6.0
• method FFIRenderLib.audioSetStreamVolume(engine: AudioEngineHandle, streamId: number, volume: number): number0.6.0
• method FFIRenderLib.audioSetVoiceGroup(engine: AudioEngineHandle, voiceId: number, groupId: number): number0.6.0
• method FFIRenderLib.audioStart(engine: AudioEngineHandle, options?: AudioStartOptions | null): number0.6.0
• method FFIRenderLib.audioStartCapture(engine: AudioEngineHandle, options: AudioStartOptions | undefined, channels: number, capacityFrames: number): number0.6.0
• method FFIRenderLib.audioStartMixer(engine: AudioEngineHandle): number0.6.0
• method FFIRenderLib.audioStop(engine: AudioEngineHandle): number0.6.0
• method FFIRenderLib.audioStopCapture(engine: AudioEngineHandle): number0.6.0
• method FFIRenderLib.audioStopVoice(engine: AudioEngineHandle, voiceId: number): number0.6.0
• method FFIRenderLib.audioUnload(engine: AudioEngineHandle, soundId: number): number0.6.0
• method FFIRenderLib.audioWriteStream(engine: AudioEngineHandle, streamId: number, data: Uint8Array): number0.6.0
• method FFIRenderLib.clipboardClearOperationStart(service: ClipboardServiceHandle, selection: number, timeoutMs: number): { status: NativeClipboardStartStatus; operation: ClipboardOperationHandle | null; }0.6.0
• method FFIRenderLib.clipboardOperationCancel(operation: ClipboardOperationHandle): NativeClipboardCancelStatus0.6.0
• method FFIRenderLib.clipboardOperationDestroy(operation: ClipboardOperationHandle): NativeClipboardDestroyStatus0.6.0
• method FFIRenderLib.clipboardOperationPoll(operation: ClipboardOperationHandle): NativeClipboardOperationStatus0.6.0
• method FFIRenderLib.clipboardOperationResultDataCopy(operation: ClipboardOperationHandle, output: Uint8Array): NativeClipboardCopyStatus0.6.0
• method FFIRenderLib.clipboardOperationResultDataLength(operation: ClipboardOperationHandle): { status: NativeClipboardCopyStatus; length: number; }0.6.0
• method FFIRenderLib.clipboardOperationResultDiagnosticCopy(operation: ClipboardOperationHandle, output: Uint8Array): NativeClipboardCopyStatus0.6.0
• method FFIRenderLib.clipboardOperationResultDiagnosticLength(operation: ClipboardOperationHandle): { status: NativeClipboardCopyStatus; length: number; }0.6.0
• method FFIRenderLib.clipboardOperationResultErrorCode(operation: ClipboardOperationHandle): { status: NativeClipboardCopyStatus; errorCode: number; }0.6.0
• method FFIRenderLib.clipboardOperationResultMimeCopy(operation: ClipboardOperationHandle, output: Uint8Array): NativeClipboardCopyStatus0.6.0
• method FFIRenderLib.clipboardOperationResultMimeLength(operation: ClipboardOperationHandle): { status: NativeClipboardCopyStatus; length: number; }0.6.0
• method FFIRenderLib.clipboardReadOperationStart(service: ClipboardServiceHandle, request: Uint8Array, selection: number, maxBytes: number, maxImagePixels: number, maxConversionBytes: number, timeoutMs: number): { status: NativeClipboardStartStatus; operation: ClipboardOperationHandle | null; }0.6.0
• method FFIRenderLib.clipboardServiceBeginShutdown(service: ClipboardServiceHandle): NativeClipboardShutdownStatus0.6.0
• method FFIRenderLib.clipboardServiceCreate(maxConcurrentOperations: number, maxProviderTransfers: number, waylandSeat?: string): ClipboardServiceHandle | null0.6.0
• method FFIRenderLib.clipboardServiceDestroy(service: ClipboardServiceHandle): NativeClipboardDestroyStatus0.6.0
• method FFIRenderLib.clipboardServiceDrain(service: ClipboardServiceHandle): number0.6.0
• method FFIRenderLib.clipboardServicePollShutdown(service: ClipboardServiceHandle): NativeClipboardShutdownStatus0.6.0
• method FFIRenderLib.clipboardWriteOperationStart(service: ClipboardServiceHandle, textUtf8: Uint8Array, selection: number, timeoutMs: number): { status: NativeClipboardStartStatus; operation: ClipboardOperationHandle | null; }0.6.0
• method FFIRenderLib.contextAcquireBufferLease(context: NativeContextHandle, buffer: ContextBufferHandle): NativeContextBufferLease0.6.0
• method FFIRenderLib.contextBufferDrawUnicode({ context, target, frame }: NativeDrawingTarget, unicode: ContextUnicodeHandle, index: number, x: number, y: number, foreground: RGBA, background: RGBA, attributes: number): void0.6.0
• method FFIRenderLib.contextBufferLeaseGetRealCharSize(context: NativeContextHandle, lease: ContextObjectHandle, addLineBreaks: boolean): number0.6.0
• method FFIRenderLib.contextBufferLeaseWriteResolvedChars(context: NativeContextHandle, lease: ContextObjectHandle, bytes: Uint8Array, addLineBreaks: boolean, cellLengths?: Uint8Array): number0.6.0
• method FFIRenderLib.contextBufferStack({ context, target, frame }: NativeDrawingTarget, options: NativeBufferStack): number0.6.0
• method FFIRenderLib.contextColorMatrixBuffer({ context, target, frame }: NativeDrawingTarget, matrix: Float32Array, mask: Float32Array | null, strength: number, channel: number): void0.6.0
• method FFIRenderLib.contextDrawBuffer(drawing: NativeDrawingTarget, options: NativeBufferDraw): void0.6.0
• method FFIRenderLib.contextDrawEditorView({ context, target, frame }: NativeDrawingTarget, view: ContextEditorViewHandle, x: number, y: number): void0.6.0
• method FFIRenderLib.contextDrawGrayscaleBuffer({ context, target, frame }: NativeDrawingTarget, data: Float32Array, x: number, y: number, width: number, height: number, foreground: RGBA | null, background: RGBA | null, supersampled: boolean): void0.6.0
• method FFIRenderLib.contextDrawGrid({ context, target, frame }: NativeDrawingTarget, options: NativeBufferGrid): void0.6.0
• method FFIRenderLib.contextDrawImage({ context, target, frame }: NativeDrawingTarget, image: ContextImageHandle, options: NativeContextImageDraw): boolean0.6.0
• method FFIRenderLib.contextDrawPackedBuffer({ context, target, frame }: NativeDrawingTarget, data: Uint8Array | PointerInput, byteLength: number, x: number, y: number, width: number, height: number): void0.6.0
• method FFIRenderLib.contextDrawSceneText({ context, target, frame }: NativeDrawingTarget, node: SceneNodeHandle, x: number, y: number): void0.6.0
• method FFIRenderLib.contextDrawSuperSampleBuffer({ context, target, frame }: NativeDrawingTarget, data: Uint8Array | PointerInput, byteLength: number, x: number, y: number, format: "rgba8unorm" | "bgra8unorm", stride: number): void0.6.0
• method FFIRenderLib.contextDrawTextBufferView({ context, target, frame }: NativeDrawingTarget, view: ContextTextBufferViewHandle, x: number, y: number): void0.6.0
• method FFIRenderLib.contextEditBufferCommand(context: NativeContextHandle, editBuffer: ContextEditBufferHandle, command: NativeEditCommand, argument?: number): void0.6.0
• method FFIRenderLib.contextEditBufferDeleteRange(context: NativeContextHandle, editBuffer: ContextEditBufferHandle, startRow: number, startCol: number, endRow: number, endCol: number): void0.6.0
• method FFIRenderLib.contextEditBufferGetHighlights(context: NativeContextHandle, editBuffer: ContextEditBufferHandle, line: number): Highlight[]0.6.0
• method FFIRenderLib.contextEditBufferGetInfo(context: NativeContextHandle, editBuffer: ContextEditBufferHandle): NativeEditBufferInfo0.6.0
• method FFIRenderLib.contextEditBufferGetPosition(context: NativeContextHandle, editBuffer: ContextEditBufferHandle, query: NativeEditPositionQuery, a?: number, b?: number): LogicalCursor | null0.6.0
• method FFIRenderLib.contextEditBufferGetRange(context: NativeContextHandle, editBuffer: ContextEditBufferHandle, byCoords: boolean, startRow: number, startCol: number, endRow: number, endCol: number): string0.6.0
• method FFIRenderLib.contextEditBufferGetText(context: NativeContextHandle, editBuffer: ContextEditBufferHandle): string0.6.0
• method FFIRenderLib.contextEditBufferHighlight(context: NativeContextHandle, editBuffer: ContextEditBufferHandle, operation: NativeEditHighlightOperation, argument?: number, highlight?: Highlight): void0.6.0
• method FFIRenderLib.contextEditBufferHistory(context: NativeContextHandle, editBuffer: ContextEditBufferHandle, redo: boolean): string | null0.6.0
• method FFIRenderLib.contextEditBufferInsertText(context: NativeContextHandle, editBuffer: ContextEditBufferHandle, bytes: Uint8Array): void0.6.0
• method FFIRenderLib.contextEditBufferSetCursor(context: NativeContextHandle, editBuffer: ContextEditBufferHandle, row: number, col: number): void0.6.0
• method FFIRenderLib.contextEditBufferSetDefaults(context: NativeContextHandle, editBuffer: ContextEditBufferHandle, mask: NativeEditorStyleMask, style: NativeEditorStyle): void0.6.0
• method FFIRenderLib.contextEditBufferSetSyntaxStyle(context: NativeContextHandle, editBuffer: ContextEditBufferHandle, style: ContextSyntaxStyleHandle | null): void0.6.0
• method FFIRenderLib.contextEditBufferSetTabWidth(context: NativeContextHandle, editBuffer: ContextEditBufferHandle, width: number): void0.6.0
• method FFIRenderLib.contextEditBufferSetText(context: NativeContextHandle, editBuffer: ContextEditBufferHandle, bytes: Uint8Array, preserveHistory?: boolean): void0.6.0
• method FFIRenderLib.contextEditorViewCommand(context: NativeContextHandle, view: ContextEditorViewHandle, command: NativeEditorCommand, argument?: number): void0.6.0
• method FFIRenderLib.contextEditorViewGetInfo(context: NativeContextHandle, view: ContextEditorViewHandle, followCursor?: boolean): NativeEditorViewInfo0.6.0
• method FFIRenderLib.contextEditorViewGetLines(context: NativeContextHandle, view: ContextEditorViewHandle, logical?: boolean): LineInfo0.6.0
• method FFIRenderLib.contextEditorViewGetPosition(context: NativeContextHandle, view: ContextEditorViewHandle, query: NativeEditorPositionQuery): VisualCursor0.6.0
• method FFIRenderLib.contextEditorViewGetSelectedText(context: NativeContextHandle, view: ContextEditorViewHandle): string0.6.0
• method FFIRenderLib.contextEditorViewGetSelection(context: NativeContextHandle, view: ContextEditorViewHandle): Pick<NativeEditorViewInfo, "selection" | "selectionOccupancy">0.6.0
• method FFIRenderLib.contextEditorViewGetViewport(context: NativeContextHandle, view: ContextEditorViewHandle): NativeEditorViewport0.6.0
• method FFIRenderLib.contextEditorViewMeasure(context: NativeContextHandle, view: ContextEditorViewHandle, width: number, height: number): MeasureResult0.6.0
• method FFIRenderLib.contextEditorViewReplaceSelection(context: NativeContextHandle, view: ContextEditorViewHandle, bytes: Uint8Array): NativeEditorReplacement0.6.0
• method FFIRenderLib.contextEditorViewSelect(context: NativeContextHandle, view: ContextEditorViewHandle, selection: NativeEditorSelection): boolean0.6.0
• method FFIRenderLib.contextEditorViewSetPlaceholder(context: NativeContextHandle, view: ContextEditorViewHandle, content: StyledText): void0.6.0
• method FFIRenderLib.contextEditorViewSetScrollMargin(context: NativeContextHandle, view: ContextEditorViewHandle, margin: number): void0.6.0
• method FFIRenderLib.contextEditorViewSetTabColor(context: NativeContextHandle, view: ContextEditorViewHandle, color: RGBA | null): void0.6.0
• method FFIRenderLib.contextEditorViewSetViewport(context: NativeContextHandle, view: ContextEditorViewHandle, viewport: NativeEditorViewport, sizeOnly?: boolean, moveCursor?: boolean): void0.6.0
• method FFIRenderLib.contextEmbeddedTerminalClearSelection(context: NativeContextHandle, terminal: ContextEmbeddedTerminalHandle): void0.6.0
• method FFIRenderLib.contextEmbeddedTerminalCompose({ context, target, frame }: NativeDrawingTarget, terminal: ContextEmbeddedTerminalHandle, x: number, y: number): void0.6.0
• method FFIRenderLib.contextEmbeddedTerminalCursor(context: NativeContextHandle, terminal: ContextEmbeddedTerminalHandle): EmbeddedTerminalCursor0.6.0
• method FFIRenderLib.contextEmbeddedTerminalDrainResponses(context: NativeContextHandle, terminal: ContextEmbeddedTerminalHandle): Uint8Array0.6.0
• method FFIRenderLib.contextEmbeddedTerminalEncodeFocus(context: NativeContextHandle, terminal: ContextEmbeddedTerminalHandle, focused: boolean): Uint8Array0.6.0
• method FFIRenderLib.contextEmbeddedTerminalEncodeKey(context: NativeContextHandle, terminal: ContextEmbeddedTerminalHandle, key: EmbeddedTerminalKey): Uint8Array0.6.0
• method FFIRenderLib.contextEmbeddedTerminalEncodeMouse(context: NativeContextHandle, terminal: ContextEmbeddedTerminalHandle, mouse: EmbeddedTerminalMouse): Uint8Array0.6.0
• method FFIRenderLib.contextEmbeddedTerminalEncodePaste(context: NativeContextHandle, terminal: ContextEmbeddedTerminalHandle, input: Uint8Array): Uint8Array0.6.0
• method FFIRenderLib.contextEmbeddedTerminalGetSelectedText(context: NativeContextHandle, terminal: ContextEmbeddedTerminalHandle): Uint8Array0.6.0
• method FFIRenderLib.contextEmbeddedTerminalInvalidate(context: NativeContextHandle, terminal: ContextEmbeddedTerminalHandle): void0.6.0
• method FFIRenderLib.contextEmbeddedTerminalResize(context: NativeContextHandle, terminal: ContextEmbeddedTerminalHandle, cols: number, rows: number): void0.6.0
• method FFIRenderLib.contextEmbeddedTerminalScroll(context: NativeContextHandle, terminal: ContextEmbeddedTerminalHandle, delta: number): void0.6.0
• method FFIRenderLib.contextEmbeddedTerminalSetSelection(context: NativeContextHandle, terminal: ContextEmbeddedTerminalHandle, start: { x: number; y: number; }, end: { x: number; y: number; }): void0.6.0
• method FFIRenderLib.contextEmbeddedTerminalSetTransparentBackground(context: NativeContextHandle, terminal: ContextEmbeddedTerminalHandle, transparent: boolean): void0.6.0
• method FFIRenderLib.contextEmbeddedTerminalWrite(context: NativeContextHandle, terminal: ContextEmbeddedTerminalHandle, data: string | Uint8Array): void0.6.0
• method FFIRenderLib.contextGetLinkUrl(context: NativeContextHandle, linkId: number): string0.6.0
• method FFIRenderLib.contextReleaseBufferLease(context: NativeContextHandle, lease: ContextObjectHandle): void0.6.0
• method FFIRenderLib.contextResizeBuffer(context: NativeContextHandle, buffer: ContextBufferHandle, width: number, height: number): void0.6.0
• method FFIRenderLib.contextSyntaxStyleGetStyleCount(context: NativeContextHandle, style: ContextSyntaxStyleHandle): number0.6.0
• method FFIRenderLib.contextSyntaxStyleRegister(context: NativeContextHandle, style: ContextSyntaxStyleHandle, name: string, definition: NativeEditorStyle): number0.6.0
• method FFIRenderLib.contextSyntaxStyleResolveByName(context: NativeContextHandle, style: ContextSyntaxStyleHandle, name: string): number | null0.6.0
• method FFIRenderLib.contextTextBufferAppend(context: NativeContextHandle, text: ContextTextBufferHandle, bytes: Uint8Array): void0.6.0
• method FFIRenderLib.contextTextBufferClear(context: NativeContextHandle, text: ContextTextBufferHandle, reset?: boolean): void0.6.0
• method FFIRenderLib.contextTextBufferGetHighlights(context: NativeContextHandle, text: ContextTextBufferHandle, line: number): Highlight[]0.6.0
• method FFIRenderLib.contextTextBufferGetInfo(context: NativeContextHandle, text: ContextTextBufferHandle): NativeTextBufferInfo0.6.0
• method FFIRenderLib.contextTextBufferGetRange(context: NativeContextHandle, text: ContextTextBufferHandle, start: number, end: number): string0.6.0
• method FFIRenderLib.contextTextBufferGetText(context: NativeContextHandle, text: ContextTextBufferHandle): string0.6.0
• method FFIRenderLib.contextTextBufferHighlight(context: NativeContextHandle, text: ContextTextBufferHandle, operation: NativeEditHighlightOperation, argument?: number, highlight?: Highlight): void0.6.0
• method FFIRenderLib.contextTextBufferReplaceStyledBatch(context: NativeContextHandle, replacements: { buffer: ContextTextBufferHandle; view: ContextTextBufferViewHandle; text: NativeEncodedStyledText; }[], beforeNative: () => void): Uint32Array | null0.6.0
• method FFIRenderLib.contextTextBufferSetDefaults(context: NativeContextHandle, text: ContextTextBufferHandle, mask: NativeEditorStyleMask, style: NativeEditorStyle): void0.6.0
• method FFIRenderLib.contextTextBufferSetEncodedStyledText(context: NativeContextHandle, text: ContextTextBufferHandle, encoded: NativeEncodedStyledText): void0.6.0
• method FFIRenderLib.contextTextBufferSetStyledText(context: NativeContextHandle, text: ContextTextBufferHandle, content: StyledText): void0.6.0
• method FFIRenderLib.contextTextBufferSetSyntaxStyle(context: NativeContextHandle, text: ContextTextBufferHandle, style: ContextSyntaxStyleHandle | null): void0.6.0
• method FFIRenderLib.contextTextBufferSetTabWidth(context: NativeContextHandle, text: ContextTextBufferHandle, width: number): void0.6.0
• method FFIRenderLib.contextTextBufferSetText(context: NativeContextHandle, text: ContextTextBufferHandle, bytes: Uint8Array): void0.6.0
• method FFIRenderLib.contextTextBufferViewCommand(context: NativeContextHandle, view: ContextTextBufferViewHandle, command: NativeTextViewCommand, argument: number): void0.6.0
• method FFIRenderLib.contextTextBufferViewGetInfo(context: NativeContextHandle, view: ContextTextBufferViewHandle): NativeEditorViewInfo0.6.0
• method FFIRenderLib.contextTextBufferViewGetLines(context: NativeContextHandle, view: ContextTextBufferViewHandle, logical?: boolean, firstLine?: number, lineCount?: number): LineInfo0.6.0
• method FFIRenderLib.contextTextBufferViewGetSelectedText(context: NativeContextHandle, view: ContextTextBufferViewHandle): string0.6.0
• method FFIRenderLib.contextTextBufferViewMeasure(context: NativeContextHandle, view: ContextTextBufferViewHandle, width: number, height: number): MeasureResult0.6.0
• method FFIRenderLib.contextTextBufferViewResetSelection(context: NativeContextHandle, view: ContextTextBufferViewHandle, local: boolean, clear?: boolean): void0.6.0
• method FFIRenderLib.contextTextBufferViewSelect(context: NativeContextHandle, view: ContextTextBufferViewHandle, selection: NativeEditorSelection): boolean0.6.0
• method FFIRenderLib.contextTextBufferViewSetTabColor(context: NativeContextHandle, view: ContextTextBufferViewHandle, color: RGBA | null): void0.6.0
• method FFIRenderLib.contextTextBufferViewSetViewport(context: NativeContextHandle, view: ContextTextBufferViewHandle, viewport: NativeEditorViewport, sizeOnly?: boolean): void0.6.0
• method FFIRenderLib.contextValidateBufferLease(context: NativeContextHandle, lease: ContextObjectHandle): void0.6.0
• method FFIRenderLib.createAudioEngine(options?: AudioCreateOptions | null): AudioEngineHandle | null0.6.0
• method FFIRenderLib.createContext(options: NativeContextOptions): NativeContextHandle0.6.0
• method FFIRenderLib.createContextBuffer(context: NativeContextHandle, options: NativeContextBufferOptions): ContextBufferHandle0.6.0
• method FFIRenderLib.createContextEditBuffer(context: NativeContextHandle, options?: NativeContextEditBufferOptions): ContextEditBufferHandle0.6.0
• method FFIRenderLib.createContextEditorView(context: NativeContextHandle, editBuffer: ContextEditBufferHandle, width: number, height: number): ContextEditorViewHandle0.6.0
• method FFIRenderLib.createContextEmbeddedTerminal(context: NativeContextHandle, options: { cols: number; rows: number; maxScrollback?: number; }): ContextEmbeddedTerminalHandle0.6.0
• method FFIRenderLib.createContextSyntaxStyle(context: NativeContextHandle): ContextSyntaxStyleHandle0.6.0
• method FFIRenderLib.createContextTextBuffer(context: NativeContextHandle, options?: NativeContextEditBufferOptions): ContextTextBufferHandle0.6.0
• method FFIRenderLib.createContextTextBufferView(context: NativeContextHandle, text: ContextTextBufferHandle): ContextTextBufferViewHandle0.6.0
• method FFIRenderLib.createContextUnicode(context: NativeContextHandle, text: string, widthMethod: WidthMethod | "no-zwj"): ContextUnicodeHandle0.6.0
• method FFIRenderLib.createNativeSpanFeed(options?: NativeSpanFeedOptions | null): Pointer0.6.0
• method FFIRenderLib.createSession(context: NativeContextHandle, options: NativeSessionOptions): SessionHandle0.6.0
• method FFIRenderLib.createYogaDirtiedCallback(callback: NativeYogaDirtiedCallback): FFICallbackInstance0.6.0
• method FFIRenderLib.createYogaMeasureCallback(callback: NativeYogaMeasureCallback): FFICallbackInstance0.6.0
• method FFIRenderLib.destroyAudioEngine(engine: AudioEngineHandle): void0.6.0
• method FFIRenderLib.destroyContext(context: NativeContextHandle): void0.6.0
• method FFIRenderLib.destroyContextBuffer(context: NativeContextHandle, buffer: ContextBufferHandle): void0.6.0
• method FFIRenderLib.destroyContextEditBuffer(context: NativeContextHandle, editBuffer: ContextEditBufferHandle): void0.6.0
• method FFIRenderLib.destroyContextEditorView(context: NativeContextHandle, view: ContextEditorViewHandle): void0.6.0
• method FFIRenderLib.destroyContextEmbeddedTerminal(context: NativeContextHandle, terminal: ContextEmbeddedTerminalHandle): void0.6.0
• method FFIRenderLib.destroyContextImage(context: NativeContextHandle, image: ContextImageHandle): void0.6.0
• method FFIRenderLib.destroyContextSyntaxStyle(context: NativeContextHandle, style: ContextSyntaxStyleHandle): void0.6.0
• method FFIRenderLib.destroyContextTextBuffer(context: NativeContextHandle, text: ContextTextBufferHandle): void0.6.0
• method FFIRenderLib.destroyContextTextBufferView(context: NativeContextHandle, view: ContextTextBufferViewHandle): void0.6.0
• method FFIRenderLib.destroyContextUnicode(context: NativeContextHandle, unicode: ContextUnicodeHandle): void0.6.0
• method FFIRenderLib.destroyNativeSpanFeed(stream: Pointer): number0.6.0
• method FFIRenderLib.destroySession(context: NativeContextHandle, session: SessionHandle): void0.6.0
• method FFIRenderLib.dispose(): void0.6.0
• method FFIRenderLib.encodeTextBufferStyledText(content: StyledText): NativeEncodedStyledText0.6.0
• method FFIRenderLib.getAllocatorStats(): AllocatorStats0.6.0
• method FFIRenderLib.getArenaAllocatedBytes(): number0.6.0
• method FFIRenderLib.getBuildOptions(): BuildOptions0.6.0
• method FFIRenderLib.getContextUnicode(context: NativeContextHandle, unicode: ContextUnicodeHandle): Array<{ width: number; char: number; }>0.6.0
• method FFIRenderLib.getYogaHost(): YogaHost0.6.0
• method FFIRenderLib.imageClone(image: ImageHandle, context?: NativeContextHandle): { status: number; handle: ImageHandle | null; }0.6.0
• method FFIRenderLib.imageComposite(base: ImageHandle, overlay: ImageHandle, left: number, top: number, blend: number, opacity: number): { status: number; handle: ImageHandle | null; }0.6.0
• method FFIRenderLib.imageCopyPixels(image: ImageHandle, destination: Uint8Array, stride: number, bgra: boolean): number0.6.0
• method FFIRenderLib.imageCopyPng(image: ImageHandle, destination: Uint8Array): { status: number; byteCount: number; }0.6.0
• method FFIRenderLib.imageCreateFromPixels(context: NativeContextHandle, pixels: Uint8Array, width: number, height: number, stride: number, format: number, alpha: number): { status: number; handle: ImageHandle | null; }0.6.0
• method FFIRenderLib.imageCreateFromRgba(context: NativeContextHandle, pixels: Uint8Array, width: number, height: number, stride: number): { status: number; handle: ImageHandle | null; }0.6.0
• method FFIRenderLib.imageDecode(context: NativeContextHandle, data: Uint8Array): { status: number; handle: ImageHandle | null; }0.6.0
• method FFIRenderLib.imageDestroy(image: ImageHandle): void0.6.0
• method FFIRenderLib.imageEnsureEncodedPng(image: ImageHandle): number0.6.0
• method FFIRenderLib.imageExtend(image: ImageHandle, top: number, right: number, bottom: number, left: number, background: Uint8Array): { status: number; handle: ImageHandle | null; }0.6.0
• method FFIRenderLib.imageExtract(image: ImageHandle, left: number, top: number, width: number, height: number): { status: number; handle: ImageHandle | null; }0.6.0
• method FFIRenderLib.imageGetInfo(image: ImageHandle): { status: number; info: NativeImageInfo; }0.6.0
• method FFIRenderLib.imageInfo(context: NativeContextHandle, data: Uint8Array): { status: number; info: NativeImageInfo; }0.6.0
• method FFIRenderLib.imageReleaseIccCache(): void0.6.0
• method FFIRenderLib.imageReleasePixels(lease: ContextImagePixelsHandle): void0.6.0
• method FFIRenderLib.imageResize(image: ImageHandle, width: number, height: number, filter: number): { status: number; handle: ImageHandle | null; }0.6.0
• method FFIRenderLib.imageRetain(image: ImageHandle): { status: number; handle: ImageHandle | null; }0.6.0
• method FFIRenderLib.imageRetainIccCache(): void0.6.0
• method FFIRenderLib.imageTakePixels(image: ImageHandle): { status: number; lease: ContextImagePixelsHandle | null; pointer: Pointer | null; byteCount: number; }0.6.0
• method FFIRenderLib.imageTransform(image: ImageHandle, operation: number): { status: number; handle: ImageHandle | null; }0.6.0
• method FFIRenderLib.imageUpdatePixels(image: ImageHandle, pixels: Uint8Array, stride: number, format: number, alpha: number): number0.6.0
• method FFIRenderLib.logContextDiagnostics(context: NativeContextHandle, maxLevel?: LogLevel): void0.6.0
• method FFIRenderLib.onContextEditEvent(context: NativeContextHandle, editBuffer: ContextEditBufferHandle, handler: (event: NativeEditEventName) => void): () => void0.6.0
• method FFIRenderLib.registerNativeSpanFeedStream(stream: Pointer, handler: NativeSpanFeedEventHandler): void0.6.0
• method FFIRenderLib.releaseAfterPaint(context: NativeContextHandle, release: () => void): void0.6.0
• method FFIRenderLib.sceneCreateNode(context: NativeContextHandle, session: SessionHandle, kind: (typeof SCENE_NODE_KINDS)[number], num: number): SceneNodeHandle0.6.0
• method FFIRenderLib.sceneDestroyNode(context: NativeContextHandle, node: SceneNodeHandle): void0.6.0
• method FFIRenderLib.sceneFlush(context: NativeContextHandle, staging: SceneStaging): void0.6.0
• method FFIRenderLib.sceneFrameAcquireBufferLease(context: NativeContextHandle, session: SessionHandle, frame: NativeSceneFrameRequest, which: SessionBuffer): NativeContextBufferLease0.6.0
• method FFIRenderLib.sceneFrameCancel(context: NativeContextHandle, session: SessionHandle, frameId: bigint): void0.6.0
• method FFIRenderLib.sceneFrameCommit(context: NativeContextHandle, session: SessionHandle, frame: NativeSceneFrameRequest, force: boolean): NativeSessionRenderStatus0.6.0
• method FFIRenderLib.sceneFrameCopyBuffer(context: NativeContextHandle, session: SessionHandle, frame: NativeSceneFrameRequest, target: ContextBufferHandle): void0.6.0
• method FFIRenderLib.sceneFrameGetPaintSlots(context: NativeContextHandle, session: SessionHandle, frame: NativeSceneFrameRequest): NativeScenePaintSlot[]0.6.0
• method FFIRenderLib.sceneFrameStep(context: NativeContextHandle, session: SessionHandle, previous: NativeSceneFrameRequest | null, options: NativeSceneFrameOptions, maxWorkItems?: number, recording?: Uint8Array | null): NativeSceneFrameRequest0.6.0
• method FFIRenderLib.sceneGetCursorState(context: NativeContextHandle, session: SessionHandle): CursorState0.6.0
• method FFIRenderLib.sceneGetLayout(context: NativeContextHandle, node: SceneNodeHandle, observation?: boolean | "paint"): NativeSceneLayout0.6.0
• method FFIRenderLib.sceneGetSelectedText(context: NativeContextHandle, node: SceneNodeHandle): string0.6.0
• method FFIRenderLib.sceneGetSliderThumb(context: NativeContextHandle, node: SceneNodeHandle): { size: number; start: number; }0.6.0
• method FFIRenderLib.sceneGetStats(context: NativeContextHandle, session: SessionHandle): NativeRenderStats0.6.0
• method FFIRenderLib.sceneGetStyle(context: NativeContextHandle, node: SceneNodeHandle, group: number, kind: number, edge: number): { unit: number; value: number; }0.6.0
• method FFIRenderLib.sceneGetText(context: NativeContextHandle, node: SceneNodeHandle): string0.6.0
• method FFIRenderLib.sceneGetTextLineInfo(context: NativeContextHandle, node: SceneNodeHandle, firstLine?: number, lineCount?: number): LineInfo0.6.0
• method FFIRenderLib.sceneGetTextMetrics(context: NativeContextHandle, node: SceneNodeHandle): NativeSceneTextMetrics0.6.0
• method FFIRenderLib.sceneGetTextSelection(context: NativeContextHandle, node: SceneNodeHandle): { start: number; end: number; } | null0.6.0
• method FFIRenderLib.sceneHasMeasure(context: NativeContextHandle, node: SceneNodeHandle): boolean0.6.0
• method FFIRenderLib.sceneHitTest(context: NativeContextHandle, session: SessionHandle, x: number, y: number): number0.6.0
• method FFIRenderLib.sceneMarkDirty(context: NativeContextHandle, node: SceneNodeHandle): void0.6.0
• method FFIRenderLib.sceneMeasureLayout(context: NativeContextHandle, session: SessionHandle, root: SceneNodeHandle): void0.6.0
• method FFIRenderLib.sceneMoveNode(context: NativeContextHandle, node: SceneNodeHandle, parent: SceneNodeHandle | null, index: number): void0.6.0
• method FFIRenderLib.sceneSetArrow(context: NativeContextHandle, node: SceneNodeHandle, options: NativeSceneArrowOptions): void0.6.0
• method FFIRenderLib.sceneSetBoxDetails(context: NativeContextHandle, node: SceneNodeHandle, details: NativeSceneBoxDetails): void0.6.0
• method FFIRenderLib.sceneSetEditorOptions(context: NativeContextHandle, node: SceneNodeHandle, options: NativeSceneEditorOptions): void0.6.0
• method FFIRenderLib.sceneSetEditorView(context: NativeContextHandle, node: SceneNodeHandle, view: ContextEditorViewHandle | null): void0.6.0
• method FFIRenderLib.sceneSetFocus(context: NativeContextHandle, node: SceneNodeHandle, focused: boolean): void0.6.0
• method FFIRenderLib.sceneSetHooks(context: NativeContextHandle, node: SceneNodeHandle, flags: number, generation: bigint, initialWidth: number, initialHeight: number): void0.6.0
• method FFIRenderLib.sceneSetImage(context: NativeContextHandle, node: SceneNodeHandle, image: ContextImageHandle | null, fit: "fit" | "cover" | "fill", protocol: ImageRenderProtocol, buffer: ContextBufferHandle | null): void0.6.0
• method FFIRenderLib.sceneSetMeasure(context: NativeContextHandle, node: SceneNodeHandle, measure: MeasureFunction | null): void0.6.0
• method FFIRenderLib.sceneSetSlider(context: NativeContextHandle, node: SceneNodeHandle, options: NativeSceneSliderOptions): void0.6.0
• method FFIRenderLib.sceneSetStyledText(context: NativeContextHandle, node: SceneNodeHandle, content: StyledText): void0.6.0
• method FFIRenderLib.sceneSetSurface(context: NativeContextHandle, node: SceneNodeHandle, buffer: ContextBufferHandle | null): void0.6.0
• method FFIRenderLib.sceneSetText(context: NativeContextHandle, node: SceneNodeHandle, bytes: Uint8Array): void0.6.0
• method FFIRenderLib.sceneSetTextOptions(context: NativeContextHandle, node: SceneNodeHandle, options: NativeSceneTextOptions): void0.6.0
• method FFIRenderLib.sceneSetTextSelection(context: NativeContextHandle, node: SceneNodeHandle, options: NativeSceneTextSelectionOptions): boolean0.6.0
• method FFIRenderLib.sceneSetTextView(context: NativeContextHandle, node: SceneNodeHandle, view: ContextTextBufferViewHandle | null): void0.6.0
• method FFIRenderLib.sceneSetTextViewPaint(context: NativeContextHandle, node: SceneNodeHandle, enabled: boolean): void0.6.0
• method FFIRenderLib.sceneSetViewport(context: NativeContextHandle, node: SceneNodeHandle, viewport: SceneNodeHandle | null): void0.6.0
• method FFIRenderLib.sessionAcquireBufferLease(context: NativeContextHandle, session: SessionHandle, which: SessionBuffer): NativeSessionBufferLease0.6.0
• method FFIRenderLib.sessionAttachRenderer(context: NativeContextHandle, session: SessionHandle, options: NativeSessionRendererOptions): void0.6.0
• method FFIRenderLib.sessionCancel(context: NativeContextHandle, session: SessionHandle): void0.6.0
• method FFIRenderLib.sessionCancelKittyImageTransport(context: NativeContextHandle, session: SessionHandle, failed: boolean): void0.6.0
• method FFIRenderLib.sessionClipboard(context: NativeContextHandle, session: SessionHandle, target: number, bytes: Uint8Array): boolean0.6.0
• method FFIRenderLib.sessionClose(context: NativeContextHandle, session: SessionHandle): void0.6.0
• method FFIRenderLib.sessionCompleteOutput(context: NativeContextHandle, session: SessionHandle, ticket: NativeOutputTicket, success: boolean): void0.6.0
• method FFIRenderLib.sessionControl(context: NativeContextHandle, session: SessionHandle, command: NativeSessionControl): void0.6.0
• method FFIRenderLib.sessionDrainStdout(context: NativeContextHandle, session: SessionHandle, maxBytes?: number): number0.6.0
• method FFIRenderLib.sessionDumpHitGrid(context: NativeContextHandle, session: SessionHandle): void0.6.0
• method FFIRenderLib.sessionGetCapabilities(context: NativeContextHandle, session: SessionHandle): NativeSessionCapabilities0.6.0
• method FFIRenderLib.sessionGetKittyImageTransport(context: NativeContextHandle, session: SessionHandle): NativeSessionKittyImageTransportStatus0.6.0
• method FFIRenderLib.sessionGetLinkId(context: NativeContextHandle, session: SessionHandle, x: number, y: number): number0.6.0
• method FFIRenderLib.sessionGetRendererState(context: NativeContextHandle, session: SessionHandle): NativeSessionRendererState0.6.0
• method FFIRenderLib.sessionGetState(context: NativeContextHandle, session: SessionHandle): NativeSessionState0.6.0
• method FFIRenderLib.sessionGetTerminalState(context: NativeContextHandle, session: SessionHandle): NativeSessionTerminalPhase0.6.0
• method FFIRenderLib.sessionGetWriteLimit(context: NativeContextHandle, session: SessionHandle): bigint0.6.0
• method FFIRenderLib.sessionNotification(context: NativeContextHandle, session: SessionHandle, message: string, title?: string): boolean0.6.0
• method FFIRenderLib.sessionPollKittyImageTransport(context: NativeContextHandle, session: SessionHandle, nowNs: bigint): boolean0.6.0
• method FFIRenderLib.sessionProcessKittyImageReply(context: NativeContextHandle, session: SessionHandle, bytes: Uint8Array): number0.6.0
• method FFIRenderLib.sessionPump(context: NativeContextHandle, session: SessionHandle, nowNs: bigint, workBudget: number): NativeSessionPumpResult0.6.0
• method FFIRenderLib.sessionPumpExit(context: NativeContextHandle, session: SessionHandle): NativeSessionPumpStatus0.6.0
• method FFIRenderLib.sessionReadOutput(context: NativeContextHandle, session: SessionHandle, bytes: Uint8Array): NativeOutputTicket | null0.6.0
• method FFIRenderLib.sessionRenderSplit(context: NativeContextHandle, session: SessionHandle, frame: NativeSceneFrameRequest | null, snapshots: readonly NativeSplitSnapshot[], pinnedRenderOffset: number, force: boolean): { status: NativeSessionRenderStatus; }0.6.0
• method FFIRenderLib.sessionResizeRenderer(context: NativeContextHandle, session: SessionHandle, width: number, height: number): void0.6.0
• method FFIRenderLib.sessionResume(context: NativeContextHandle, session: SessionHandle): void0.6.0
• method FFIRenderLib.sessionSetCursor(context: NativeContextHandle, session: SessionHandle, options: NativeSessionCursorOptions): void0.6.0
• method FFIRenderLib.sessionSetDebugOverlay(context: NativeContextHandle, session: SessionHandle, enabled: boolean, corner: DebugOverlayCorner): void0.6.0
• method FFIRenderLib.sessionSetImageResolution(context: NativeContextHandle, session: SessionHandle, terminalWidth: number, terminalHeight: number, pixelWidth: number, pixelHeight: number): void0.6.0
• method FFIRenderLib.sessionSetKittyImageTransport(context: NativeContextHandle, session: SessionHandle, mode: number): void0.6.0
• method FFIRenderLib.sessionSetPaletteState(context: NativeContextHandle, session: SessionHandle, palette: readonly RGBA[], foreground: RGBA, background: RGBA, epoch: number): void0.6.0
• method FFIRenderLib.sessionSetScreen(context: NativeContextHandle, session: SessionHandle, alternate: boolean, width: number, height: number, trailingOutput?: Uint8Array): void0.6.0
• method FFIRenderLib.sessionSetupTerminal(context: NativeContextHandle, session: SessionHandle, options?: NativeSessionTerminalOptions): void0.6.0
• method FFIRenderLib.sessionSplitControl(context: NativeContextHandle, session: SessionHandle, command: NativeSessionSplitControl): number0.6.0
• method FFIRenderLib.sessionStartKittyFileProbe(context: NativeContextHandle, session: SessionHandle): void0.6.0
• method FFIRenderLib.sessionSuspend(context: NativeContextHandle, session: SessionHandle): void0.6.0
• method FFIRenderLib.sessionSyncDetached(context: NativeContextHandle, session: SessionHandle, parent: SessionHandle): void0.6.0
• method FFIRenderLib.sessionUpdateMemoryStats(context: NativeContextHandle, session: SessionHandle, heapUsed: number, heapTotal: number, arrayBuffers: number): void0.6.0
• method FFIRenderLib.sessionUpdateStats(context: NativeContextHandle, session: SessionHandle, overallMs: number, fps: number, callbackMs: number): void0.6.0
• method FFIRenderLib.sessionWrite(context: NativeContextHandle, session: SessionHandle, bytes: Uint8Array): void0.6.0
• method FFIRenderLib.streamClose(stream: Pointer): number0.6.0
• method FFIRenderLib.streamCommit(stream: Pointer): number0.6.0
• method FFIRenderLib.streamCommitReserved(stream: Pointer, length: number): number0.6.0
• method FFIRenderLib.streamDrainSpans(stream: Pointer, outBuffer: Uint8Array, maxSpans: number): number0.6.0
• method FFIRenderLib.streamGetStats(stream: Pointer): NativeSpanFeedStats | null0.6.0
• method FFIRenderLib.streamReleaseSpan(stream: Pointer, slotIndex: number, releaseId: bigint): number0.6.0
• method FFIRenderLib.streamReserve(stream: Pointer, minLen: number): { status: number; info: ReserveInfo | null; }0.6.0
• method FFIRenderLib.streamWrite(stream: Pointer, data: Uint8Array | string): number0.6.0
• method FFIRenderLib.terminalFlushInput(): void0.6.0
• method FFIRenderLib.unregisterNativeSpanFeedStream(stream: Pointer): void0.6.0
• method FFIRenderLib.yogaConfigClearCallbacks(config: Pointer, measure: Pointer): boolean0.6.0
• method FFIRenderLib.yogaConfigCreate(): Pointer0.6.0
• method FFIRenderLib.yogaConfigFree(config: Pointer): void0.6.0
• method FFIRenderLib.yogaConfigGetErrata(config: Pointer): number0.6.0
• method FFIRenderLib.yogaConfigGetPointScaleFactor(config: Pointer): number0.6.0
• method FFIRenderLib.yogaConfigGetUseWebDefaults(config: Pointer): boolean0.6.0
• method FFIRenderLib.yogaConfigIsExperimentalFeatureEnabled(config: Pointer, feature: number): boolean0.6.0
• method FFIRenderLib.yogaConfigSetCallbacks(config: Pointer, measure: Pointer, dirtied: Pointer): boolean0.6.0
• method FFIRenderLib.yogaConfigSetErrata(config: Pointer, errata: number): void0.6.0
• method FFIRenderLib.yogaConfigSetExperimentalFeatureEnabled(config: Pointer, feature: number, enabled: boolean): void0.6.0
• method FFIRenderLib.yogaConfigSetPointScaleFactor(config: Pointer, pointScaleFactor: number): void0.6.0
• method FFIRenderLib.yogaConfigSetUseWebDefaults(config: Pointer, enabled: boolean): void0.6.0
• method FFIRenderLib.yogaNodeCalculateLayout(node: Pointer, width: number, height: number, direction: number): void0.6.0
• method FFIRenderLib.yogaNodeCopyStyle(dstNode: Pointer, srcNode: Pointer): void0.6.0
• method FFIRenderLib.yogaNodeCreateForOpenTUI(): Pointer0.6.0
• method FFIRenderLib.yogaNodeCreateWithConfig(config: Pointer): Pointer0.6.0
• method FFIRenderLib.yogaNodeFree(node: Pointer): void0.6.0
• method FFIRenderLib.yogaNodeFreeRecursive(node: Pointer): void0.6.0
• method FFIRenderLib.yogaNodeGetAlwaysFormsContainingBlock(node: Pointer): boolean0.6.0
• method FFIRenderLib.yogaNodeGetChild(node: Pointer, index: number): Pointer | null0.6.0
• method FFIRenderLib.yogaNodeGetChildCount(node: Pointer): number0.6.0
• method FFIRenderLib.yogaNodeGetComputedLayout(node: Pointer): NativeYogaLayout0.6.0
• method FFIRenderLib.yogaNodeGetConfig(node: Pointer): Pointer0.6.0
• method FFIRenderLib.yogaNodeGetHasNewLayout(node: Pointer): boolean0.6.0
• method FFIRenderLib.yogaNodeGetParent(node: Pointer): Pointer | null0.6.0
• method FFIRenderLib.yogaNodeHasMeasureFunc(node: Pointer): boolean0.6.0
• method FFIRenderLib.yogaNodeInsertChild(node: Pointer, child: Pointer, index: number): void0.6.0
• method FFIRenderLib.yogaNodeIsDirty(node: Pointer): boolean0.6.0
• method FFIRenderLib.yogaNodeIsReferenceBaseline(node: Pointer): boolean0.6.0
• method FFIRenderLib.yogaNodeLayoutGetEdge(node: Pointer, kind: number, edge: number): number0.6.0
• method FFIRenderLib.yogaNodeMarkDirty(node: Pointer): void0.6.0
• method FFIRenderLib.yogaNodeRemoveAllChildren(node: Pointer): void0.6.0
• method FFIRenderLib.yogaNodeRemoveChild(node: Pointer, child: Pointer): void0.6.0
• method FFIRenderLib.yogaNodeReset(node: Pointer): void0.6.0
• method FFIRenderLib.yogaNodeSetAlwaysFormsContainingBlock(node: Pointer, alwaysFormsContainingBlock: boolean): void0.6.0
• method FFIRenderLib.yogaNodeSetDirtiedFunc(node: Pointer, enabled: boolean): void0.6.0
• method FFIRenderLib.yogaNodeSetHasNewLayout(node: Pointer, hasNewLayout: boolean): void0.6.0
• method FFIRenderLib.yogaNodeSetIsReferenceBaseline(node: Pointer, isReferenceBaseline: boolean): void0.6.0
• method FFIRenderLib.yogaNodeSetMeasureFunc(node: Pointer, enabled: boolean): void0.6.0
• method FFIRenderLib.yogaNodeStyleGetBorder(node: Pointer, edge: number): number0.6.0
• method FFIRenderLib.yogaNodeStyleGetEnum(node: Pointer, kind: number): number0.6.0
• method FFIRenderLib.yogaNodeStyleGetFloat(node: Pointer, kind: number): number0.6.0
• method FFIRenderLib.yogaNodeStyleGetValue(node: Pointer, kind: number, edgeOrGutter: number): number | bigint0.6.0
• method FFIRenderLib.yogaNodeStyleSetBorder(node: Pointer, edge: number, border: number): void0.6.0
• method FFIRenderLib.yogaNodeStyleSetEnum(node: Pointer, kind: number, value: number): void0.6.0
• method FFIRenderLib.yogaNodeStyleSetFloat(node: Pointer, kind: number, value: number): void0.6.0
• method FFIRenderLib.yogaNodeStyleSetValue(node: Pointer, kind: number, edgeOrGutter: number, unit: number, value: number): void0.6.0
• method FFIRenderLib.yogaNodeUnsetDirtiedFunc(node: Pointer): void0.6.0
• method FFIRenderLib.yogaNodeUnsetMeasureFunc(node: Pointer): void0.6.0
• method FFIRenderLib.yogaStoreMeasureResult(config: Pointer, width: number, height: number): void0.6.0
• readonly property FFIRenderLib.decoder: TextDecoder0.6.0
• readonly property FFIRenderLib.encoder: TextEncoder0.6.0

class FlamesEffectconstructor FlamesEffect(scale?: number, speed?: number, intensity?: number)

Post-processing effects

• method FlamesEffect.apply(buffer: OptimizedBuffer, deltaTime: number): void
• property FlamesEffect.intensity: number
• property FlamesEffect.scale: number
• property FlamesEffect.speed: number

class FrameBufferRenderable extends Renderableconstructor FrameBufferRenderable(ctx: RenderContext, options: FrameBufferOptions)

FrameBuffer

• property FrameBufferRenderable.frameBuffer: OptimizedBuffer
• protected method FrameBufferRenderable.onResize(width: number, height: number): void
• protected method FrameBufferRenderable.renderSelf(buffer: OptimizedBuffer): void
• protected property FrameBufferRenderable.respectAlpha: boolean
• static readonly property FrameBufferRenderable.nativeIntegration: NativeRenderableIntegration0.6.0

class ImageError extends Errorconstructor ImageError(status: number)

Added in 0.5.0Native images

• readonly property ImageError.code: ImageErrorCode0.5.0
• readonly property ImageError.status: number0.5.0

class ImageLoadError extends Errorconstructor ImageLoadError(code: ImageLoadErrorCode, source: string, message: string, options?: { cause?: unknown; status?: number; })

Added in 0.5.0Native images

• readonly property ImageLoadError.code: ImageLoadErrorCode0.5.0
• readonly property ImageLoadError.source: string0.5.0
• readonly property ImageLoadError.status?: number0.5.0

class ImageRenderable extends Renderableconstructor ImageRenderable(ctx: RenderContext, options: ImageRenderableOptions)

Added in 0.5.0Image

• method ImageRenderable.getFittedSize(targetWidth: number, targetHeight: number, cellAspectRatio?: number, sourceWidth?: number, sourceHeight?: number): { width: number; height: number; }0.5.0
• property ImageRenderable.fit: ImageFit0.5.0
• property ImageRenderable.loadPromise: Promise<void> | null0.5.0
• property ImageRenderable.onError?: (error: unknown) => void0.5.0
• property ImageRenderable.onLoad?: (image: NativeImage) => void0.5.0
• property ImageRenderable.protocol: ImageRenderProtocol0.5.0
• property ImageRenderable.source: ImageRenderableSource | undefined0.5.0
• protected method ImageRenderable.createFrameBuffer(): void0.6.0
• protected method ImageRenderable.destroySelf(): void0.5.0
• protected method ImageRenderable.renderSelf(buffer: OptimizedBuffer): void0.5.0
• readonly property ImageRenderable.cellAspectRatio: number0.5.0
• readonly property ImageRenderable.effectiveProtocol: Exclude<ImageRenderProtocol, "auto">0.5.0
• readonly property ImageRenderable.image: NativeImage | null0.5.0
• readonly property ImageRenderable.loadError: unknown0.5.0
• readonly property ImageRenderable.loading: boolean0.5.0
• static readonly property ImageRenderable.nativeIntegration: NativeRenderableIntegration0.6.0

class InputRenderable extends TextareaRenderableconstructor InputRenderable(ctx: RenderContext, options: InputRenderableOptions)

Input

• method InputRenderable.blur(): void
• method InputRenderable.deleteChar(): boolean
• method InputRenderable.deleteCharBackward(): boolean
• method InputRenderable.deleteCharacter(direction: "backward" | "forward"): void
• method InputRenderable.deleteLine(): boolean
• method InputRenderable.deleteToLineEnd(): boolean
• method InputRenderable.deleteToLineStart(): boolean
• method InputRenderable.deleteWordBackward(): boolean
• method InputRenderable.deleteWordForward(): boolean
• method InputRenderable.focus(): void
• method InputRenderable.insertText(text: string): void
• method InputRenderable.newLine(): boolean
• method InputRenderable.redo(): boolean
• method InputRenderable.submit(): boolean
• method InputRenderable.undo(): boolean
• property InputRenderable.initialValue: string
• property InputRenderable.maxLength: number
• property InputRenderable.minLength: number
• property InputRenderable.placeholder: string
• property InputRenderable.value: string

class InternalKeyHandler extends KeyHandler

Keyboard input

• method InternalKeyHandler.emit<K extends keyof KeyHandlerEventMap>(event: K, ...args: KeyHandlerEventMap[K]): boolean
• method InternalKeyHandler.offInternal<K extends keyof KeyHandlerEventMap>(event: K, handler: (...args: KeyHandlerEventMap[K]) => void): void
• method InternalKeyHandler.onInternal<K extends keyof KeyHandlerEventMap>(event: K, handler: (...args: KeyHandlerEventMap[K]) => void): void

class KeyEvent implements ParsedKeyconstructor KeyEvent(key: ParsedKey)

Keyboard input

• method KeyEvent.preventDefault(): void
• method KeyEvent.stopPropagation(): void
• property KeyEvent.baseCode?: number
• property KeyEvent.capsLock?: boolean
• property KeyEvent.code?: string
• property KeyEvent.ctrl: boolean
• property KeyEvent.eventType: KeyEventType
• property KeyEvent.hyper?: boolean
• property KeyEvent.meta: boolean
• property KeyEvent.name: string
• property KeyEvent.numLock?: boolean
• property KeyEvent.number: boolean
• property KeyEvent.option: boolean
• property KeyEvent.raw: string
• property KeyEvent.repeated?: boolean
• property KeyEvent.sequence: string
• property KeyEvent.shift: boolean
• property KeyEvent.source: "raw" | "kitty"
• property KeyEvent.super?: boolean
• readonly property KeyEvent.defaultPrevented: boolean
• readonly property KeyEvent.propagationStopped: boolean

class KeyHandler extends EventEmitter<KeyHandlerEventMap>

Keyboard input

• method KeyHandler.processParsedKey(parsedKey: ParsedKey): boolean
• method KeyHandler.processPaste(bytes: Uint8Array, metadata?: PasteMetadata): void

class LinearScrollAccel implements ScrollAcceleration

Interaction

• method LinearScrollAccel.reset(): void
• method LinearScrollAccel.tick(_now?: number): number

class LineNumberRenderable extends Renderableconstructor LineNumberRenderable(ctx: RenderContext, options: LineNumberOptions)

Line numbers

• method LineNumberRenderable.add(child: Renderable): number
• method LineNumberRenderable.clearAllLineColors(): void
• method LineNumberRenderable.clearAllLineSigns(): void
• method LineNumberRenderable.clearHighlightLines(startLine: number, endLine: number): void
• method LineNumberRenderable.clearLineColor(line: number): void
• method LineNumberRenderable.clearLineSign(line: number): void
• method LineNumberRenderable.clearTarget(): void
• method LineNumberRenderable.destroy(): void0.5.15
• method LineNumberRenderable.destroyRecursively(): void
• method LineNumberRenderable.getHideLineNumbers(): Set<number>
• method LineNumberRenderable.getLineColors(): { gutter: Map<number, RGBA>; content: Map<number, RGBA>; }
• method LineNumberRenderable.getLineNumbers(): Map<number, number>
• method LineNumberRenderable.getLineSigns(): Map<number, LineSign>
• method LineNumberRenderable.highlightLines(startLine: number, endLine: number, color: string | RGBA | LineColorConfig): void
• method LineNumberRenderable.remove(child: BaseRenderable): void
• method LineNumberRenderable.setHideLineNumbers(hideLineNumbers: Set<number>): void
• method LineNumberRenderable.setLineColor(line: number, color: string | RGBA | LineColorConfig): void
• method LineNumberRenderable.setLineColors(lineColors: Map<number, string | RGBA | LineColorConfig>): void
• method LineNumberRenderable.setLineNumbers(lineNumbers: Map<number, number>): void
• method LineNumberRenderable.setLineSign(line: number, sign: LineSign): void
• method LineNumberRenderable.setLineSigns(lineSigns: Map<number, LineSign>): void
• property LineNumberRenderable.bg: RGBA
• property LineNumberRenderable.fg: RGBA
• property LineNumberRenderable.lineNumberOffset: number
• property LineNumberRenderable.showLineNumbers: boolean
• protected method LineNumberRenderable.destroySelf(): void0.6.0
• protected method LineNumberRenderable.renderSelf(buffer: OptimizedBuffer): void

class MacOSScrollAccel implements ScrollAccelerationconstructor MacOSScrollAccel(opts?: { A?: number; tau?: number; maxMultiplier?: number; })

Interaction

• method MacOSScrollAccel.reset(): void
• method MacOSScrollAccel.tick(now?: number): number

class MarkdownRenderable extends Renderableconstructor MarkdownRenderable(ctx: RenderContext, options: MarkdownOptions)

Markdown

• method MarkdownRenderable.clearCache(): void
• method MarkdownRenderable.refreshStyles(): void
• property MarkdownRenderable.bg: RGBA | undefined
• property MarkdownRenderable.conceal: boolean
• property MarkdownRenderable.concealCode: boolean
• property MarkdownRenderable.content: string
• property MarkdownRenderable.fg: RGBA | undefined
• property MarkdownRenderable.internalBlockMode: "coalesced" | "top-level"
• property MarkdownRenderable.renderNode: MarkdownOptions["renderNode"] | undefined
• property MarkdownRenderable.streaming: boolean
• property MarkdownRenderable.syntaxStyle: SyntaxStyle
• property MarkdownRenderable.tableOptions: MarkdownTableOptions | undefined
• protected method MarkdownRenderable.destroySelf(): void0.5.11
• protected property MarkdownRenderable._contentDefaultOptions: { content: string; conceal: true; concealCode: false; streaming: false; internalBlockMode: "coalesced"; }
• static readonly property MarkdownRenderable.nativeIntegration: NativeRenderableIntegration0.6.0

class MouseEventconstructor MouseEvent(target: Renderable | null, attributes: RawMouseEvent & { source?: Renderable; isDragging?: boolean; })

Renderer

• method MouseEvent.preventDefault(): void
• method MouseEvent.stopPropagation(): void
• readonly property MouseEvent.button: number
• readonly property MouseEvent.currentTarget: Renderable | null0.5.0
• readonly property MouseEvent.defaultPrevented: boolean
• readonly property MouseEvent.isDragging?: boolean
• readonly property MouseEvent.modifiers: { shift: boolean; alt: boolean; ctrl: boolean; }
• readonly property MouseEvent.propagationStopped: boolean
• readonly property MouseEvent.scroll?: ScrollInfo
• readonly property MouseEvent.source?: Renderable
• readonly property MouseEvent.target: Renderable | null
• readonly property MouseEvent.type: MouseEventType
• readonly property MouseEvent.x: number
• readonly property MouseEvent.y: number

class MouseParser

Interaction

• method MouseParser.parseAllMouseEvents(data: Buffer | Uint8Array): RawMouseEvent[]
• method MouseParser.parseMouseEvent(data: Buffer | Uint8Array): RawMouseEvent | null
• method MouseParser.reset(): void

class NativeError extends Errorconstructor NativeError(operation: string, status: NativeStatus)

Added in 0.6.0C

• readonly property NativeError.operation: string0.6.0
• readonly property NativeError.status: NativeStatus0.6.0

class NativeImage

Added in 0.5.0Native images

• method NativeImage.clone(): NativeImage0.5.0
• method NativeImage.composite(overlay: NativeImage, options?: CompositeOptions): NativeImage0.5.0
• method NativeImage.copyTo(destination: Uint8Array, options?: { stride?: number; format?: PixelFormat; }): void0.5.0
• method NativeImage.dispose(): void0.5.0
• method NativeImage.ensureEncodedPng(): void0.5.2
• method NativeImage.extend(options?: ExtendOptions): NativeImage0.5.0
• method NativeImage.extract(options: ExtractOptions): NativeImage0.5.0
• method NativeImage.flip(): NativeImage0.5.0
• method NativeImage.flop(): NativeImage0.5.0
• method NativeImage.info(): ImageInfo0.5.0
• method NativeImage.raw(format?: PixelFormat): RawImage0.5.0
• method NativeImage.resize(options: ResizeOptions): NativeImage0.5.0
• method NativeImage.retain(): NativeImage0.5.2
• method NativeImage.rotate(angle: 90 | 180 | 270): NativeImage0.5.0
• method NativeImage.takeRaw(): OwnedRawImage0.5.0
• readonly property NativeImage.height: number0.5.0
• readonly property NativeImage.ptr: ImageHandle0.5.0
• readonly property NativeImage.width: number0.5.0
• static method NativeImage.decode(data: Uint8Array | ArrayBuffer, options?: ImageCreateOptions): NativeImage0.5.0
• static method NativeImage.fromPixels(pixels: Uint8Array, width: number, height: number, options?: PixelImportOptions): NativeImage0.5.10
• static method NativeImage.fromRgba(pixels: Uint8Array, width: number, height: number, stride?: number, options?: ImageCreateOptions): NativeImage0.5.0
• static method NativeImage.load(source: ImageSource, options?: ImageLoadOptions): Promise<NativeImage>0.5.0

class NativeImagePoolconstructor NativeImagePool(options: NativeImagePoolOptions)

Added in 0.5.10Native images

• method NativeImagePool.dispose(): void0.5.10
• method NativeImagePool.publishPixels(pixels: Uint8Array, options?: PixelImportOptions): NativeImage | null0.5.10
• method NativeImagePool.publishRgba(pixels: Uint8Array, stride?: number): NativeImage | null0.5.10
• readonly property NativeImagePool.capacity: number0.5.10
• readonly property NativeImagePool.height: number0.5.10
• readonly property NativeImagePool.width: number0.5.10

class NativeSessionconstructor NativeSession(sink: Writable, options?: NativeSessionDriverOptions, owner?: NativeSession | undefined)

Added in 0.6.0How Core uses native

• method NativeSession.attachRenderer(options: NativeSessionRendererOptions, beforeDispose?: () => void): void0.6.0
• method NativeSession.cancelKittyImageTransport(failed: boolean): void0.6.0
• method NativeSession.close(): Promise<void>0.6.0
• method NativeSession.control(command: NativeSessionControl): void0.6.0
• method NativeSession.dispose(): void0.6.0
• method NativeSession.getCapabilities(): NativeSessionCapabilities0.6.0
• method NativeSession.getKittyImageTransport(): NativeSessionKittyImageTransportStatus0.6.0
• method NativeSession.idle(): Promise<void>0.6.0
• method NativeSession.isCloseInterruption(error: unknown): boolean0.6.0
• method NativeSession.pollKittyImageTransport(): boolean0.6.0
• method NativeSession.processKittyImageReply(bytes: Uint8Array): number0.6.0
• method NativeSession.render(force: boolean, frame: NativeSceneFrameRequest): NativeSessionRenderStatus0.6.0
• method NativeSession.resize(width: number, height: number): void0.6.0
• method NativeSession.resume(): Promise<void>0.6.0
• method NativeSession.setKittyImageTransport(mode: number): void0.6.0
• method NativeSession.setupTerminal(options?: NativeSessionTerminalOptions): Promise<void>0.6.0
• method NativeSession.startKittyFileProbe(): void0.6.0
• method NativeSession.suspend(): Promise<void>0.6.0
• method NativeSession.triggerNotification(message: string, title?: string): boolean0.6.0
• method NativeSession.usesOutput(sink: Writable): boolean0.6.0
• method NativeSession.whenPresented(): Promise<void>0.6.0
• method NativeSession.write(bytes: Uint8Array): boolean0.6.0
• method NativeSession.writeClipboard(target: number, bytes: Uint8Array): boolean0.6.0
• readonly property NativeSession.closed: Promise<void>0.6.0
• readonly property NativeSession.context: NativeContextHandle0.6.0
• readonly property NativeSession.contextDisposed: boolean0.6.0
• readonly property NativeSession.disposed: boolean0.6.0
• readonly property NativeSession.error: Error | null0.6.0
• readonly property NativeSession.maxAtomicWriteBytes: bigint0.6.0
• readonly property NativeSession.maxWriteBytes: bigint0.6.0
• readonly property NativeSession.renderLib: RenderLib0.6.0
• readonly property NativeSession.resourceContext: ResourceContext0.6.0
• readonly property NativeSession.session: Readonly<SessionHandle>0.6.0

class NativeSpanFeed

NativeSpanFeed

• method NativeSpanFeed.close(): void
• method NativeSpanFeed.drainAll(): void
• method NativeSpanFeed.idle(): Promise<void>
• method NativeSpanFeed.isBackpressured(): boolean
• method NativeSpanFeed.onData(handler: DataHandler): () => void
• method NativeSpanFeed.onError(handler: (code: number) => void): () => void
• readonly property NativeSpanFeed.streamPtr: Pointer
• static method NativeSpanFeed.attach(streamPtr: Pointer, _options?: NativeSpanFeedOptions): NativeSpanFeed
• static method NativeSpanFeed.create(options?: NativeSpanFeedOptions): NativeSpanFeed

class OptimizedBuffer

Buffer API

• method OptimizedBuffer.clear(bg?: RGBA): void
• method OptimizedBuffer.clearOpacity(): void
• method OptimizedBuffer.clearScissorRects(): void
• method OptimizedBuffer.colorMatrix(matrix: Float32Array, cellMask: Float32Array, strength?: number, target?: TargetChannel): void
• method OptimizedBuffer.colorMatrixUniform(matrix: Float32Array, strength?: number, target?: TargetChannel): void
• method OptimizedBuffer.destroy(): void
• method OptimizedBuffer.drawBox(options: { x: number; y: number; width: number; height: number; borderStyle?: BorderStyle; customBorderChars?: Uint32Array; border: boolean | BorderSides[]; borderColor: RGBA; backgroundColor: RGBA; shouldFill?: boolean; title?: string; titleColor?: RGBA; titleAlignment?: "left" | "center" | "right"; bottomTitle?: string; bottomTitleAlignment?: "left" | "center" | "right"; }): void
• method OptimizedBuffer.drawChar(char: number, x: number, y: number, fg: RGBA, bg: RGBA, attributes?: number): void
• method OptimizedBuffer.drawEditorView(editorView: EditorView, x: number, y: number): void
• method OptimizedBuffer.drawFrameBuffer(destX: number, destY: number, frameBuffer: OptimizedBuffer, sourceX?: number, sourceY?: number, sourceWidth?: number, sourceHeight?: number): void
• method OptimizedBuffer.drawGrayscaleBuffer(posX: number, posY: number, intensities: Float32Array, srcWidth: number, srcHeight: number, fg?: RGBA | null, bg?: RGBA | null): void
• method OptimizedBuffer.drawGrayscaleBufferSupersampled(posX: number, posY: number, intensities: Float32Array, srcWidth: number, srcHeight: number, fg?: RGBA | null, bg?: RGBA | null): void
• method OptimizedBuffer.drawGrid(options: NativeBufferGrid): void
• method OptimizedBuffer.drawImage(image: NativeImage, x: number, y: number, width: number, height: number, pixelWidth?: number, pixelHeight?: number, sourceX?: number, sourceY?: number, sourceWidth?: number, sourceHeight?: number, protocol?: ImageRenderProtocol): boolean0.5.0
• method OptimizedBuffer.drawPackedBuffer(data: PointerInput | Uint8Array, dataLen: number, posX: number, posY: number, terminalWidthCells: number, terminalHeightCells: number): void
• method OptimizedBuffer.drawSuperSampleBuffer(x: number, y: number, pixelData: PointerInput | Uint8Array, pixelDataLength: number, format: "bgra8unorm" | "rgba8unorm", alignedBytesPerRow: number): void
• method OptimizedBuffer.drawText(text: string, x: number, y: number, fg: RGBA, bg?: RGBA, attributes?: number, selection?: { start: number; end: number; bgColor?: RGBA; fgColor?: RGBA; } | null): void
• method OptimizedBuffer.drawTextBuffer(textBufferView: TextBufferView, x: number, y: number): void
• method OptimizedBuffer.encodeUnicode(text: string): EncodedUnicode
• method OptimizedBuffer.fillRect(x: number, y: number, width: number, height: number, bg: RGBA): void
• method OptimizedBuffer.freeUnicode(encoded: EncodedUnicode): void
• method OptimizedBuffer.getCurrentOpacity(): number
• method OptimizedBuffer.getRealCharBytes(addLineBreaks?: boolean): Uint8Array
• method OptimizedBuffer.getSpanLines(): CapturedLine[]
• method OptimizedBuffer.popOpacity(): void
• method OptimizedBuffer.popScissorRect(): void
• method OptimizedBuffer.pushOpacity(opacity: number): void
• method OptimizedBuffer.pushScissorRect(x: number, y: number, width: number, height: number): void
• method OptimizedBuffer.resize(width: number, height: number): void
• method OptimizedBuffer.setCell(x: number, y: number, char: string, fg: RGBA, bg: RGBA, attributes?: number): void
• method OptimizedBuffer.setCellWithAlphaBlending(x: number, y: number, char: string, fg: RGBA, bg: RGBA, attributes?: number): void
• method OptimizedBuffer.setRespectAlpha(respectAlpha: boolean): void
• method OptimizedBuffer.withBuffers<T>(callback: (cells: BufferAccess) => T): T0.6.0
• property OptimizedBuffer.id: string
• property OptimizedBuffer.lib: RenderLib
• property OptimizedBuffer.respectAlpha: boolean
• readonly property OptimizedBuffer.buffers: { char: Uint32Array; fg: Uint16Array; bg: Uint16Array; attributes: Uint32Array; }
• readonly property OptimizedBuffer.height: number
• readonly property OptimizedBuffer.width: number
• readonly property OptimizedBuffer.widthMethod: WidthMethod
• static method OptimizedBuffer.create(width: number, height: number, widthMethod: WidthMethod, options: { respectAlpha?: boolean; id?: string; owner: NativeResourceOwner; }): OptimizedBuffer
• static method OptimizedBuffer.fromSession(lib: RenderLib, context: NativeContextHandle, session: SessionHandle, which: SessionBuffer, getFrame?: () => NativeSceneFrameRequest | null): OptimizedBuffer0.6.0

class PasteEventconstructor PasteEvent(bytes: Uint8Array, metadata?: PasteMetadata)

Keyboard input

• method PasteEvent.preventDefault(): void
• method PasteEvent.stopPropagation(): void
• property PasteEvent.bytes: Uint8Array
• property PasteEvent.metadata?: PasteMetadata
• property PasteEvent.type: "paste"
• readonly property PasteEvent.defaultPrevented: boolean
• readonly property PasteEvent.propagationStopped: boolean

class RainbowTextEffectconstructor RainbowTextEffect(speed?: number, saturation?: number, value?: number, repeats?: number)

Post-processing effects

• method RainbowTextEffect.apply(buffer: OptimizedBuffer, deltaTime: number): void
• property RainbowTextEffect.repeats: number
• property RainbowTextEffect.saturation: number
• property RainbowTextEffect.speed: number
• property RainbowTextEffect.value: number

abstract class Renderable extends BaseRenderableconstructor Renderable(ctx: RenderContext, options: RenderableOptions<any>)

Renderables

• method Renderable.add(obj: Renderable | VNode<any, any[]> | unknown, index?: number): number
• method Renderable.addListener(event: string | symbol, listener: (...args: any[]) => void): this0.6.0
• method Renderable.assertMutable(): void0.6.0
• method Renderable.blur(): void
• method Renderable.destroy(): void
• method Renderable.destroyRecursively(): void
• method Renderable.findDescendantById(id: string): Renderable | undefined
• method Renderable.focus(): void
• method Renderable.getChildren(): Renderable[]
• method Renderable.getChildrenCount(): number
• method Renderable.getChildrenSortedByPrimaryAxis(): Renderable[]
• method Renderable.getComputedLayout(): Layout0.6.0
• method Renderable.getLayout(): Readonly<Layout>0.6.0
• method Renderable.getMargin(edge: Edge): Value0.6.0
• method Renderable.getRenderable(id: string): Renderable | undefined
• method Renderable.getSelectedText(): string
• method Renderable.getWidth(): Value0.6.0
• method Renderable.handleKeyPress?(key: KeyEvent): boolean
• method Renderable.handlePaste?(event: PasteEvent): void
• method Renderable.hasSelection(): boolean
• method Renderable.insertBefore(obj: Renderable | VNode<any, any[]> | unknown, anchor?: Renderable | unknown): number
• method Renderable.invalidateIntrinsicSize(): void0.6.0
• method Renderable.isFreed(): boolean0.6.0
• method Renderable.off(event: string | symbol, listener: (...args: any[]) => void): this0.6.0
• method Renderable.on(event: string | symbol, listener: (...args: any[]) => void): this0.6.0
• method Renderable.onSelectionChanged(selection: Selection | null): boolean
• method Renderable.prependListener(event: string | symbol, listener: (...args: any[]) => void): this0.6.0
• method Renderable.processMouseEvent(event: MouseEvent): void
• method Renderable.refreshHooks(): void0.6.0
• method Renderable.remove(child: BaseRenderable): void
• method Renderable.removeAllListeners(event?: string | symbol): this0.6.0
• method Renderable.removeListener(event: string | symbol, listener: (...args: any[]) => void): this0.6.0
• method Renderable.requestRender(): void
• method Renderable.runMutation<T>(operation: () => T): T0.6.0
• method Renderable.setMeasureProvider(provider: MeasureFunction | null): void0.6.0
• method Renderable.setPosition(position: Position): void
• method Renderable.shouldStartSelection(x: number, y: number): boolean
• property Renderable.alignItems: AlignString | null | undefined
• property Renderable.alignSelf: AlignString | null | undefined
• property Renderable.bottom: number | "auto" | `${number}%` | undefined
• property Renderable.flexBasis: number | "auto" | null | undefined
• property Renderable.flexDirection: FlexDirectionString | null | undefined
• property Renderable.flexGrow: number | null | undefined
• property Renderable.flexShrink: number | null | undefined
• property Renderable.flexWrap: WrapString | null | undefined
• property Renderable.focusable: boolean
• property Renderable.height: number
• property Renderable.justifyContent: JustifyString | null | undefined
• property Renderable.left: number | "auto" | `${number}%` | undefined
• property Renderable.live: boolean
• property Renderable.margin: number | "auto" | `${number}%` | null | undefined
• property Renderable.marginBottom: number | "auto" | `${number}%` | null | undefined
• property Renderable.marginLeft: number | "auto" | `${number}%` | null | undefined
• property Renderable.marginRight: number | "auto" | `${number}%` | null | undefined
• property Renderable.marginTop: number | "auto" | `${number}%`
• property Renderable.marginX: number | "auto" | `${number}%` | null | undefined
• property Renderable.marginY: number | "auto" | `${number}%` | null | undefined
• property Renderable.maxHeight: number | `${number}%` | null | undefined
• property Renderable.maxWidth: number | `${number}%` | null | undefined
• property Renderable.minHeight: number | `${number}%` | null | undefined
• property Renderable.minWidth: number | `${number}%` | null | undefined
• property Renderable.onKeyDown: ((key: KeyEvent) => void) | undefined
• property Renderable.onLifecyclePass: (() => void) | null
• property Renderable.onMouse: ((event: MouseEvent) => void) | undefined
• property Renderable.onMouseDown: ((event: MouseEvent) => void) | undefined
• property Renderable.onMouseDrag: ((event: MouseEvent) => void) | undefined
• property Renderable.onMouseDragEnd: ((event: MouseEvent) => void) | undefined
• property Renderable.onMouseDrop: ((event: MouseEvent) => void) | undefined
• property Renderable.onMouseMove: ((event: MouseEvent) => void) | undefined
• property Renderable.onMouseOut: ((event: MouseEvent) => void) | undefined
• property Renderable.onMouseOver: ((event: MouseEvent) => void) | undefined
• property Renderable.onMouseScroll: ((event: MouseEvent) => void) | undefined
• property Renderable.onMouseUp: ((event: MouseEvent) => void) | undefined
• property Renderable.onPaste: ((event: PasteEvent) => void) | undefined
• property Renderable.onSizeChange: (() => void) | undefined
• property Renderable.opacity: number
• property Renderable.overflow: OverflowString
• property Renderable.padding: number | `${number}%` | null | undefined
• property Renderable.paddingBottom: number | `${number}%` | null | undefined
• property Renderable.paddingLeft: number | `${number}%` | null | undefined
• property Renderable.paddingRight: number | `${number}%` | null | undefined
• property Renderable.paddingTop: number | `${number}%` | null | undefined
• property Renderable.paddingX: number | `${number}%` | null | undefined
• property Renderable.paddingY: number | `${number}%` | null | undefined
• property Renderable.parent: Renderable | null
• property Renderable.position: PositionTypeString | null | undefined
• property Renderable.renderAfter?: (this: Renderable, buffer: OptimizedBuffer, deltaTime: number) => void
• property Renderable.renderBefore?: (this: Renderable, buffer: OptimizedBuffer, deltaTime: number) => void
• property Renderable.right: number | "auto" | `${number}%` | undefined
• property Renderable.selectable: boolean
• property Renderable.top: number | "auto" | `${number}%` | undefined
• property Renderable.translateX: number
• property Renderable.translateY: number
• property Renderable.visible: boolean
• property Renderable.width: number
• property Renderable.x: number
• property Renderable.y: number
• property Renderable.zIndex: number
• protected method Renderable._invokeNativePaint(buffer: OptimizedBuffer, deltaTime: number): void0.6.0
• protected method Renderable.abortConstruction(error: unknown, cleanup?: (run: (step: () => void) => void) => void): never0.6.0
• protected method Renderable.assignOptions(target: Renderable, options: object | undefined): void0.6.0
• protected method Renderable.createFrameBuffer(): void
• protected method Renderable.destroyOwnedResources(): void0.6.0
• protected method Renderable.destroySelf(): void
• protected method Renderable.getNativeScenePaint(): NativeScenePaint0.6.0
• protected method Renderable.handleFrameBufferResize(width: number, height: number): void
• protected method Renderable.onLayoutResize(width: number, height: number): void
• protected method Renderable.onLiveCountChanged(previous: number): void0.6.0
• protected method Renderable.onMouseEvent(event: MouseEvent): void
• protected method Renderable.onRemove(): void
• protected method Renderable.onResize(width: number, height: number): void
• protected method Renderable.onUpdate(deltaTime: number): void
• protected method Renderable.propagateFocusChange(hasFocus: boolean): void
• protected method Renderable.propagateLiveCount(delta: number): void
• protected method Renderable.refreshNativeSceneHooks(): void0.6.0
• protected method Renderable.renderSelf(buffer: OptimizedBuffer, deltaTime: number): void
• protected method Renderable.rollbackConstruction(error: unknown): never0.6.0
• protected method Renderable.runCleanup(steps: (run: (step: () => void) => void) => void): void0.6.0
• protected method Renderable.setGap(gutter: Gutter, gap: number | `${number}%` | undefined): void0.6.0
• protected method Renderable.setNativeScenePaint(paint?: Partial<NativeScenePaint>): void0.6.0
• protected property Renderable._childrenInLayoutOrder: Renderable[]
• protected property Renderable._ctx: RenderContext
• protected property Renderable._focusable: boolean
• protected property Renderable._focused: boolean
• protected property Renderable._hasFocusedDescendant: boolean
• protected property Renderable._height: number | "auto" | `${number}%`
• protected property Renderable._isDestroyed: boolean
• protected property Renderable._liveCount: number
• protected property Renderable._nativeSceneHookGeneration: bigint0.6.0
• protected property Renderable._opacity: number
• protected property Renderable._overflow: OverflowString
• protected property Renderable._position: Position
• protected property Renderable._positionType: PositionTypeString
• protected property Renderable._translateX: number
• protected property Renderable._translateY: number
• protected property Renderable._width: number | "auto" | `${number}%`
• protected property Renderable._zIndex: number0.6.0
• protected property Renderable.buffered: boolean
• protected property Renderable.frameBuffer: OptimizedBuffer | null
• protected property Renderable.keypressHandler: ((key: KeyEvent) => void) | null
• protected property Renderable.pasteHandler: ((event: PasteEvent) => void) | null
• protected readonly property Renderable._screenX: number
• protected readonly property Renderable._screenY: number
• readonly property Renderable.ctx: RenderContext
• readonly property Renderable.focused: boolean
• readonly property Renderable.hasFocusedDescendant: boolean
• readonly property Renderable.isDestroyed: boolean
• readonly property Renderable.liveCount: number
• readonly property Renderable.primaryAxis: "row" | "column"
• readonly property Renderable.screenX: number
• readonly property Renderable.screenY: number
• static property Renderable.renderablesByNumber: Map<number, Renderable>
• static protected method Renderable.defineNativeIntegration(integration: NativeRenderableIntegration): NativeRenderableIntegration0.6.0
• static protected readonly property Renderable.defaultFocusable: boolean0.6.0
• static readonly property Renderable.nativeIntegration: NativeRenderableIntegration0.6.0

class ResourceContext implements NativeResourceOwnerconstructor ResourceContext(options: NativeContextOptions)

Added in 0.6.0How Core uses native

• method ResourceContext.assertAlive(): void0.6.0
• method ResourceContext.destroy(): void0.6.0
• readonly property ResourceContext.context: NativeContextHandle0.6.0
• readonly property ResourceContext.disposed: boolean0.6.0
• readonly property ResourceContext.renderLib: RenderLib0.6.0
• readonly property ResourceContext.resourceContext: ResourceContext0.6.0

class RGBAconstructor RGBA(buffer: Uint16Array)

Colors

• method RGBA.equals(other?: RGBA): boolean
• method RGBA.map<R>(fn: (value: number) => R): [ R, R, R, R ]
• method RGBA.toInts(): [ number, number, number, number ]
• method RGBA.toString(): string
• property RGBA.a: number
• property RGBA.b: number
• property RGBA.buffer: Uint16Array
• property RGBA.g: number
• property RGBA.r: number
• readonly property RGBA.intent: ColorIntent
• readonly property RGBA.meta: number
• readonly property RGBA.slot: number
• static method RGBA.clone(rgba: RGBA): RGBA
• static method RGBA.defaultBackground(snapshot?: ColorInput): RGBA
• static method RGBA.defaultForeground(snapshot?: ColorInput): RGBA
• static method RGBA.fromArray(array: Uint16Array): RGBA
• static method RGBA.fromHex(hex: string): RGBA
• static method RGBA.fromIndex(index: number, snapshot?: ColorInput): RGBA
• static method RGBA.fromInts(r: number, g: number, b: number, a?: number): RGBA
• static method RGBA.fromValues(r: number, g: number, b: number, a?: number): RGBA

class RootRenderable extends Renderableconstructor RootRenderable(ctx: RenderContext)

Renderables

• method RootRenderable.resize(width: number, height: number): void
• method RootRenderable.takeCurrentRenderable(): Renderable | undefined0.5.0
• protected method RootRenderable.onLiveCountChanged(previous: number): void0.6.0
• protected method RootRenderable.propagateLiveCount(delta: number): void
• readonly property RootRenderable.currentRenderable: Renderable | undefined0.5.0
• static readonly property RootRenderable.nativeIntegration: NativeRenderableIntegration0.6.0

class RootTextNodeRenderable extends TextNodeRenderableconstructor RootTextNodeRenderable(ctx: RenderContext, options: TextNodeOptions, textParent: TextRenderable)

Text and terminal cells

• method RootTextNodeRenderable.requestRender(): void
• property RootTextNodeRenderable.textParent: TextRenderable

class ScrollBarRenderable extends Renderableconstructor ScrollBarRenderable(ctx: RenderContext, { trackOptions, arrowOptions, orientation, showArrows, ...options }: ScrollBarOptions)

ScrollBar

• method ScrollBarRenderable.handleKeyPress(key: KeyEvent): boolean
• method ScrollBarRenderable.resetVisibilityControl(): void
• method ScrollBarRenderable.scrollBy(delta: number, unit?: ScrollUnit): void
• property ScrollBarRenderable.arrowOptions: ScrollBarOptions["arrowOptions"]
• property ScrollBarRenderable.scrollPosition: number
• property ScrollBarRenderable.scrollSize: number
• property ScrollBarRenderable.scrollStep: number | undefined | null
• property ScrollBarRenderable.showArrows: boolean
• property ScrollBarRenderable.trackOptions: ScrollBarOptions["trackOptions"]
• property ScrollBarRenderable.viewportSize: number
• property ScrollBarRenderable.visible: boolean
• protected method ScrollBarRenderable.destroyOwnedResources(): void0.6.0
• readonly property ScrollBarRenderable.endArrow: ArrowRenderable
• readonly property ScrollBarRenderable.orientation: "vertical" | "horizontal"
• readonly property ScrollBarRenderable.slider: SliderRenderable
• readonly property ScrollBarRenderable.startArrow: ArrowRenderable
• static protected readonly property ScrollBarRenderable.defaultFocusable = true0.6.0
• static readonly property ScrollBarRenderable.nativeIntegration: NativeRenderableIntegration0.6.0

class ScrollBoxRenderable extends BoxRenderableconstructor ScrollBoxRenderable(ctx: RenderContext, options: ScrollBoxOptions)

ScrollBox

• method ScrollBoxRenderable.add(obj: Renderable | VNode<any, any[]>, index?: number): number
• method ScrollBoxRenderable.getChildren(): Renderable[]
• method ScrollBoxRenderable.getRenderable(id: string): Renderable | undefined0.4.3
• method ScrollBoxRenderable.handleKeyPress(key: KeyEvent): boolean
• method ScrollBoxRenderable.insertBefore(obj: Renderable | VNode<any, any[]> | unknown, anchor?: Renderable | unknown): number
• method ScrollBoxRenderable.remove(child: BaseRenderable): void
• method ScrollBoxRenderable.scrollBy(delta: number | { x: number; y: number; }, unit?: ScrollUnit): void
• method ScrollBoxRenderable.scrollChildIntoView(childId: string): void
• method ScrollBoxRenderable.scrollTo(position: number | { x: number; y: number; }): void
• method ScrollBoxRenderable.startAutoScroll(mouseX: number, mouseY: number): void
• method ScrollBoxRenderable.stopAutoScroll(): void
• method ScrollBoxRenderable.updateAutoScroll(mouseX: number, mouseY: number): void
• property ScrollBoxRenderable.contentOptions: ScrollBoxOptions["contentOptions"]
• property ScrollBoxRenderable.horizontalScrollbarOptions: ScrollBoxOptions["horizontalScrollbarOptions"]
• property ScrollBoxRenderable.padding: number | `${number}%` | null | undefined
• property ScrollBoxRenderable.paddingBottom: number | `${number}%` | null | undefined
• property ScrollBoxRenderable.paddingLeft: number | `${number}%` | null | undefined
• property ScrollBoxRenderable.paddingRight: number | `${number}%` | null | undefined
• property ScrollBoxRenderable.paddingTop: number | `${number}%` | null | undefined
• property ScrollBoxRenderable.paddingX: number | `${number}%` | null | undefined
• property ScrollBoxRenderable.paddingY: number | `${number}%` | null | undefined
• property ScrollBoxRenderable.rootOptions: ScrollBoxOptions["rootOptions"]
• property ScrollBoxRenderable.scrollAcceleration: ScrollAcceleration
• property ScrollBoxRenderable.scrollLeft: number
• property ScrollBoxRenderable.scrollTop: number
• property ScrollBoxRenderable.scrollbarOptions: ScrollBoxOptions["scrollbarOptions"]
• property ScrollBoxRenderable.stickyScroll: boolean
• property ScrollBoxRenderable.stickyStart: "bottom" | "top" | "left" | "right" | undefined
• property ScrollBoxRenderable.verticalScrollbarOptions: ScrollBoxOptions["verticalScrollbarOptions"]
• property ScrollBoxRenderable.viewportCulling: boolean
• property ScrollBoxRenderable.viewportOptions: ScrollBoxOptions["viewportOptions"]
• property ScrollBoxRenderable.wrapperOptions: ScrollBoxOptions["wrapperOptions"]
• protected method ScrollBoxRenderable.destroySelf(): void
• protected method ScrollBoxRenderable.onMouseEvent(event: MouseEvent): void
• protected method ScrollBoxRenderable.onUpdate(deltaTime: number): void
• readonly property ScrollBoxRenderable.content: ContentRenderable
• readonly property ScrollBoxRenderable.horizontalScrollBar: ScrollBarRenderable
• readonly property ScrollBoxRenderable.scrollHeight: number
• readonly property ScrollBoxRenderable.scrollWidth: number
• readonly property ScrollBoxRenderable.verticalScrollBar: ScrollBarRenderable
• readonly property ScrollBoxRenderable.viewport: BoxRenderable
• readonly property ScrollBoxRenderable.wrapper: BoxRenderable
• static property ScrollBoxRenderable.idCounter: number
• static protected readonly property ScrollBoxRenderable.defaultFocusable = true0.6.0
• static readonly property ScrollBoxRenderable.nativeIntegration: NativeRenderableIntegration0.6.0

class Selectionconstructor Selection(anchorRenderable: Renderable, anchor: { x: number; y: number; }, focus: { x: number; y: number; }, behavior?: SelectionBehavior)

Interaction

• method Selection.getSelectedText(): string
• method Selection.updateSelectedRenderables(selectedRenderables: Renderable[]): void
• method Selection.updateTouchedRenderables(touchedRenderables: Renderable[]): void
• property Selection.behavior: SelectionBehavior0.5.7
• property Selection.focus: { x: number; y: number; }
• property Selection.isActive: boolean
• property Selection.isDragging: boolean
• property Selection.isStart: boolean
• readonly property Selection.anchor: { x: number; y: number; }
• readonly property Selection.bounds: ViewportBounds
• readonly property Selection.selectedRenderables: Renderable[]
• readonly property Selection.touchedRenderables: Renderable[]

class SelectRenderable extends Renderableconstructor SelectRenderable(ctx: RenderContext, options: SelectRenderableOptions)

Select

• method SelectRenderable.getSelectedIndex(): number
• method SelectRenderable.getSelectedOption(): SelectOption | null
• method SelectRenderable.handleKeyPress(key: KeyEvent): boolean
• method SelectRenderable.moveDown(steps?: number): void
• method SelectRenderable.moveUp(steps?: number): void
• method SelectRenderable.selectCurrent(): void
• method SelectRenderable.setSelectedIndex(index: number): void
• property SelectRenderable.backgroundColor: ColorInput
• property SelectRenderable.descriptionColor: ColorInput
• property SelectRenderable.fastScrollStep: number
• property SelectRenderable.focusedBackgroundColor: ColorInput
• property SelectRenderable.focusedTextColor: ColorInput
• property SelectRenderable.font: keyof typeof fonts
• property SelectRenderable.itemSpacing: number
• property SelectRenderable.keyAliasMap: KeyAliasMap
• property SelectRenderable.keyBindings: SelectKeyBinding[]
• property SelectRenderable.options: SelectOption[]
• property SelectRenderable.selectedBackgroundColor: ColorInput
• property SelectRenderable.selectedDescriptionColor: ColorInput
• property SelectRenderable.selectedIndex: number
• property SelectRenderable.selectedTextColor: ColorInput
• property SelectRenderable.showDescription: boolean
• property SelectRenderable.showScrollIndicator: boolean
• property SelectRenderable.showSelectionIndicator: boolean0.4.3
• property SelectRenderable.textColor: ColorInput
• property SelectRenderable.wrapSelection: boolean
• protected method SelectRenderable.onResize(width: number, height: number): void
• protected method SelectRenderable.renderSelf(buffer: OptimizedBuffer, deltaTime: number): void
• protected property SelectRenderable._defaultOptions: { backgroundColor: string; textColor: string; focusedBackgroundColor: string; focusedTextColor: string; selectedBackgroundColor: string; selectedTextColor: string; selectedIndex: number; descriptionColor: string; selectedDescriptionColor: string; showScrollIndicator: false; wrapSelection: false; showDescription: true; showSelectionIndicator: true; itemSpacing: number; fastScrollStep: number; }
• static protected readonly property SelectRenderable.defaultFocusable = true0.6.0

class SliderRenderable extends Renderableconstructor SliderRenderable(ctx: RenderContext, options: SliderOptions)

Slider

• property SliderRenderable.backgroundColor: RGBA
• property SliderRenderable.foregroundColor: RGBA
• property SliderRenderable.max: number
• property SliderRenderable.min: number
• property SliderRenderable.orientation: "vertical" | "horizontal"
• property SliderRenderable.value: number
• property SliderRenderable.viewPortSize: number
• protected method SliderRenderable.renderSelf(buffer: OptimizedBuffer): void
• static readonly property SliderRenderable.nativeIntegration: NativeRenderableIntegration0.6.0

class SlotRegistry<TNode, TSlots extends object, TContext extends PluginContext = PluginContext>constructor SlotRegistry(renderer: CliRenderer, context: TContext, options?: SlotRegistryOptions)

Overview

• method SlotRegistry.batch<T>(run: () => T): T
• method SlotRegistry.clear(): void
• method SlotRegistry.clearPluginErrors(): void
• method SlotRegistry.configure(options: SlotRegistryOptions): void
• method SlotRegistry.getPluginErrors(): readonly PluginErrorEvent[]
• method SlotRegistry.onPluginError(listener: (event: PluginErrorEvent) => void): () => void
• method SlotRegistry.register(plugin: Plugin<TNode, TSlots, TContext>): () => void
• method SlotRegistry.reportPluginError(report: PluginErrorReport): PluginErrorEvent
• method SlotRegistry.resolve<K extends keyof TSlots>(slot: K): Array<SlotRenderer<TNode, TSlots[K], TContext>>
• method SlotRegistry.resolveEntries<K extends keyof TSlots>(slot: K): Array<ResolvedSlotRenderer<TNode, TSlots[K], TContext>>
• method SlotRegistry.subscribe(listener: () => void): () => void
• method SlotRegistry.unregister(id: string): boolean
• method SlotRegistry.updateOrder(id: string, order: number): boolean
• readonly property SlotRegistry.context: Readonly<TContext>
• readonly property SlotRegistry.renderer: CliRenderer

class SlotRenderable<TSlotName extends string = string, TContext extends PluginContext = PluginContext, TData extends object = Record<string, unknown>> extends Renderableconstructor SlotRenderable(ctx: RenderContext, options: SlotRenderableOptions<TSlotName, TSlotName, TContext, TData>)

Core

• method SlotRenderable.refresh(): void
• property SlotRenderable.data: TData
• property SlotRenderable.mode: CoreSlotMode
• protected method SlotRenderable.destroySelf(): void

class StdinParserconstructor StdinParser(options?: StdinParserOptions)

Keyboard input

• method StdinParser.abortPendingStartupCursorCpr(): void
• method StdinParser.destroy(): void
• method StdinParser.drain(onEvent: (event: StdinEvent) => void): void
• method StdinParser.flushTimeout(nowMsValue?: number): void
• method StdinParser.hasPendingPixelResolutionResponse(): boolean0.5.0
• method StdinParser.pausePendingTimeout(): void0.5.0
• method StdinParser.push(data: Uint8Array): void
• method StdinParser.read(): StdinEvent | null
• method StdinParser.reset(): void
• method StdinParser.resetMouseState(): void
• method StdinParser.resumePendingTimeout(): void0.5.0
• method StdinParser.updateProtocolContext(patch: Partial<StdinParserProtocolContext>): void
• readonly property StdinParser.bufferCapacity: number

class StyledTextconstructor StyledText(chunks: TextChunk[])

Text and terminal cells

• property StyledText.[BrandedStyledText]: boolean
• property StyledText.chunks: TextChunk[]

class SyntaxStyleconstructor SyntaxStyle(lib: RenderLib, handle: ContextSyntaxStyleHandle, source: NativeResourceOwner)

Tree-sitter

• method SyntaxStyle.clearCache(): void
• method SyntaxStyle.clearNameCache(): void
• method SyntaxStyle.destroy(): void
• method SyntaxStyle.getAllStyles(): Map<string, StyleDefinition>
• method SyntaxStyle.getCacheSize(): number
• method SyntaxStyle.getRegisteredNames(): string[]
• method SyntaxStyle.getStyle(name: string): StyleDefinition | undefined
• method SyntaxStyle.getStyleCount(): number
• method SyntaxStyle.getStyleId(name: string): number | null
• method SyntaxStyle.mergeStyles(...styleNames: string[]): MergedStyle
• method SyntaxStyle.registerStyle(name: string, style: StyleDefinitionInput): number
• method SyntaxStyle.resolveStyleId(name: string): number | null
• static method SyntaxStyle.create(source: NativeResourceOwner): SyntaxStyle
• static method SyntaxStyle.fromStyles(styles: Record<string, StyleDefinitionInput> | Map<string, StyleDefinitionInput>, owner: NativeResourceOwner): SyntaxStyle
• static method SyntaxStyle.fromTheme(theme: ThemeTokenStyle[], owner: NativeResourceOwner): SyntaxStyle

class SystemClock implements Clock

Animation and Timeline

• method SystemClock.clearInterval(handle: TimerHandle): void
• method SystemClock.clearTimeout(handle: TimerHandle): void
• method SystemClock.now(): number
• method SystemClock.setInterval(fn: () => void, delayMs: number): TimerHandle
• method SystemClock.setTimeout(fn: () => void, delayMs: number): TimerHandle

class TabSelectRenderable extends Renderableconstructor TabSelectRenderable(ctx: RenderContext, options: TabSelectRenderableOptions)

TabSelect

• method TabSelectRenderable.getSelectedIndex(): number
• method TabSelectRenderable.getSelectedOption(): TabSelectOption | null
• method TabSelectRenderable.getTabWidth(): number
• method TabSelectRenderable.handleKeyPress(key: KeyEvent): boolean
• method TabSelectRenderable.moveLeft(): void
• method TabSelectRenderable.moveRight(): void
• method TabSelectRenderable.selectCurrent(): void
• method TabSelectRenderable.setOptions(options: TabSelectOption[]): void
• method TabSelectRenderable.setSelectedIndex(index: number): void
• method TabSelectRenderable.setTabWidth(tabWidth: number): void
• property TabSelectRenderable.backgroundColor: ColorInput
• property TabSelectRenderable.focusedBackgroundColor: ColorInput
• property TabSelectRenderable.focusedTextColor: ColorInput
• property TabSelectRenderable.keyAliasMap: KeyAliasMap
• property TabSelectRenderable.keyBindings: TabSelectKeyBinding[]
• property TabSelectRenderable.options: TabSelectOption[]
• property TabSelectRenderable.selectedBackgroundColor: ColorInput
• property TabSelectRenderable.selectedDescriptionColor: ColorInput
• property TabSelectRenderable.selectedTextColor: ColorInput
• property TabSelectRenderable.showDescription: boolean
• property TabSelectRenderable.showScrollArrows: boolean
• property TabSelectRenderable.showUnderline: boolean
• property TabSelectRenderable.tabWidth: number
• property TabSelectRenderable.textColor: ColorInput
• property TabSelectRenderable.wrapSelection: boolean
• protected method TabSelectRenderable.onResize(width: number, height: number): void
• protected method TabSelectRenderable.renderSelf(buffer: OptimizedBuffer, deltaTime: number): void
• static protected readonly property TabSelectRenderable.defaultFocusable = true0.6.0

class TerminalConsole extends EventEmitterconstructor TerminalConsole(renderer: CliRenderer, options?: ConsoleOptions)

Console overlay

• method TerminalConsole.activate(): void
• method TerminalConsole.blur(): void
• method TerminalConsole.clear(): void
• method TerminalConsole.deactivate(): void
• method TerminalConsole.destroy(): void
• method TerminalConsole.focus(): void
• method TerminalConsole.getCachedLogs(): string
• method TerminalConsole.handleMouse(event: MouseEvent): boolean
• method TerminalConsole.hide(): void
• method TerminalConsole.renderToBuffer(buffer: OptimizedBuffer): void
• method TerminalConsole.resize(width: number, height: number): void
• method TerminalConsole.setDebugMode(enabled: boolean): void
• method TerminalConsole.show(): void
• method TerminalConsole.toggle(): void
• method TerminalConsole.toggleDebugMode(): void
• property TerminalConsole.keyAliasMap: KeyAliasMap
• property TerminalConsole.keyBindings: ConsoleKeyBinding[]
• property TerminalConsole.onCopySelection: ((text: string) => void) | undefined
• readonly property TerminalConsole.bounds: { x: number; y: number; width: number; height: number; }
• readonly property TerminalConsole.visible: boolean

class TerminalPalette implements TerminalPaletteDetectorconstructor TerminalPalette(options: TerminalPaletteOptions)

Terminal capabilities

• method TerminalPalette.cleanup(): void
• method TerminalPalette.detect(options?: GetPaletteOptions): Promise<TerminalColors>
• method TerminalPalette.detectOSCSupport(timeoutMs?: number): Promise<boolean>

class TextareaRenderable extends EditBufferRenderableconstructor TextareaRenderable(ctx: RenderContext, options: TextareaOptions)

Textarea

• method TextareaRenderable.blur(): void
• method TextareaRenderable.focus(): void
• method TextareaRenderable.handleKeyPress(key: KeyEvent): boolean
• method TextareaRenderable.handlePaste(event: PasteEvent): void
• method TextareaRenderable.submit(): boolean
• property TextareaRenderable.backgroundColor: RGBA
• property TextareaRenderable.focusedBackgroundColor: ColorInput
• property TextareaRenderable.focusedTextColor: ColorInput
• property TextareaRenderable.initialValue: string
• property TextareaRenderable.keyAliasMap: TextareaKeyAliasMap
• property TextareaRenderable.keyBindings: KeyBinding[]
• property TextareaRenderable.onSubmit: ((event: SubmitEvent) => void) | undefined
• property TextareaRenderable.placeholder: StyledText | string | null
• property TextareaRenderable.placeholderColor: RGBA
• property TextareaRenderable.textColor: RGBA
• readonly property TextareaRenderable.extmarks: ExtmarksController

class TextBufferconstructor TextBuffer(lib: RenderLib, handle: ContextTextBufferHandle, source: NativeResourceOwner)

Editing buffers and views

• method TextBuffer.addHighlight(lineIdx: number, highlight: Highlight): void
• method TextBuffer.addHighlightByCharRange(highlight: Highlight): void
• method TextBuffer.append(text: string): void
• method TextBuffer.clear(): void
• method TextBuffer.clearAllHighlights(): void
• method TextBuffer.clearLineHighlights(lineIdx: number): void
• method TextBuffer.destroy(): void
• method TextBuffer.getHighlightCount(): number
• method TextBuffer.getLineCount(): number
• method TextBuffer.getLineHighlights(lineIdx: number): Array<Highlight>
• method TextBuffer.getPlainText(): string
• method TextBuffer.getSyntaxStyle(): SyntaxStyle | null
• method TextBuffer.getTabWidth(): number
• method TextBuffer.getTextRange(startOffset: number, endOffset: number): string
• method TextBuffer.loadFile(path: string): void
• method TextBuffer.removeHighlightsByRef(hlRef: number): void
• method TextBuffer.reset(): void
• method TextBuffer.resetDefaults(): void
• method TextBuffer.setDefaultAttributes(attributes: number | null): void
• method TextBuffer.setDefaultBg(bg: RGBA | null): void
• method TextBuffer.setDefaultFg(fg: RGBA | null): void
• method TextBuffer.setStyledText(text: StyledText): void
• method TextBuffer.setSyntaxStyle(style: SyntaxStyle | null): void
• method TextBuffer.setTabWidth(width: number): void
• method TextBuffer.setText(text: string): void
• readonly property TextBuffer.byteSize: number
• readonly property TextBuffer.length: number
• static method TextBuffer.create(widthMethod: WidthMethod, source: NativeResourceOwner): TextBuffer

abstract class TextBufferRenderable extends Renderable implements LineInfoProviderconstructor TextBufferRenderable(ctx: RenderContext, options: TextBufferOptions, sharedText?: boolean)

Editing buffers and views

• method TextBufferRenderable.drawToBuffer(buffer: OptimizedBuffer, x: number, y: number): void0.6.0
• method TextBufferRenderable.getLineSources(startLine: number, lineCount: number): number[]0.5.11
• method TextBufferRenderable.getSelectedText(): string
• method TextBufferRenderable.getSelection(): { start: number; end: number; } | null
• method TextBufferRenderable.hasSelection(): boolean
• method TextBufferRenderable.onSelectionChanged(selection: Selection | null): boolean
• method TextBufferRenderable.shouldStartSelection(x: number, y: number): boolean
• property TextBufferRenderable.attributes: number
• property TextBufferRenderable.bg: RGBA
• property TextBufferRenderable.fg: RGBA
• property TextBufferRenderable.scrollX: number
• property TextBufferRenderable.scrollY: number
• property TextBufferRenderable.selectionBg: RGBA | undefined
• property TextBufferRenderable.selectionFg: RGBA | undefined
• property TextBufferRenderable.tabIndicator: string | number | undefined
• property TextBufferRenderable.tabIndicatorColor: RGBA | undefined
• property TextBufferRenderable.textAlign: "left" | "center" | "right"0.5.12
• property TextBufferRenderable.truncate: boolean
• property TextBufferRenderable.wrapMode: "none" | "char" | "word"
• protected method TextBufferRenderable.destroyOwnedResources(): void0.6.0
• protected method TextBufferRenderable.handleScroll(event: any): void
• protected method TextBufferRenderable.needsLineInfoFallback(owner: object): boolean0.5.11
• protected method TextBufferRenderable.onAttributesChanged(newAttributes: number): void
• protected method TextBufferRenderable.onBgChanged(newColor: RGBA): void
• protected method TextBufferRenderable.onFgChanged(newColor: RGBA): void
• protected method TextBufferRenderable.onMouseEvent(event: any): void
• protected method TextBufferRenderable.onResize(width: number, height: number): void
• protected method TextBufferRenderable.refreshLocalSelection(): boolean
• protected method TextBufferRenderable.renderSelf(buffer: OptimizedBuffer): void
• protected method TextBufferRenderable.updateTextInfo(): void
• protected method TextBufferRenderable.updateViewportOffset(scrollX?: number, scrollY?: number): void
• protected property TextBufferRenderable._defaultAttributes: number
• protected property TextBufferRenderable._defaultBg: RGBA
• protected property TextBufferRenderable._defaultFg: RGBA
• protected property TextBufferRenderable._defaultOptions: { fg: RGBA; bg: RGBA; selectionBg: undefined; selectionFg: undefined; selectable: true; attributes: number; wrapMode: "none" | "char" | "word"; textAlign: "left" | "center" | "right"; tabIndicator: undefined; tabIndicatorColor: undefined; truncate: false; }
• protected property TextBufferRenderable._firstLineOffset: number
• protected property TextBufferRenderable._scrollX: number
• protected property TextBufferRenderable._scrollY: number
• protected property TextBufferRenderable._selectionBg: RGBA | undefined
• protected property TextBufferRenderable._selectionFg: RGBA | undefined
• protected property TextBufferRenderable._tabIndicator?: string | number
• protected property TextBufferRenderable._tabIndicatorColor?: RGBA
• protected property TextBufferRenderable._textAlign: "left" | "center" | "right"0.5.12
• protected property TextBufferRenderable._textBufferSyntaxStyle: SyntaxStyle
• protected property TextBufferRenderable._truncate: boolean
• protected property TextBufferRenderable._wrapMode: "none" | "char" | "word"
• protected property TextBufferRenderable.lastLocalSelection: LocalSelectionBounds | null
• protected property TextBufferRenderable.textBuffer: TextBuffer
• protected property TextBufferRenderable.textBufferView: TextBufferView
• readonly property TextBufferRenderable.lineCount: number
• readonly property TextBufferRenderable.lineInfo: LineInfo
• readonly property TextBufferRenderable.maxScrollX: number
• readonly property TextBufferRenderable.maxScrollY: number
• readonly property TextBufferRenderable.plainText: string
• readonly property TextBufferRenderable.scrollHeight: number
• readonly property TextBufferRenderable.scrollWidth: number
• readonly property TextBufferRenderable.textLength: number
• readonly property TextBufferRenderable.virtualLineCount: number
• static readonly property TextBufferRenderable.nativeIntegration: NativeRenderableIntegration0.6.0

class TextBufferViewconstructor TextBufferView(lib: RenderLib, handle: ContextTextBufferViewHandle, textBuffer: TextBuffer, source: NativeResourceOwner)

Editing buffers and views

• method TextBufferView.destroy(): void
• method TextBufferView.getLineSources(startLine: number, lineCount: number): number[]0.5.11
• method TextBufferView.getPlainText(): string
• method TextBufferView.getSelectedText(): string
• method TextBufferView.getSelection(): { start: number; end: number; } | null
• method TextBufferView.getSelectionOccupancy(): SelectionOccupancy0.5.7
• method TextBufferView.getVirtualLineCount(): number
• method TextBufferView.hasSelection(): boolean
• method TextBufferView.measureForDimensions(width: number, height: number): MeasureResult | null
• method TextBufferView.resetLocalSelection(): void
• method TextBufferView.resetSelection(): void
• method TextBufferView.setFirstLineOffset(offset: number): void
• method TextBufferView.setLocalSelection(anchorX: number, anchorY: number, focusX: number, focusY: number, bgColor?: RGBA, fgColor?: RGBA, behavior?: SelectionBehavior): boolean
• method TextBufferView.setSelection(start: number, end: number, bgColor?: RGBA, fgColor?: RGBA): void
• method TextBufferView.setSelectionOccupancy(occupancy: SelectionOccupancy): void0.5.7
• method TextBufferView.setTabIndicator(indicator: string | number): void
• method TextBufferView.setTabIndicatorColor(color: RGBA): void
• method TextBufferView.setTextAlign(alignment: "left" | "center" | "right"): void0.5.12
• method TextBufferView.setTruncate(truncate: boolean): void
• method TextBufferView.setViewport(x: number, y: number, width: number, height: number): void
• method TextBufferView.setViewportSize(width: number, height: number): void
• method TextBufferView.setWrapMode(mode: "none" | "char" | "word"): void
• method TextBufferView.setWrapWidth(width: number | null): void
• method TextBufferView.updateLocalSelection(anchorX: number, anchorY: number, focusX: number, focusY: number, bgColor?: RGBA, fgColor?: RGBA, behavior?: SelectionBehavior): boolean
• method TextBufferView.updateSelection(end: number, bgColor?: RGBA, fgColor?: RGBA): void
• readonly property TextBufferView.lineInfo: LineInfo
• readonly property TextBufferView.logicalLineInfo: LineInfo
• static method TextBufferView.create(textBuffer: TextBuffer): TextBufferView

class TextNodeRenderable extends BaseRenderableconstructor TextNodeRenderable(options: TextNodeOptions)

Text and terminal cells

• method TextNodeRenderable.add(obj: TextNodeRenderable | StyledText | string, index?: number): number
• method TextNodeRenderable.clear(): void
• method TextNodeRenderable.findDescendantById(id: string): BaseRenderable | undefined
• method TextNodeRenderable.gatherWithInheritedStyle(parentStyle?: { fg?: RGBA; bg?: RGBA; attributes: number; link?: { url: string; }; }): TextChunk[]
• method TextNodeRenderable.getChildren(): BaseRenderable[]
• method TextNodeRenderable.getChildrenCount(): number
• method TextNodeRenderable.getRenderable(id: string): BaseRenderable | undefined
• method TextNodeRenderable.getRenderableIndex(id: string): number
• method TextNodeRenderable.insertBefore(child: string | TextNodeRenderable | StyledText, anchorNode: TextNodeRenderable | string | unknown): this
• method TextNodeRenderable.mergeStyles(parentStyle: { fg?: RGBA; bg?: RGBA; attributes: number; link?: { url: string; }; }): { fg?: RGBA; bg?: RGBA; attributes: number; link?: { url: string; }; }
• method TextNodeRenderable.remove(child: BaseRenderable): void
• method TextNodeRenderable.replace(obj: TextNodeRenderable | string, index: number): void
• method TextNodeRenderable.requestRender(): void
• method TextNodeRenderable.toChunks(parentStyle?: { fg?: RGBA; bg?: RGBA; attributes: number; link?: { url: string; }; }): TextChunk[]
• property TextNodeRenderable.[BrandedTextNodeRenderable]: boolean
• property TextNodeRenderable.attributes: number
• property TextNodeRenderable.bg: RGBA | undefined
• property TextNodeRenderable.children: (string | TextNodeRenderable)[]
• property TextNodeRenderable.fg: RGBA | undefined
• property TextNodeRenderable.link: { url: string; } | undefined
• property TextNodeRenderable.parent: TextNodeRenderable | null
• protected method TextNodeRenderable.markDirty(): void0.6.0
• static method TextNodeRenderable.fromNodes(nodes: TextNodeRenderable[], options?: Partial<TextNodeOptions>): TextNodeRenderable
• static method TextNodeRenderable.fromString(text: string, options?: Partial<TextNodeOptions>): TextNodeRenderable

class TextRenderable extends TextBufferRenderableconstructor TextRenderable(ctx: RenderContext, options: TextOptions)

Text

• method TextRenderable.add(obj: TextNodeRenderable | StyledText | string, index?: number): number
• method TextRenderable.clear(): void
• method TextRenderable.getTextChildren(): BaseRenderable[]
• method TextRenderable.insertBefore(obj: BaseRenderable | any, anchor?: TextNodeRenderable): number
• method TextRenderable.remove(child: BaseRenderable): void
• method TextRenderable.requestRender(): void0.6.0
• property TextRenderable.content: StyledText
• protected method TextRenderable.destroyOwnedResources(): void0.6.0
• protected method TextRenderable.onAttributesChanged(newAttributes: number): void
• protected method TextRenderable.onBgChanged(newColor: RGBA): void
• protected method TextRenderable.onFgChanged(newColor: RGBA): void
• protected property TextRenderable._contentDefaultOptions: { content: string; }
• protected property TextRenderable.rootTextNode: RootTextNodeRenderable
• readonly property TextRenderable.chunks: TextChunk[]
• readonly property TextRenderable.textNode: RootTextNodeRenderable
• static readonly property TextRenderable.nativeIntegration: NativeRenderableIntegration0.6.0

class TextTableRenderable extends Renderableconstructor TextTableRenderable(ctx: RenderContext, options?: TextTableOptions)

TextTable

• method TextTableRenderable.getSelectedText(): string
• method TextTableRenderable.getSelection(): { start: number; end: number; } | null
• method TextTableRenderable.hasSelection(): boolean
• method TextTableRenderable.onSelectionChanged(selection: Selection | null): boolean
• method TextTableRenderable.shouldStartSelection(x: number, y: number): boolean
• property TextTableRenderable.border: boolean
• property TextTableRenderable.borderColor: RGBA
• property TextTableRenderable.borderStyle: BorderStyle
• property TextTableRenderable.cellPadding: number
• property TextTableRenderable.cellPaddingX: number
• property TextTableRenderable.cellPaddingY: number
• property TextTableRenderable.columnFitter: TextTableColumnFitter
• property TextTableRenderable.columnGap: number
• property TextTableRenderable.columnWidthMode: TextTableColumnWidthMode
• property TextTableRenderable.content: TextTableContent
• property TextTableRenderable.fg: RGBA0.5.12
• property TextTableRenderable.outerBorder: boolean
• property TextTableRenderable.showBorders: boolean
• property TextTableRenderable.wrapMode: "none" | "char" | "word"
• protected method TextTableRenderable.destroySelf(): void
• protected method TextTableRenderable.onResize(width: number, height: number): void
• protected method TextTableRenderable.renderSelf(buffer: OptimizedBuffer): void

class Timelineconstructor Timeline(options?: TimelineOptions)

Animation and Timeline

• method Timeline.add(target: any, properties: AnimationOptions, startTime?: number | string): this
• method Timeline.addStateChangeListener(listener: (timeline: Timeline) => void): void
• method Timeline.call(callback: () => void, startTime?: number | string): this
• method Timeline.once(target: any, properties: AnimationOptions): this
• method Timeline.pause(): this
• method Timeline.play(): this
• method Timeline.removeStateChangeListener(listener: (timeline: Timeline) => void): void
• method Timeline.resetItems(): void
• method Timeline.restart(): this
• method Timeline.sync(timeline: Timeline, startTime?: number): this
• method Timeline.update(deltaTime: number): void
• property Timeline.currentTime: number
• property Timeline.duration: number
• property Timeline.isComplete: boolean
• property Timeline.isPlaying: boolean
• property Timeline.items: (TimelineAnimationItem | TimelineCallbackItem)[]
• property Timeline.loop: boolean
• property Timeline.subTimelines: TimelineTimelineItem[]
• property Timeline.synced: boolean

class TimeToFirstDrawRenderable extends Renderableconstructor TimeToFirstDrawRenderable(ctx: RenderContext, options?: TimeToFirstDrawOptions)

TimeToFirstDraw

• method TimeToFirstDrawRenderable.reset(): void
• property TimeToFirstDrawRenderable.color: ColorInput
• property TimeToFirstDrawRenderable.decimals: number
• property TimeToFirstDrawRenderable.fg: ColorInput
• property TimeToFirstDrawRenderable.textLabel: string
• protected method TimeToFirstDrawRenderable.renderSelf(buffer: OptimizedBuffer): void
• readonly property TimeToFirstDrawRenderable.runtimeMs: number | null

class TreeSitterClient extends EventEmitter<TreeSitterClientEvents>constructor TreeSitterClient(options: TreeSitterClientOptions, internalOptions?: TreeSitterClientInternalOptions)

Tree-sitter

• method TreeSitterClient.addFiletypeParser(filetypeParser: FiletypeParserOptions): void
• method TreeSitterClient.clearCache(): Promise<void>
• method TreeSitterClient.createBuffer(id: number, content: string, filetype: string, version?: number, autoInitialize?: boolean): Promise<boolean>
• method TreeSitterClient.destroy(): Promise<void>
• method TreeSitterClient.getAllBuffers(): BufferState[]
• method TreeSitterClient.getBuffer(bufferId: number): BufferState | undefined
• method TreeSitterClient.getPerformance(): Promise<PerformanceStats>
• method TreeSitterClient.highlightOnce(content: string, filetype: string): Promise<{ highlights?: SimpleHighlight[]; warning?: string; error?: string; }>
• method TreeSitterClient.initialize(): Promise<void>
• method TreeSitterClient.isInitialized(): boolean
• method TreeSitterClient.onDestroy(callback: () => void): () => void0.4.0
• method TreeSitterClient.preloadParser(filetype: string): Promise<boolean>
• method TreeSitterClient.removeBuffer(bufferId: number): Promise<void>
• method TreeSitterClient.resetBuffer(bufferId: number, version: number, content: string): Promise<void>
• method TreeSitterClient.setDataPath(dataPath: string): Promise<void>
• method TreeSitterClient.updateBuffer(id: number, edits: Edit[], newContent: string, version: number): Promise<void>

class VignetteEffectconstructor VignetteEffect(strength?: number)

Post-processing effects

• method VignetteEffect.apply(buffer: OptimizedBuffer): void
• property VignetteEffect.strength: number

class VRenderable extends Renderableconstructor VRenderable(ctx: RenderContext, options: VRenderableOptions)

Renderables

• protected method VRenderable.renderSelf(buffer: OptimizedBuffer, deltaTime: number): void

Interfaces#

interface ArrowOptions extends RenderableOptions<ArrowRenderable>

ScrollBar

• property ArrowOptions.arrowChars?: { up?: string; down?: string; left?: string; right?: string; }
• property ArrowOptions.attributes?: number
• property ArrowOptions.backgroundColor?: ColorInput
• property ArrowOptions.direction: "up" | "down" | "left" | "right"
• property ArrowOptions.foregroundColor?: ColorInput

interface ASCIIFontOptions extends Omit<RenderableOptions<ASCIIFontRenderable>, "width" | "height">

ASCIIFont

• property ASCIIFontOptions.backgroundColor?: ColorInput
• property ASCIIFontOptions.color?: ColorInput | ColorInput[]
• property ASCIIFontOptions.font?: ASCIIFontName
• property ASCIIFontOptions.selectable?: boolean
• property ASCIIFontOptions.selectionBg?: ColorInput
• property ASCIIFontOptions.selectionFg?: ColorInput
• property ASCIIFontOptions.text?: string

interface AudioCaptureDevice

Added in 0.5.0Audio capture

• property AudioCaptureDevice.index: number0.5.0
• property AudioCaptureDevice.isDefault: boolean0.5.0
• property AudioCaptureDevice.name: string0.5.0

interface AudioCaptureOptions

Added in 0.5.0Audio capture

• property AudioCaptureOptions.capacityFrames?: number0.5.0
• property AudioCaptureOptions.channels?: number0.5.0
• property AudioCaptureOptions.startOptions?: AudioStartOptions0.5.0

interface AudioCaptureReadResult

Added in 0.5.0Audio capture

• property AudioCaptureReadResult.frames: Float32Array0.5.0
• property AudioCaptureReadResult.framesRead: number0.5.0

interface AudioCaptureStats

Added in 0.5.0Audio capture

• property AudioCaptureStats.bufferedFrames: number0.5.0
• property AudioCaptureStats.capacityFrames: number0.5.0
• property AudioCaptureStats.channels: number0.5.0
• property AudioCaptureStats.framesDropped: bigint0.5.0
• property AudioCaptureStats.framesRead: bigint0.5.0
• property AudioCaptureStats.framesReceived: bigint0.5.0
• property AudioCaptureStats.sampleRate: number0.5.0

interface AudioCaptureStreamErrorContext

Added in 0.5.0Audio capture

• property AudioCaptureStreamErrorContext.action: AudioCaptureStreamAction0.5.0
• property AudioCaptureStreamErrorContext.status?: number0.5.0

interface AudioCaptureStreamEvents

Added in 0.5.0Audio capture

• property AudioCaptureStreamEvents.disposed: [ ]0.5.0
• property AudioCaptureStreamEvents.error: [ error: AudioCaptureStreamError, context: AudioCaptureStreamErrorContext ]0.5.0
• property AudioCaptureStreamEvents.stopped: [ ]0.5.0

interface AudioCaptureStreamOptions extends AudioCaptureOptions

Added in 0.5.0Audio capture

• property AudioCaptureStreamOptions.chunkFrames?: number0.5.0
• property AudioCaptureStreamOptions.signal?: AbortSignal0.5.0

interface AudioCaptureStreamStats extends AudioCaptureStats

Added in 0.5.0Audio capture

• property AudioCaptureStreamStats.bufferedDurationMs: number0.5.0
• property AudioCaptureStreamStats.state: AudioCaptureStreamState0.5.0

interface AudioEngineLib extends Pick<FFIRenderLib, Extract<keyof FFIRenderLib, `audio${string}` | "createAudioEngine" | "destroyAudioEngine">>

Overview

interface AudioErrorContext

Audio

• property AudioErrorContext.action: AudioAction
• property AudioErrorContext.status?: number

interface AudioEvents

Audio

• property AudioEvents.captureStarted: [ ]0.5.0
• property AudioEvents.captureStopped: [ ]0.5.0
• property AudioEvents.disposed: [ ]
• property AudioEvents.error: [ error: Error, context: AudioErrorContext ]
• property AudioEvents.mixerStarted: [ ]
• property AudioEvents.started: [ ]
• property AudioEvents.stopped: [ ]

interface AudioPlaybackDevice

Audio

• property AudioPlaybackDevice.index: number
• property AudioPlaybackDevice.isDefault: boolean
• property AudioPlaybackDevice.name: string

interface AudioPlayOptions

Audio

• property AudioPlayOptions.groupId?: number
• property AudioPlayOptions.loop?: boolean
• property AudioPlayOptions.pan?: number
• property AudioPlayOptions.volume?: number

interface AudioRecorderErrorContext

Added in 0.5.0Audio capture

• property AudioRecorderErrorContext.action: AudioRecorderAction0.5.0
• property AudioRecorderErrorContext.status?: number0.5.0

interface AudioRecorderEvents

Added in 0.5.0Audio capture

• property AudioRecorderEvents.disposed: [ ]0.5.0
• property AudioRecorderEvents.error: [ error: AudioRecorderError, context: AudioRecorderErrorContext ]0.5.0
• property AudioRecorderEvents.stopped: [ ]0.5.0

interface AudioRecorderStats extends AudioCaptureStats

Added in 0.5.0Audio capture

• property AudioRecorderStats.bufferedDurationMs: number0.5.0
• property AudioRecorderStats.dataBytesWritten: bigint0.5.0
• property AudioRecorderStats.durationMs: number0.5.0
• property AudioRecorderStats.framesWritten: bigint0.5.0
• property AudioRecorderStats.state: AudioRecorderState0.5.0

interface AudioSetupOptions

Audio

• property AudioSetupOptions.autoStart?: boolean
• property AudioSetupOptions.playbackChannels?: number
• property AudioSetupOptions.sampleRate?: number
• property AudioSetupOptions.startOptions?: AudioStartOptions

interface AudioStartOptions

Audio

• property AudioStartOptions.alsaNoAutoChannels?: boolean
• property AudioStartOptions.alsaNoAutoFormat?: boolean
• property AudioStartOptions.alsaNoAutoResample?: boolean
• property AudioStartOptions.alsaNoMMap?: boolean
• property AudioStartOptions.noClip?: boolean
• property AudioStartOptions.noDisableDenormals?: boolean
• property AudioStartOptions.noFixedSizedCallback?: boolean
• property AudioStartOptions.noPreSilencedOutputBuffer?: boolean
• property AudioStartOptions.performanceProfile?: number
• property AudioStartOptions.periodSizeInFrames?: number
• property AudioStartOptions.periodSizeInMilliseconds?: number
• property AudioStartOptions.periods?: number
• property AudioStartOptions.shareMode?: number
• property AudioStartOptions.wasapiNoAutoConvertSrc?: boolean
• property AudioStartOptions.wasapiNoDefaultQualitySrc?: boolean

interface AudioStreamBodyOptions<M = AudioStreamMetadata> extends AudioStreamOptions

Added in 0.4.4Streaming audio

• property AudioStreamBodyOptions.contentTypePolicy?: never0.4.4
• property AudioStreamBodyOptions.demuxer?: AudioStreamDemuxerFactory<M>0.4.4
• property AudioStreamBodyOptions.metadataEncoding?: never0.4.4
• property AudioStreamBodyOptions.reconnect?: never0.4.4
• property AudioStreamBodyOptions.request?: never0.4.4

interface AudioStreamBufferOptions

Added in 0.4.4Streaming audio

• property AudioStreamBufferOptions.capacityMs?: number0.4.4
• property AudioStreamBufferOptions.resumeMs?: number0.4.4
• property AudioStreamBufferOptions.startupMs?: number0.4.4

interface AudioStreamConnectContext

Added in 0.4.4Streaming audio

• readonly property AudioStreamConnectContext.attempt: number0.4.4
• readonly property AudioStreamConnectContext.signal: AbortSignal0.4.4

interface AudioStreamConnection<I = unknown>

Added in 0.4.4Streaming audio

• method AudioStreamConnection.close?(): void | Promise<void>0.4.4
• readonly property AudioStreamConnection.body: AudioStreamBody0.4.4
• readonly property AudioStreamConnection.info: I0.4.4

interface AudioStreamConnector<I = unknown>

Added in 0.4.4Streaming audio

• method AudioStreamConnector.connect(context: AudioStreamConnectContext): Promise<AudioStreamConnection<I>>0.4.4

interface AudioStreamContentTypeContext

Added in 0.4.4Streaming audio

• readonly property AudioStreamContentTypeContext.contentType: string | null0.4.4
• readonly property AudioStreamContentTypeContext.format: AudioStreamFormat0.4.4
• readonly property AudioStreamContentTypeContext.status: number0.4.4
• readonly property AudioStreamContentTypeContext.url: string0.4.4

interface AudioStreamDemuxer<M>

Added in 0.4.4Streaming audio

• method AudioStreamDemuxer.abort?(reason: unknown): void0.4.4
• method AudioStreamDemuxer.flush(): Iterable<AudioStreamDemuxOutput<M>>0.4.4
• method AudioStreamDemuxer.push(chunk: Uint8Array): Iterable<AudioStreamDemuxOutput<M>>0.4.4
• readonly property AudioStreamDemuxer.initialMetadata: M | null0.4.4

interface AudioStreamErrorContext

Added in 0.4.4Streaming audio

• property AudioStreamErrorContext.action: AudioStreamAction0.4.4
• property AudioStreamErrorContext.attempt?: number0.4.4
• property AudioStreamErrorContext.errorCode?: number0.4.4
• property AudioStreamErrorContext.status?: number0.4.4

interface AudioStreamEvents<M = AudioStreamMetadata>

Added in 0.4.4Streaming audio

• property AudioStreamEvents.disposed: [ ]0.4.4
• property AudioStreamEvents.ended: [ ]0.4.4
• property AudioStreamEvents.error: [ error: Error, context: AudioStreamErrorContext ]0.4.4
• property AudioStreamEvents.metadata: [ metadata: M | null ]0.4.4
• property AudioStreamEvents.reconnecting: [ event: AudioStreamReconnectEvent ]0.4.4

interface AudioStreamMetadata

Added in 0.4.4Streaming audio

• readonly property AudioStreamMetadata.fields: Readonly<Record<string, string>>0.4.4
• readonly property AudioStreamMetadata.format: AudioStreamMetadataFormat0.4.4
• readonly property AudioStreamMetadata.headers: Readonly<Record<string, string>>0.4.4

interface AudioStreamOptions

Added in 0.4.4Streaming audio

• property AudioStreamOptions.buffer?: AudioStreamBufferOptions0.4.4
• property AudioStreamOptions.channels?: 1 | 20.5.11
• property AudioStreamOptions.format?: AudioStreamFormat0.4.4
• property AudioStreamOptions.groupId?: number0.4.4
• property AudioStreamOptions.maxProbeBytes?: number0.4.4
• property AudioStreamOptions.pan?: number0.4.4
• property AudioStreamOptions.sampleFormat?: "f32le"0.5.11
• property AudioStreamOptions.sampleRate?: number0.5.11
• property AudioStreamOptions.signal?: AbortSignal0.4.4
• property AudioStreamOptions.volume?: number0.4.4

interface AudioStreamReconnectEvent

Added in 0.4.4Streaming audio

• property AudioStreamReconnectEvent.attempt: number0.4.4
• property AudioStreamReconnectEvent.delayMs: number0.4.4
• property AudioStreamReconnectEvent.error: AudioStreamError0.4.4
• property AudioStreamReconnectEvent.maxRetries: number0.4.4

interface AudioStreamReconnectOptions

Added in 0.4.4Streaming audio

• method AudioStreamReconnectOptions.retry?(error: AudioStreamError, context: AudioStreamRetryContext): AudioStreamRetryDecision0.4.4
• property AudioStreamReconnectOptions.backoffFactor?: number0.4.4
• property AudioStreamReconnectOptions.initialDelayMs?: number0.4.4
• property AudioStreamReconnectOptions.maxDelayMs?: number0.4.4
• property AudioStreamReconnectOptions.maxRetries?: number0.4.4
• property AudioStreamReconnectOptions.retryOnEnd?: boolean0.4.4

interface AudioStreamRetryContext

Added in 0.4.4Streaming audio

• readonly property AudioStreamRetryContext.attempt: number0.4.4
• readonly property AudioStreamRetryContext.maxRetries: number0.4.4
• readonly property AudioStreamRetryContext.phase: AudioStreamRetryPhase0.4.4

interface AudioStreamSourceOptions<I = unknown, M = AudioStreamMetadata> extends AudioStreamOptions

Added in 0.4.4Streaming audio

• property AudioStreamSourceOptions.contentTypePolicy?: never0.4.4
• property AudioStreamSourceOptions.demuxer?: (info: I) => AudioStreamDemuxer<M> | null0.4.4
• property AudioStreamSourceOptions.metadataEncoding?: never0.4.4
• property AudioStreamSourceOptions.reconnect?: AudioStreamReconnectOptions0.4.4
• property AudioStreamSourceOptions.request?: never0.4.4

interface AudioStreamStats

Added in 0.4.4Streaming audio

• property AudioStreamStats.bufferedDurationMs: number0.4.4
• property AudioStreamStats.bufferedFrames: number0.4.4
• property AudioStreamStats.bytesReceived: bigint0.4.4
• property AudioStreamStats.capacityFrames: number0.4.4
• property AudioStreamStats.channels: number0.4.4
• property AudioStreamStats.framesDecoded: bigint0.4.4
• property AudioStreamStats.framesPlayed: bigint0.4.4
• property AudioStreamStats.reconnectAttempts: number0.4.4
• property AudioStreamStats.sampleRate: number0.4.4
• property AudioStreamStats.state: AudioStreamState0.4.4
• property AudioStreamStats.underruns: number0.4.4

interface AudioStreamUrlOptions extends AudioStreamOptions

Added in 0.4.4Streaming audio

• property AudioStreamUrlOptions.contentTypePolicy?: AudioStreamContentTypePolicy0.4.4
• property AudioStreamUrlOptions.demuxer?: never0.4.4
• property AudioStreamUrlOptions.metadataEncoding?: string0.4.4
• property AudioStreamUrlOptions.reconnect?: AudioStreamReconnectOptions0.4.4
• property AudioStreamUrlOptions.request?: Omit<RequestInit, "body" | "signal">0.4.4

interface BaseRenderableOptions

Renderables

• property BaseRenderableOptions.id?: string

interface BlockState

Markdown

• property BlockState.canUpdateInPlace: boolean0.3.2
• property BlockState.marginTop?: number
• property BlockState.renderable: Renderable
• property BlockState.tableContentCache?: TableContentCache
• property BlockState.token: MarkedToken
• property BlockState.tokenRaw: string
• property BlockState.tracksInterBlockMargin?: boolean

interface BorderCharacters

Box

• property BorderCharacters.bottomLeft: string
• property BorderCharacters.bottomRight: string
• property BorderCharacters.bottomT: string
• property BorderCharacters.cross: string
• property BorderCharacters.horizontal: string
• property BorderCharacters.leftT: string
• property BorderCharacters.rightT: string
• property BorderCharacters.topLeft: string
• property BorderCharacters.topRight: string
• property BorderCharacters.topT: string
• property BorderCharacters.vertical: string

interface BorderConfig

Box

• property BorderConfig.border: boolean | BorderSides[]
• property BorderConfig.borderColor?: ColorInput
• property BorderConfig.borderStyle: BorderStyle
• property BorderConfig.customBorderChars?: BorderCharacters

interface BorderSidesConfig

Box

• property BorderSidesConfig.bottom: boolean
• property BorderSidesConfig.left: boolean
• property BorderSidesConfig.right: boolean
• property BorderSidesConfig.top: boolean

interface BoxDrawOptions

Box

• property BoxDrawOptions.backgroundColor: ColorInput
• property BoxDrawOptions.border: boolean | BorderSides[]
• property BoxDrawOptions.borderColor: ColorInput
• property BoxDrawOptions.borderStyle: BorderStyle
• property BoxDrawOptions.bottomTitle?: string
• property BoxDrawOptions.bottomTitleAlignment?: "left" | "center" | "right"
• property BoxDrawOptions.customBorderChars?: BorderCharacters
• property BoxDrawOptions.height: number
• property BoxDrawOptions.shouldFill?: boolean
• property BoxDrawOptions.title?: string
• property BoxDrawOptions.titleAlignment?: "left" | "center" | "right"
• property BoxDrawOptions.width: number
• property BoxDrawOptions.x: number
• property BoxDrawOptions.y: number

interface BoxOptions<TRenderable extends Renderable = BoxRenderable> extends RenderableOptions<TRenderable>

Box

• property BoxOptions.backgroundColor?: string | RGBA
• property BoxOptions.border?: boolean | BorderSides[]
• property BoxOptions.borderColor?: string | RGBA
• property BoxOptions.borderStyle?: BorderStyle
• property BoxOptions.bottomTitle?: string
• property BoxOptions.bottomTitleAlignment?: "left" | "center" | "right"
• property BoxOptions.columnGap?: number | `${number}%`
• property BoxOptions.customBorderChars?: BorderCharacters
• property BoxOptions.focusable?: boolean
• property BoxOptions.focusedBorderColor?: ColorInput
• property BoxOptions.gap?: number | `${number}%`
• property BoxOptions.rowGap?: number | `${number}%`
• property BoxOptions.shouldFill?: boolean
• property BoxOptions.title?: string
• property BoxOptions.titleAlignment?: "left" | "center" | "right"
• property BoxOptions.titleColor?: string | RGBA0.3.3

interface BufferAccess

Added in 0.6.0How Core uses native

• readonly property BufferAccess.attributes: Uint32Array0.6.0
• readonly property BufferAccess.bg: Uint16Array0.6.0
• readonly property BufferAccess.char: Uint32Array0.6.0
• readonly property BufferAccess.fg: Uint16Array0.6.0
• readonly property BufferAccess.generation: bigint0.6.0
• readonly property BufferAccess.height: number0.6.0
• readonly property BufferAccess.width: number0.6.0

interface BufferState

Tree-sitter

• property BufferState.content: string
• property BufferState.filetype: string
• property BufferState.hasParser: boolean
• property BufferState.id: number
• property BufferState.version: number

interface CapturedFrame

Renderer

• property CapturedFrame.cols: number
• property CapturedFrame.cursor: [ number, number ]
• property CapturedFrame.lines: CapturedLine[]
• property CapturedFrame.rows: number

interface CapturedLine

Renderer

• property CapturedLine.spans: CapturedSpan[]

interface CapturedSpan

Renderer

• property CapturedSpan.attributes: number
• property CapturedSpan.bg: RGBA
• property CapturedSpan.fg: RGBA
• property CapturedSpan.text: string
• property CapturedSpan.width: number

interface ChunkRenderContext extends HighlightContext

Code

• property ChunkRenderContext.highlights: SimpleHighlight[]
• property ChunkRenderContext.sourceRanges?: Array<{ start: number; end: number; }>0.5.11

interface ClipboardClearResult

Added in 0.5.2Clipboard

• readonly property ClipboardClearResult.host: HostClipboardClearResult | { readonly status: "not-attempted"; }0.5.2
• readonly property ClipboardClearResult.terminal: TerminalClipboardOperationResult0.5.2

interface ClipboardOptions

Added in 0.5.2Clipboard

• readonly property ClipboardOptions.host: HostClipboardService0.5.2
• readonly property ClipboardOptions.terminal: TerminalClipboardAdapter0.5.2

interface ClipboardReadOptions

Added in 0.5.2Clipboard

• readonly property ClipboardReadOptions.preferredTypes: readonly [ string, ...string[] ]0.5.2
• readonly property ClipboardReadOptions.selection?: ClipboardSelection0.5.2
• readonly property ClipboardReadOptions.signal?: AbortSignal0.5.2

interface ClipboardRepresentation

Added in 0.5.2Clipboard

• readonly property ClipboardRepresentation.bytes: Uint8Array0.5.2
• readonly property ClipboardRepresentation.mimeType: string0.5.2

interface ClipboardService

Added in 0.5.2Clipboard

• method ClipboardService.clear(options: ClipboardWriteOptions): Promise<ClipboardClearResult>0.5.2
• method ClipboardService.dispose(): Promise<void>0.5.2
• method ClipboardService.read(options: ClipboardReadOptions): Promise<ClipboardReadResult>0.5.2
• method ClipboardService.writeText(text: string, options: ClipboardWriteOptions): Promise<ClipboardWriteResult>0.5.2

interface ClipboardWriteOptions

Added in 0.5.2Clipboard

• readonly property ClipboardWriteOptions.allowRemoteHost?: boolean0.5.2
• readonly property ClipboardWriteOptions.destination: ClipboardWriteDestination0.5.2
• readonly property ClipboardWriteOptions.selection?: ClipboardSelection0.5.2
• readonly property ClipboardWriteOptions.signal?: AbortSignal0.5.2

interface ClipboardWriteResult

Added in 0.5.2Clipboard

• readonly property ClipboardWriteResult.host: HostClipboardWriteResult | { readonly status: "not-attempted"; }0.5.2
• readonly property ClipboardWriteResult.terminal: TerminalClipboardOperationResult0.5.2

interface CliRendererConfig

Renderer

• property CliRendererConfig.autoFocus?: boolean
• property CliRendererConfig.backgroundColor?: ColorInput
• property CliRendererConfig.bufferedOutput?: NativeBufferedOutput
• property CliRendererConfig.clearOnShutdown?: boolean
• property CliRendererConfig.clock?: Clock
• property CliRendererConfig.consoleMode?: ConsoleMode
• property CliRendererConfig.consoleOptions?: Omit<ConsoleOptions, "clock">
• property CliRendererConfig.debounceDelay?: number
• property CliRendererConfig.enableMouseMovement?: boolean
• property CliRendererConfig.environment?: Readonly<Record<string, string>>0.6.0
• property CliRendererConfig.exitOnCtrlC?: boolean
• property CliRendererConfig.exitSignals?: NodeJS.Signals[]
• property CliRendererConfig.externalOutputMode?: ExternalOutputMode
• property CliRendererConfig.footerHeight?: number
• property CliRendererConfig.forwardEnvKeys?: string[]
• property CliRendererConfig.gatherStats?: boolean
• property CliRendererConfig.height?: number
• property CliRendererConfig.kittyImageTransport?: KittyImageTransport0.5.10
• property CliRendererConfig.maxFps?: number
• property CliRendererConfig.maxStatSamples?: number
• property CliRendererConfig.memorySnapshotInterval?: number
• property CliRendererConfig.nativeSceneWorkBudget?: number0.6.0
• property CliRendererConfig.nativeSession?: NativeSession0.6.0
• property CliRendererConfig.onDestroy?: () => void
• property CliRendererConfig.openConsoleOnError?: boolean
• property CliRendererConfig.postProcessFns?: ((buffer: OptimizedBuffer, deltaTime: number) => void)[]
• property CliRendererConfig.prependInputHandlers?: ((sequence: string) => boolean)[]
• property CliRendererConfig.remote?: boolean
• property CliRendererConfig.screenMode?: ScreenMode
• property CliRendererConfig.stdin?: NodeJS.ReadStream
• property CliRendererConfig.stdinParserMaxBufferBytes?: number
• property CliRendererConfig.stdout?: NodeJS.WriteStream
• property CliRendererConfig.targetFps?: number
• property CliRendererConfig.useKittyKeyboard?: KittyKeyboardOptions | null
• property CliRendererConfig.useMouse?: boolean
• property CliRendererConfig.width?: number

interface CliRendererErrorEvent

Added in 0.5.0Renderer

• property CliRendererErrorEvent.error: Error0.5.0
• property CliRendererErrorEvent.renderable: Renderable | undefined0.5.0

interface CliRendererExternalOutputEvent

Renderer

• property CliRendererExternalOutputEvent.rowColumns: number
• property CliRendererExternalOutputEvent.snapshot: OptimizedBuffer
• property CliRendererExternalOutputEvent.startOnNewLine: boolean
• property CliRendererExternalOutputEvent.trailingNewline: boolean

interface CliRendererFrameEvent

Renderer

• property CliRendererFrameEvent.frameId: number

interface CliRendererHandlerErrorEvent

Added in 0.5.0Renderer

• property CliRendererHandlerErrorEvent.error: unknown0.5.0
• property CliRendererHandlerErrorEvent.event: MouseEvent0.5.0

interface CliRendererStats extends NativeRenderStats

Renderer

• property CliRendererStats.averageFrameTime: number
• property CliRendererStats.fps: number
• property CliRendererStats.frameCallbackTime: number
• property CliRendererStats.frameCount: number
• property CliRendererStats.frameTimes: number[]
• property CliRendererStats.maxFrameTime: number
• property CliRendererStats.minFrameTime: number

interface Clock

Animation and Timeline

• method Clock.clearInterval(handle: TimerHandle): void
• method Clock.clearTimeout(handle: TimerHandle): void
• method Clock.now(): number
• method Clock.setInterval(fn: () => void, delayMs: number): TimerHandle
• method Clock.setTimeout(fn: () => void, delayMs: number): TimerHandle

interface CodeOptions extends TextBufferOptions

Code

• property CodeOptions.baseHighlight?: string
• property CodeOptions.conceal?: boolean
• property CodeOptions.content?: string
• property CodeOptions.drawUnstyledText?: boolean
• property CodeOptions.filetype?: string
• property CodeOptions.initialStyledText?: StyledText0.3.4
• property CodeOptions.onChunks?: OnChunksCallback
• property CodeOptions.onHighlight?: OnHighlightCallback
• property CodeOptions.streaming?: boolean
• property CodeOptions.syntaxStyle: SyntaxStyle
• property CodeOptions.treeSitterClient?: TreeSitterClient

interface CompositeOptions

Added in 0.5.0Native images

• property CompositeOptions.blend?: BlendMode0.5.0
• property CompositeOptions.left?: number0.5.0
• property CompositeOptions.opacity?: number0.5.0
• property CompositeOptions.top?: number0.5.0

interface ConsoleOptions

Console overlay

• property ConsoleOptions.backgroundColor?: ColorInput
• property ConsoleOptions.clock?: Clock
• property ConsoleOptions.colorDebug?: ColorInput
• property ConsoleOptions.colorDefault?: ColorInput
• property ConsoleOptions.colorError?: ColorInput
• property ConsoleOptions.colorInfo?: ColorInput
• property ConsoleOptions.colorWarn?: ColorInput
• property ConsoleOptions.copyButtonColor?: ColorInput
• property ConsoleOptions.cursorColor?: ColorInput
• property ConsoleOptions.keyAliasMap?: KeyAliasMap
• property ConsoleOptions.keyBindings?: ConsoleKeyBinding[]
• property ConsoleOptions.maxDisplayLines?: number
• property ConsoleOptions.maxStoredLogs?: number
• property ConsoleOptions.onCopySelection?: (text: string) => void
• property ConsoleOptions.position?: ConsolePosition
• property ConsoleOptions.selectionColor?: ColorInput
• property ConsoleOptions.sizePercent?: number
• property ConsoleOptions.startInDebugMode?: boolean
• property ConsoleOptions.title?: string
• property ConsoleOptions.titleBarColor?: ColorInput
• property ConsoleOptions.titleBarTextColor?: ColorInput
• property ConsoleOptions.zIndex?: number

interface ContentChangeEvent

Editing buffers and views

interface ContextObjectHandle

Added in 0.6.0Overview

• readonly property ContextObjectHandle.context: NativeContextHandle0.6.0
• readonly property ContextObjectHandle.contextId: bigint0.6.0
• readonly property ContextObjectHandle.generation: number0.6.0
• readonly property ContextObjectHandle.slot: number0.6.0

interface CoreManagedSlot<TContext extends PluginContext = PluginContext, TData extends object = Record<string, unknown>>

Core

• property CoreManagedSlot.onActivate?: (ctx: Readonly<TContext>) => void
• property CoreManagedSlot.onDeactivate?: (ctx: Readonly<TContext>) => void
• property CoreManagedSlot.onDispose?: (ctx: Readonly<TContext>) => void
• property CoreManagedSlot.render: CoreSlotRenderer<TContext, TData>

interface CorePlugin<TSlotName extends string, TContext extends PluginContext = PluginContext, TData extends object = Record<string, unknown>>

Core

• property CorePlugin.dispose?: () => void
• property CorePlugin.id: string
• property CorePlugin.order?: number
• property CorePlugin.setup?: (ctx: Readonly<TContext>, renderer: CliRenderer) => void
• property CorePlugin.slots: Partial<Record<TSlotName, CoreSlotContribution<TContext, TData>>>

interface CoreResolvedSlotRenderer<TContext extends PluginContext = PluginContext, TData extends object = Record<string, unknown>>

Core

• property CoreResolvedSlotRenderer.id: string
• property CoreResolvedSlotRenderer.renderer: CoreSlotRenderer<TContext, TData>

interface CursorChangeEvent

Editing buffers and views

• property CursorChangeEvent.line: number
• property CursorChangeEvent.visualColumn: number

interface CursorState

Overview

• property CursorState.blinking: boolean
• property CursorState.color: RGBA
• property CursorState.style: CursorStyle
• property CursorState.visible: boolean
• property CursorState.x: number
• property CursorState.y: number

interface CursorStyleOptions

Renderer

• property CursorStyleOptions.blinking?: boolean
• property CursorStyleOptions.color?: RGBA
• property CursorStyleOptions.cursor?: MousePointerStyle
• property CursorStyleOptions.style?: CursorStyle

interface DataPaths

Application data paths

• property DataPaths.globalConfigFile: string
• property DataPaths.globalConfigPath: string
• property DataPaths.globalDataPath: string
• property DataPaths.localConfigFile: string

interface DataPathsEvents

Application data paths

• property DataPathsEvents."paths:changed": [ paths: DataPaths ]

interface DiffRenderableOptions extends RenderableOptions<DiffRenderable>

Diff

• property DiffRenderableOptions.addedBg?: string | RGBA
• property DiffRenderableOptions.addedContentBg?: string | RGBA
• property DiffRenderableOptions.addedLineNumberBg?: string | RGBA
• property DiffRenderableOptions.addedSignColor?: string | RGBA
• property DiffRenderableOptions.conceal?: boolean
• property DiffRenderableOptions.contextBg?: string | RGBA
• property DiffRenderableOptions.contextContentBg?: string | RGBA
• property DiffRenderableOptions.diff?: string
• property DiffRenderableOptions.fg?: string | RGBA
• property DiffRenderableOptions.filetype?: string
• property DiffRenderableOptions.lineNumberBg?: string | RGBA
• property DiffRenderableOptions.lineNumberFg?: string | RGBA
• property DiffRenderableOptions.removedBg?: string | RGBA
• property DiffRenderableOptions.removedContentBg?: string | RGBA
• property DiffRenderableOptions.removedLineNumberBg?: string | RGBA
• property DiffRenderableOptions.removedSignColor?: string | RGBA
• property DiffRenderableOptions.selectionBg?: string | RGBA
• property DiffRenderableOptions.selectionFg?: string | RGBA
• property DiffRenderableOptions.showLineNumbers?: boolean
• property DiffRenderableOptions.syncScroll?: boolean
• property DiffRenderableOptions.syntaxStyle?: SyntaxStyle
• property DiffRenderableOptions.treeSitterClient?: TreeSitterClient
• property DiffRenderableOptions.view?: "unified" | "split"
• property DiffRenderableOptions.wrapMode?: "word" | "char" | "none"

interface Edit

Tree-sitter

• property Edit.newEndIndex: number
• property Edit.newEndPosition: { row: number; column: number; }
• property Edit.oldEndIndex: number
• property Edit.oldEndPosition: { row: number; column: number; }
• property Edit.startIndex: number
• property Edit.startPosition: { row: number; column: number; }

interface EditBufferOptions extends RenderableOptions<EditBufferRenderable>

Editing buffers and views

• property EditBufferOptions.attributes?: number
• property EditBufferOptions.backgroundColor?: string | RGBA
• property EditBufferOptions.cursorColor?: string | RGBA
• property EditBufferOptions.cursorStyle?: CursorStyleOptions
• property EditBufferOptions.onContentChange?: (event: ContentChangeEvent) => void
• property EditBufferOptions.onCursorChange?: (event: CursorChangeEvent) => void
• property EditBufferOptions.scrollMargin?: number
• property EditBufferOptions.scrollSpeed?: number
• property EditBufferOptions.selectable?: boolean
• property EditBufferOptions.selectionBg?: string | RGBA
• property EditBufferOptions.selectionFg?: string | RGBA
• property EditBufferOptions.selectionOccupancy?: SelectionOccupancy0.5.7
• property EditBufferOptions.showCursor?: boolean
• property EditBufferOptions.syntaxStyle?: SyntaxStyle
• property EditBufferOptions.tabIndicator?: string | number
• property EditBufferOptions.tabIndicatorColor?: string | RGBA
• property EditBufferOptions.textColor?: string | RGBA
• property EditBufferOptions.wrapMode?: "none" | "char" | "word"

interface EditorTraits

Editing buffers and views

• property EditorTraits.capture?: readonly EditorCapture[]
• property EditorTraits.status?: string
• property EditorTraits.suspend?: boolean

interface EmbeddedTerminalOptions extends RenderableOptions<EmbeddedTerminalRenderable>

Added in 0.5.6Embedded terminal

• property EmbeddedTerminalOptions.cols?: number0.5.6
• property EmbeddedTerminalOptions.maxScrollback?: number0.5.6
• property EmbeddedTerminalOptions.onData?: (data: Uint8Array, source: EmbeddedTerminalDataSource) => void0.5.6
• property EmbeddedTerminalOptions.onScreenChange?: () => void0.5.6
• property EmbeddedTerminalOptions.onTerminalResize?: (cols: number, rows: number) => void0.5.6
• property EmbeddedTerminalOptions.rows?: number0.5.6
• property EmbeddedTerminalOptions.selectable?: boolean0.5.6
• property EmbeddedTerminalOptions.transparentBackground?: boolean0.5.12

interface EncodedUnicode

Added in 0.6.0How Core uses native

• property EncodedUnicode.data: Array<{ width: number; char: number; }>0.6.0

interface EnvVarConfig

Environment variables

• property EnvVarConfig.default?: string | boolean | number
• property EnvVarConfig.description: string
• property EnvVarConfig.name: string
• property EnvVarConfig.required?: boolean0.5.0
• property EnvVarConfig.type?: "string" | "boolean" | "number"

interface ExtendOptions

Added in 0.5.0Native images

• property ExtendOptions.background?: readonly [ number, number, number, number ]0.5.0
• property ExtendOptions.bottom?: number0.5.0
• property ExtendOptions.left?: number0.5.0
• property ExtendOptions.right?: number0.5.0
• property ExtendOptions.top?: number0.5.0

interface Extmark

Editing buffers and views

• property Extmark.data?: any
• property Extmark.end: number
• property Extmark.id: number
• property Extmark.priority?: number
• property Extmark.start: number
• property Extmark.styleId?: number
• property Extmark.typeId: number
• property Extmark.virtual: boolean

interface ExtmarkOptions

Editing buffers and views

• property ExtmarkOptions.data?: any
• property ExtmarkOptions.end: number
• property ExtmarkOptions.metadata?: any
• property ExtmarkOptions.priority?: number
• property ExtmarkOptions.start: number
• property ExtmarkOptions.styleId?: number
• property ExtmarkOptions.typeId?: number
• property ExtmarkOptions.virtual?: boolean

interface ExtractOptions

Added in 0.5.0Native images

• property ExtractOptions.height: number0.5.0
• property ExtractOptions.left: number0.5.0
• property ExtractOptions.top: number0.5.0
• property ExtractOptions.width: number0.5.0

interface FiletypeParserOptions

Tree-sitter

• property FiletypeParserOptions.aliases?: string[]
• property FiletypeParserOptions.filetype: string
• property FiletypeParserOptions.injectionMapping?: InjectionMapping
• property FiletypeParserOptions.queries: { highlights: string[]; injections?: string[]; }
• property FiletypeParserOptions.wasm: string

interface FrameBufferOptions extends RenderableOptions<FrameBufferRenderable>

FrameBuffer

• property FrameBufferOptions.height: number
• property FrameBufferOptions.respectAlpha?: boolean
• property FrameBufferOptions.width: number

interface GetPaletteOptions

Terminal capabilities

• property GetPaletteOptions.size?: number
• property GetPaletteOptions.timeout?: number

interface HASTElement

Text and terminal cells

• property HASTElement.children: HASTNode[]
• property HASTElement.properties?: { className?: string; }
• property HASTElement.tagName: string
• property HASTElement.type: "element"

interface HASTText

Text and terminal cells

• property HASTText.type: "text"
• property HASTText.value: string

interface Highlight

Text and terminal cells

• property Highlight.end: number
• property Highlight.hlRef?: number | null
• property Highlight.priority?: number | null
• property Highlight.start: number
• property Highlight.styleId: number

interface HighlightContext

Code

• property HighlightContext.content: string
• property HighlightContext.filetype: string
• property HighlightContext.syntaxStyle: SyntaxStyle

interface HighlightMeta

Tree-sitter

• property HighlightMeta.conceal?: string | null
• property HighlightMeta.concealLines?: string | null
• property HighlightMeta.containsInjection?: boolean
• property HighlightMeta.injectionLang?: string
• property HighlightMeta.isInjection?: boolean

interface HighlightRange

Tree-sitter

• property HighlightRange.endCol: number
• property HighlightRange.group: string
• property HighlightRange.startCol: number

interface HighlightResponse

Tree-sitter

• property HighlightResponse.droppedHighlights: HighlightRange[]
• property HighlightResponse.highlights: HighlightRange[]
• property HighlightResponse.line: number

interface HostClipboardBackend

Added in 0.5.2Clipboard

• method HostClipboardBackend.clear(options: HostClipboardWriteOptions): Promise<HostClipboardClearResult>0.5.2
• method HostClipboardBackend.dispose(): Promise<void>0.5.2
• method HostClipboardBackend.read(options: HostClipboardReadOptions): Promise<ClipboardReadResult>0.5.2
• method HostClipboardBackend.writeText(text: string, options: HostClipboardWriteOptions): Promise<HostClipboardWriteResult>0.5.2

interface HostClipboardOperationOptions

Added in 0.5.2Clipboard

• readonly property HostClipboardOperationOptions.selection?: ClipboardSelection0.5.2
• readonly property HostClipboardOperationOptions.signal?: AbortSignal0.5.2

interface HostClipboardOptions

Added in 0.5.2Clipboard

• readonly property HostClipboardOptions.maxConcurrentOperations?: number0.5.2
• readonly property HostClipboardOptions.maxConversionBytes?: number0.5.2
• readonly property HostClipboardOptions.maxImagePixels?: number0.5.2
• readonly property HostClipboardOptions.maxProviderTransfers?: number0.5.2
• readonly property HostClipboardOptions.maxReadBytes?: number0.5.2
• readonly property HostClipboardOptions.maxWriteBytes?: number0.5.2
• readonly property HostClipboardOptions.timeoutMs?: number0.5.2
• readonly property HostClipboardOptions.waylandSeat?: string0.5.2

interface HostClipboardReadOptions

Added in 0.5.2Clipboard

• readonly property HostClipboardReadOptions.maxBytes: number0.5.2
• readonly property HostClipboardReadOptions.preferredTypes: readonly [ string, ...string[] ]0.5.2
• readonly property HostClipboardReadOptions.selection: ClipboardSelection0.5.2
• readonly property HostClipboardReadOptions.signal: AbortSignal0.5.2
• readonly property HostClipboardReadOptions.timeoutMs: number0.5.2

interface HostClipboardService

Added in 0.5.2Clipboard

• method HostClipboardService.clear(options?: HostClipboardOperationOptions): Promise<HostClipboardClearResult>0.5.2
• method HostClipboardService.dispose(): Promise<void>0.5.2
• method HostClipboardService.read(options: ClipboardReadOptions): Promise<ClipboardReadResult>0.5.2
• method HostClipboardService.writeText(text: string, options?: HostClipboardOperationOptions): Promise<HostClipboardWriteResult>0.5.2
• readonly property HostClipboardService.maxWriteBytes: number0.5.2

interface HostClipboardWriteOptions

Added in 0.5.2Clipboard

• readonly property HostClipboardWriteOptions.selection: ClipboardSelection0.5.2
• readonly property HostClipboardWriteOptions.signal: AbortSignal0.5.2
• readonly property HostClipboardWriteOptions.timeoutMs: number0.5.2

interface IcyStreamDemuxerOptions

Added in 0.4.4Streaming audio

• property IcyStreamDemuxerOptions.headers?: Readonly<Record<string, string>>0.4.4
• property IcyStreamDemuxerOptions.metadataEncoding?: string0.4.4
• property IcyStreamDemuxerOptions.metadataInterval: number0.4.4

interface ImageCreateOptions

Added in 0.6.0Native images

• property ImageCreateOptions.owner?: ResourceContext0.6.0

interface ImageInfo

Added in 0.5.0Native images

• property ImageInfo.colorStatus: ImageColorStatus0.5.0
• property ImageInfo.format: ImageFormat0.5.0
• property ImageInfo.hasAlpha: boolean0.5.0
• property ImageInfo.height: number0.5.0
• property ImageInfo.orientation: number0.5.0
• property ImageInfo.sourceHeight: number0.5.0
• property ImageInfo.sourceWidth: number0.5.0
• property ImageInfo.width: number0.5.0

interface ImageLoadOptions extends ImageCreateOptions

Added in 0.5.0Native images

• property ImageLoadOptions.fetch?: (input: URL, init?: RequestInit) => Promise<Response>0.5.0
• property ImageLoadOptions.signal?: AbortSignal0.5.0

interface ImageRenderableOptions extends RenderableOptions<ImageRenderable>

Added in 0.5.0Image

• property ImageRenderableOptions.fit?: ImageFit0.5.0
• property ImageRenderableOptions.onError?: (error: unknown) => void0.5.0
• property ImageRenderableOptions.onLoad?: (image: NativeImage) => void0.5.0
• property ImageRenderableOptions.protocol?: ImageRenderProtocol0.5.0
• property ImageRenderableOptions.source?: ImageRenderableSource0.5.0

interface InjectionMapping

Tree-sitter

• property InjectionMapping.infoStringMap?: { [infoString: string]: string; }
• property InjectionMapping.nodeTypes?: { [nodeType: string]: string; }

interface InputRenderableOptions extends Omit<TextareaOptions, "height" | "minHeight" | "maxHeight" | "initialValue">

Input

• property InputRenderableOptions.maxLength?: number
• property InputRenderableOptions.minLength?: number
• property InputRenderableOptions.placeholder?: string
• property InputRenderableOptions.value?: string

interface JSAnimation

Animation and Timeline

• property JSAnimation.currentTime: number
• property JSAnimation.deltaTime: number
• property JSAnimation.progress: number
• property JSAnimation.targets: any[]

interface KittyImageTransportStatus

Added in 0.5.10Image

• property KittyImageTransportStatus.effective: "raw" | "zlib" | "png" | "file"0.5.10
• property KittyImageTransportStatus.fallback: "none" | "not-ready" | "unavailable" | "budget" | "busy" | "preparation" | "compression"0.5.10
• property KittyImageTransportStatus.fileState: "disabled" | "probing" | "ready" | "unsupported" | "timeout" | "io-error" | "cancelled"0.5.10
• property KittyImageTransportStatus.pendingBytes: number0.5.10
• property KittyImageTransportStatus.pendingFiles: number0.5.10
• property KittyImageTransportStatus.requested: KittyImageTransport0.5.10

interface KittyKeyboardOptions

Renderer

• property KittyKeyboardOptions.allKeysAsEscapes?: boolean
• property KittyKeyboardOptions.alternateKeys?: boolean
• property KittyKeyboardOptions.disambiguate?: boolean
• property KittyKeyboardOptions.events?: boolean
• property KittyKeyboardOptions.reportText?: boolean

interface LayoutOptions extends BaseRenderableOptions

Renderables

• property LayoutOptions.alignItems?: AlignString
• property LayoutOptions.alignSelf?: AlignString
• property LayoutOptions.bottom?: number | "auto" | `${number}%`
• property LayoutOptions.enableLayout?: boolean
• property LayoutOptions.flexBasis?: number | "auto" | undefined
• property LayoutOptions.flexDirection?: FlexDirectionString
• property LayoutOptions.flexGrow?: number
• property LayoutOptions.flexShrink?: number
• property LayoutOptions.flexWrap?: WrapString
• property LayoutOptions.justifyContent?: JustifyString
• property LayoutOptions.left?: number | "auto" | `${number}%`
• property LayoutOptions.margin?: number | "auto" | `${number}%`
• property LayoutOptions.marginBottom?: number | "auto" | `${number}%`
• property LayoutOptions.marginLeft?: number | "auto" | `${number}%`
• property LayoutOptions.marginRight?: number | "auto" | `${number}%`
• property LayoutOptions.marginTop?: number | "auto" | `${number}%`
• property LayoutOptions.marginX?: number | "auto" | `${number}%`
• property LayoutOptions.marginY?: number | "auto" | `${number}%`
• property LayoutOptions.maxHeight?: number | "auto" | `${number}%`
• property LayoutOptions.maxWidth?: number | "auto" | `${number}%`
• property LayoutOptions.minHeight?: number | "auto" | `${number}%`
• property LayoutOptions.minWidth?: number | "auto" | `${number}%`
• property LayoutOptions.overflow?: OverflowString
• property LayoutOptions.padding?: number | `${number}%`
• property LayoutOptions.paddingBottom?: number | `${number}%`
• property LayoutOptions.paddingLeft?: number | `${number}%`
• property LayoutOptions.paddingRight?: number | `${number}%`
• property LayoutOptions.paddingTop?: number | `${number}%`
• property LayoutOptions.paddingX?: number | `${number}%`
• property LayoutOptions.paddingY?: number | `${number}%`
• property LayoutOptions.position?: PositionTypeString
• property LayoutOptions.right?: number | "auto" | `${number}%`
• property LayoutOptions.top?: number | "auto" | `${number}%`

interface LineColorConfig

Line numbers

• property LineColorConfig.content?: string | RGBA
• property LineColorConfig.gutter?: string | RGBA

interface LineInfo

Text and terminal cells

• property LineInfo.lineSources: number[]
• property LineInfo.lineStartCols: number[]
• property LineInfo.lineWidthCols: number[]
• property LineInfo.lineWidthColsMax: number
• property LineInfo.lineWraps: number[]

interface LineInfoProvider

Text and terminal cells

• method LineInfoProvider.getLineSources?(startLine: number, lineCount: number): number[]0.5.11
• readonly property LineInfoProvider.lineCount: number
• readonly property LineInfoProvider.lineInfo: LineInfo
• readonly property LineInfoProvider.scrollY: number
• readonly property LineInfoProvider.virtualLineCount: number

interface LineNumberOptions extends RenderableOptions<LineNumberRenderable>

Line numbers

• property LineNumberOptions.bg?: string | RGBA
• property LineNumberOptions.fg?: string | RGBA
• property LineNumberOptions.hideLineNumbers?: Set<number>
• property LineNumberOptions.lineColors?: Map<number, string | RGBA | LineColorConfig>
• property LineNumberOptions.lineNumberOffset?: number
• property LineNumberOptions.lineNumbers?: Map<number, number>
• property LineNumberOptions.lineSigns?: Map<number, LineSign>
• property LineNumberOptions.minWidth?: number
• property LineNumberOptions.paddingRight?: number
• property LineNumberOptions.showLineNumbers?: boolean
• property LineNumberOptions.target?: Renderable & LineInfoProvider

interface LineSign

Line numbers

• property LineSign.after?: string
• property LineSign.afterColor?: string | RGBA
• property LineSign.before?: string
• property LineSign.beforeColor?: string | RGBA

interface LocalSelectionBounds

Interaction

• property LocalSelectionBounds.anchorX: number
• property LocalSelectionBounds.anchorY: number
• property LocalSelectionBounds.behavior: SelectionBehavior0.5.7
• property LocalSelectionBounds.focusX: number
• property LocalSelectionBounds.focusY: number
• property LocalSelectionBounds.isActive: boolean

interface LogicalCursor

Overview

• property LogicalCursor.col: number
• property LogicalCursor.offset: number
• property LogicalCursor.row: number

interface MarkdownOptions extends RenderableOptions<MarkdownRenderable>

Markdown

• property MarkdownOptions.bg?: ColorInput
• property MarkdownOptions.conceal?: boolean
• property MarkdownOptions.concealCode?: boolean
• property MarkdownOptions.content?: string
• property MarkdownOptions.fg?: ColorInput
• property MarkdownOptions.internalBlockMode?: "coalesced" | "top-level"
• property MarkdownOptions.renderNode?: (token: Token, context: RenderNodeContext) => Renderable | undefined | null
• property MarkdownOptions.streaming?: boolean
• property MarkdownOptions.syntaxStyle: SyntaxStyle
• property MarkdownOptions.tableOptions?: MarkdownTableOptions
• property MarkdownOptions.treeSitterClient?: TreeSitterClient

interface MarkdownTableOptions

Markdown

• property MarkdownTableOptions.borderColor?: ColorInput
• property MarkdownTableOptions.borderStyle?: BorderStyle
• property MarkdownTableOptions.borders?: boolean
• property MarkdownTableOptions.cellPadding?: number
• property MarkdownTableOptions.cellPaddingX?: number
• property MarkdownTableOptions.cellPaddingY?: number
• property MarkdownTableOptions.columnFitter?: TextTableColumnFitter
• property MarkdownTableOptions.outerBorder?: boolean
• property MarkdownTableOptions.selectable?: boolean
• property MarkdownTableOptions.style?: MarkdownTableStyle
• property MarkdownTableOptions.widthMode?: TextTableColumnWidthMode
• property MarkdownTableOptions.wrapMode?: "none" | "char" | "word"

interface MeasureResult

Added in 0.5.0Overview

• property MeasureResult.lineCount: number0.5.0
• property MeasureResult.widthColsMax: number0.5.0

interface MergedStyle

Tree-sitter

• property MergedStyle.attributes: number
• property MergedStyle.bg?: RGBA
• property MergedStyle.fg?: RGBA

interface NativeBufferGrid

Added in 0.6.0Overview

• property NativeBufferGrid.borderBg: RGBA0.6.0
• property NativeBufferGrid.borderChars: Uint32Array0.6.0
• property NativeBufferGrid.borderFg: RGBA0.6.0
• property NativeBufferGrid.columnOffsets: Int32Array0.6.0
• property NativeBufferGrid.drawInner: boolean0.6.0
• property NativeBufferGrid.drawOuter: boolean0.6.0
• property NativeBufferGrid.rowOffsets: Int32Array0.6.0

interface NativeBufferStack

Added in 0.6.0Overview

• property NativeBufferStack.height?: number0.6.0
• property NativeBufferStack.opacity?: number0.6.0
• property NativeBufferStack.operation: "getOpacity" | "pushScissor" | "popScissor" | "clearScissors" | "pushOpacity" | "popOpacity" | "clearOpacity"0.6.0
• property NativeBufferStack.width?: number0.6.0
• property NativeBufferStack.x?: number0.6.0
• property NativeBufferStack.y?: number0.6.0

interface NativeContextBufferOptions

Added in 0.6.0Overview

• property NativeContextBufferOptions.height: number0.6.0
• property NativeContextBufferOptions.respectAlpha?: boolean0.6.0
• property NativeContextBufferOptions.width: number0.6.0
• property NativeContextBufferOptions.widthMethod?: WidthMethod | "no-zwj"0.6.0

interface NativeContextEditBufferOptions

Added in 0.6.0Overview

• property NativeContextEditBufferOptions.widthMethod?: WidthMethod | "no-zwj"0.6.0

interface NativeContextImageDraw

Added in 0.6.0Overview

• property NativeContextImageDraw.height: number0.6.0
• property NativeContextImageDraw.pixelHeight?: number0.6.0
• property NativeContextImageDraw.pixelWidth?: number0.6.0
• property NativeContextImageDraw.protocol?: ImageRenderProtocol0.6.0
• property NativeContextImageDraw.sourceHeight?: number0.6.0
• property NativeContextImageDraw.sourceWidth?: number0.6.0
• property NativeContextImageDraw.sourceX?: number0.6.0
• property NativeContextImageDraw.sourceY?: number0.6.0
• property NativeContextImageDraw.width: number0.6.0
• property NativeContextImageDraw.x?: number0.6.0
• property NativeContextImageDraw.y?: number0.6.0

interface NativeContextOptions

Added in 0.6.0Overview

• property NativeContextOptions.objectCapacity: number0.6.0
• property NativeContextOptions.renderCellsMax: number0.6.0

interface NativeEditBufferInfo

Added in 0.6.0Overview

• property NativeEditBufferInfo.byteLength: number0.6.0
• property NativeEditBufferInfo.canRedo: boolean0.6.0
• property NativeEditBufferInfo.canUndo: boolean0.6.0
• property NativeEditBufferInfo.contentEpoch: bigint0.6.0
• property NativeEditBufferInfo.cursor: LogicalCursor0.6.0
• property NativeEditBufferInfo.lineCount: number0.6.0
• property NativeEditBufferInfo.tabWidth: number0.6.0

interface NativeEditorReplacement

Added in 0.6.0Overview

• property NativeEditorReplacement.deleted: boolean0.6.0
• property NativeEditorReplacement.inserted: boolean0.6.0

interface NativeEditorSelection

Added in 0.6.0Overview

• property NativeEditorSelection.anchorX?: number0.6.0
• property NativeEditorSelection.anchorY?: number0.6.0
• property NativeEditorSelection.behavior?: number0.6.0
• property NativeEditorSelection.bg?: RGBA | null0.6.0
• property NativeEditorSelection.end?: number0.6.0
• property NativeEditorSelection.fg?: RGBA | null0.6.0
• property NativeEditorSelection.focusX?: number0.6.0
• property NativeEditorSelection.focusY?: number0.6.0
• property NativeEditorSelection.followCursor?: boolean0.6.0
• property NativeEditorSelection.operation: NativeEditorSelectionOperation0.6.0
• property NativeEditorSelection.start?: number0.6.0
• property NativeEditorSelection.updateCursor?: boolean0.6.0

interface NativeEditorStyle

Added in 0.6.0Overview

• property NativeEditorStyle.attributes?: number | null0.6.0
• property NativeEditorStyle.bg?: RGBA | null0.6.0
• property NativeEditorStyle.fg?: RGBA | null0.6.0

interface NativeEditorViewInfo

Added in 0.6.0Overview

• property NativeEditorViewInfo.selection: { start: number; end: number; } | null0.6.0
• property NativeEditorViewInfo.selectionOccupancy: SelectionOccupancy0.6.0
• property NativeEditorViewInfo.totalVirtualLineCount: number0.6.0
• property NativeEditorViewInfo.virtualLineCount: number0.6.0

interface NativeEditorViewport

Added in 0.6.0Overview

• property NativeEditorViewport.height: number0.6.0
• property NativeEditorViewport.width: number0.6.0
• property NativeEditorViewport.x: number0.6.0
• property NativeEditorViewport.y: number0.6.0

interface NativeEncodedStyledText

Added in 0.6.0Overview

• property NativeEncodedStyledText.bytes: Uint8Array0.6.0
• property NativeEncodedStyledText.count: number0.6.0
• property NativeEncodedStyledText.records: Uint32Array0.6.0
• property NativeEncodedStyledText.urlBytes: Uint8Array0.6.0

interface NativeImagePoolOptions extends ImageCreateOptions

Added in 0.5.10Native images

• property NativeImagePoolOptions.capacity?: number0.5.10
• property NativeImagePoolOptions.height: number0.5.10
• property NativeImagePoolOptions.width: number0.5.10

interface NativeOutputTicket

Added in 0.6.0Overview

• property NativeOutputTicket.byteCount: number0.6.0
• property NativeOutputTicket.requestId: bigint0.6.0
• property NativeOutputTicket.session: SessionHandle0.6.0

interface NativeRenderableIntegration

Added in 0.6.0Custom renderables

• readonly property NativeRenderableIntegration.beforeAfter?: boolean0.6.0
• readonly property NativeRenderableIntegration.body: "host" | { readonly native: (buffer: OptimizedBuffer, deltaTime: number) => void; readonly buffered?: boolean; }0.6.0
• readonly property NativeRenderableIntegration.bufferComposition?: "native"0.6.0
• readonly property NativeRenderableIntegration.construction?: "prototype" | "fields"0.6.0
• readonly property NativeRenderableIntegration.kind: Parameters<NativeScene["driver"]["renderLib"]["sceneCreateNode"]>[2]0.6.0
• readonly property NativeRenderableIntegration.lifecycle?: { readonly resize?: { readonly native: (width: number, height: number) => void; }; readonly update?: { readonly idle: (deltaTime: number) => void; readonly active: (renderable: Renderable) => boolean; }; }0.6.0
• readonly property NativeRenderableIntegration.lineInfo?: boolean0.6.0
• readonly property NativeRenderableIntegration.measure?: (this: Renderable, ...constraints: Parameters<MeasureFunction>) => ReturnType<MeasureFunction>0.6.0
• readonly property NativeRenderableIntegration.paintBuffer?: "destination"0.6.0

interface NativeResourceOwner

Added in 0.6.0How Core uses native

• readonly property NativeResourceOwner.resourceContext: ResourceContext0.6.0

interface NativeSceneArrowOptions

Added in 0.6.0Overview

• property NativeSceneArrowOptions.attributes: number0.6.0
• property NativeSceneArrowOptions.backgroundColor: RGBA0.6.0
• property NativeSceneArrowOptions.direction: "up" | "down" | "left" | "right"0.6.0
• property NativeSceneArrowOptions.foregroundColor: RGBA0.6.0
• property NativeSceneArrowOptions.text?: string0.6.0

interface NativeSceneBoxDetails

Added in 0.6.0Overview

• property NativeSceneBoxDetails.bottomTitle?: string0.6.0
• property NativeSceneBoxDetails.bottomTitleAlignment: "left" | "center" | "right"0.6.0
• property NativeSceneBoxDetails.customBorderChars?: Uint32Array0.6.0
• property NativeSceneBoxDetails.title?: string0.6.0
• property NativeSceneBoxDetails.titleAlignment: "left" | "center" | "right"0.6.0
• property NativeSceneBoxDetails.titleColor?: RGBA0.6.0

interface NativeSceneEditorOptions

Added in 0.6.0Overview

• property NativeSceneEditorOptions.blinking: boolean0.6.0
• property NativeSceneEditorOptions.color: RGBA0.6.0
• property NativeSceneEditorOptions.cursor?: MousePointerStyle0.6.0
• property NativeSceneEditorOptions.showCursor: boolean0.6.0
• property NativeSceneEditorOptions.style: "block" | "line" | "underline" | "default"0.6.0

interface NativeSceneFrameOptions

Added in 0.6.0Overview

• property NativeSceneFrameOptions.background: RGBA0.6.0
• property NativeSceneFrameOptions.excludedHitNum: number0.6.0
• property NativeSceneFrameOptions.maxHostRequests: number0.6.0
• property NativeSceneFrameOptions.maxLayoutRounds: number0.6.0
• property NativeSceneFrameOptions.preserveUnwritten?: boolean0.6.0
• property NativeSceneFrameOptions.useMouse: boolean0.6.0

interface NativeSceneFrameRequest

Added in 0.6.0Overview

• property NativeSceneFrameRequest.geometryRevision?: number0.6.0
• property NativeSceneFrameRequest.paintLayout?: NativeSceneLayout0.6.0
• property NativeSceneFrameRequest.publicLayout?: NativeSceneLayout0.6.0
• readonly property NativeSceneFrameRequest.frameId: bigint0.6.0
• readonly property NativeSceneFrameRequest.height: number0.6.0
• readonly property NativeSceneFrameRequest.hookGeneration: bigint0.6.0
• readonly property NativeSceneFrameRequest.kind: NativeSceneFrame0.6.0
• readonly property NativeSceneFrameRequest.layoutEpoch: bigint0.6.0
• readonly property NativeSceneFrameRequest.node: SceneNodeHandle0.6.0
• readonly property NativeSceneFrameRequest.num: number0.6.0
• readonly property NativeSceneFrameRequest.requestId: bigint0.6.0
• readonly property NativeSceneFrameRequest.root: SceneNodeHandle0.6.0
• readonly property NativeSceneFrameRequest.session: SessionHandle0.6.0
• readonly property NativeSceneFrameRequest.width: number0.6.0

interface NativeSceneLayout

Added in 0.6.0Overview

• property NativeSceneLayout.bottom: number0.6.0
• property NativeSceneLayout.height: number0.6.0
• property NativeSceneLayout.left: number0.6.0
• property NativeSceneLayout.right: number0.6.0
• property NativeSceneLayout.screenX: number0.6.0
• property NativeSceneLayout.screenY: number0.6.0
• property NativeSceneLayout.top: number0.6.0
• property NativeSceneLayout.width: number0.6.0

interface NativeScenePaint

Added in 0.6.0Overview

• property NativeScenePaint.backgroundColor: RGBA0.6.0
• property NativeScenePaint.border: number0.6.0
• property NativeScenePaint.borderColor: RGBA0.6.0
• property NativeScenePaint.borderStyle: "single" | "double" | "rounded" | "heavy"0.6.0
• property NativeScenePaint.focusable: boolean0.6.0
• property NativeScenePaint.focusedBorderColor: RGBA0.6.0
• property NativeScenePaint.opacity: number0.6.0
• property NativeScenePaint.shouldFill: boolean0.6.0
• property NativeScenePaint.translateX: number0.6.0
• property NativeScenePaint.translateY: number0.6.0
• property NativeScenePaint.zIndex: number0.6.0

interface NativeScenePaintSlot

Added in 0.6.0Overview

• readonly property NativeScenePaintSlot.hooks: number0.6.0
• readonly property NativeScenePaintSlot.node: SceneNodeHandle0.6.0
• readonly property NativeScenePaintSlot.num: number0.6.0
• readonly property NativeScenePaintSlot.opacity: number0.6.0
• readonly property NativeScenePaintSlot.paintLayout: NativeSceneLayout0.6.0
• readonly property NativeScenePaintSlot.publicLayout?: NativeSceneLayout0.6.0

interface NativeSceneSliderOptions

Added in 0.6.0Overview

• property NativeSceneSliderOptions.backgroundColor: RGBA0.6.0
• property NativeSceneSliderOptions.foregroundColor: RGBA0.6.0
• property NativeSceneSliderOptions.max: number0.6.0
• property NativeSceneSliderOptions.min: number0.6.0
• property NativeSceneSliderOptions.orientation: "horizontal" | "vertical"0.6.0
• property NativeSceneSliderOptions.value: number0.6.0
• property NativeSceneSliderOptions.viewPortSize: number0.6.0

interface NativeSceneTextMetrics

Added in 0.6.0Overview

• property NativeSceneTextMetrics.byteLength: number0.6.0
• property NativeSceneTextMetrics.lineCount: number0.6.0
• property NativeSceneTextMetrics.textLength: number0.6.0
• property NativeSceneTextMetrics.virtualLineCount: number0.6.0
• property NativeSceneTextMetrics.widthColsMax: number0.6.0

interface NativeSceneTextOptions

Added in 0.6.0Overview

• property NativeSceneTextOptions.attributes: number0.6.0
• property NativeSceneTextOptions.bg: RGBA0.6.0
• property NativeSceneTextOptions.fg: RGBA0.6.0
• property NativeSceneTextOptions.firstLineOffset: number0.6.0
• property NativeSceneTextOptions.scrollX: number0.6.0
• property NativeSceneTextOptions.scrollY: number0.6.0
• property NativeSceneTextOptions.tabIndicator?: string | number0.6.0
• property NativeSceneTextOptions.tabIndicatorColor?: RGBA0.6.0
• property NativeSceneTextOptions.textAlign: "left" | "center" | "right"0.6.0
• property NativeSceneTextOptions.truncate: boolean0.6.0
• property NativeSceneTextOptions.wrapMode: "none" | "char" | "word"0.6.0

interface NativeSceneTextSelectionOptions

Added in 0.6.0Overview

• property NativeSceneTextSelectionOptions.anchorX: number0.6.0
• property NativeSceneTextSelectionOptions.anchorY: number0.6.0
• property NativeSceneTextSelectionOptions.behavior: SelectionBehavior0.6.0
• property NativeSceneTextSelectionOptions.bg?: RGBA0.6.0
• property NativeSceneTextSelectionOptions.fg?: RGBA0.6.0
• property NativeSceneTextSelectionOptions.focusX: number0.6.0
• property NativeSceneTextSelectionOptions.focusY: number0.6.0
• property NativeSceneTextSelectionOptions.operation: "reset" | "set" | "update"0.6.0

interface NativeSessionBufferLease

Added in 0.6.0Overview

• property NativeSessionBufferLease.attributes: Pointer0.6.0
• property NativeSessionBufferLease.bg: Pointer0.6.0
• property NativeSessionBufferLease.char: Pointer0.6.0
• property NativeSessionBufferLease.fg: Pointer0.6.0
• property NativeSessionBufferLease.generation: bigint0.6.0
• property NativeSessionBufferLease.handle: ContextObjectHandle0.6.0
• property NativeSessionBufferLease.height: number0.6.0
• property NativeSessionBufferLease.width: number0.6.0

interface NativeSessionCapabilities extends TerminalCapabilities

Added in 0.6.0Overview

• property NativeSessionCapabilities.kittyKeyboardFlags: number0.6.0

interface NativeSessionCursorOptions extends CursorStyleOptions

Added in 0.6.0Overview

• property NativeSessionCursorOptions.position?: { x: number; y: number; visible: boolean; }0.6.0

interface NativeSessionDriverOptions

Added in 0.6.0How Core uses native

• property NativeSessionDriverOptions.closeTimeoutMs?: number0.6.0
• property NativeSessionDriverOptions.context?: NativeContextOptions0.6.0
• property NativeSessionDriverOptions.output?: NativeSessionOptions0.6.0
• property NativeSessionDriverOptions.outputBufferSize?: number0.6.0
• property NativeSessionDriverOptions.scheduler?: NativeSessionScheduler0.6.0

interface NativeSessionKittyImageTransportStatus

Added in 0.6.0Overview

• property NativeSessionKittyImageTransportStatus.effective: number0.6.0
• property NativeSessionKittyImageTransportStatus.fallback: number0.6.0
• property NativeSessionKittyImageTransportStatus.fileState: number0.6.0
• property NativeSessionKittyImageTransportStatus.pendingBytes: number0.6.0
• property NativeSessionKittyImageTransportStatus.pendingFiles: number0.6.0
• property NativeSessionKittyImageTransportStatus.requested: number0.6.0

interface NativeSessionOptions

Added in 0.6.0Overview

• property NativeSessionOptions.chunkSize: number0.6.0
• property NativeSessionOptions.controlCapacity?: number0.6.0
• property NativeSessionOptions.maxBytes: bigint0.6.0
• property NativeSessionOptions.spanCapacity: number0.6.0

interface NativeSessionPumpResult

Added in 0.6.0Overview

• property NativeSessionPumpResult.deadlineNs: bigint | null0.6.0
• property NativeSessionPumpResult.status: NativeSessionPumpStatus0.6.0

interface NativeSessionRendererOptions

Added in 0.6.0Overview

• property NativeSessionRendererOptions.environment?: Readonly<Record<string, string>>0.6.0
• property NativeSessionRendererOptions.height: number0.6.0
• property NativeSessionRendererOptions.remote?: boolean0.6.0
• property NativeSessionRendererOptions.width: number0.6.0

interface NativeSessionRendererState

Added in 0.6.0Overview

• property NativeSessionRendererState.frameCount: bigint0.6.0
• property NativeSessionRendererState.framePending: boolean0.6.0
• property NativeSessionRendererState.height: number0.6.0
• property NativeSessionRendererState.width: number0.6.0

interface NativeSessionScheduler

Added in 0.6.0How Core uses native

• method NativeSessionScheduler.now(): bigint0.6.0
• method NativeSessionScheduler.schedule(callback: () => void, delayMs?: number): () => void0.6.0

interface NativeSessionTerminalOptions

Added in 0.6.0Overview

• property NativeSessionTerminalOptions.clearOnClose?: boolean0.6.0
• property NativeSessionTerminalOptions.kittyKeyboardFlags?: number0.6.0
• property NativeSessionTerminalOptions.mouse?: boolean0.6.0
• property NativeSessionTerminalOptions.mouseMovement?: boolean0.6.0
• property NativeSessionTerminalOptions.useAlternateScreen?: boolean0.6.0

interface NativeSplitSnapshot

Added in 0.6.0Overview

• property NativeSplitSnapshot.rowColumns: number0.6.0
• property NativeSplitSnapshot.snapshot: ContextBufferHandle0.6.0
• property NativeSplitSnapshot.startOnNewLine: boolean0.6.0
• property NativeSplitSnapshot.trailingNewline: boolean0.6.0

interface NativeTextBufferInfo

Added in 0.6.0Overview

• property NativeTextBufferInfo.byteLength: number0.6.0
• property NativeTextBufferInfo.contentEpoch: bigint0.6.0
• property NativeTextBufferInfo.highlightCount: number0.6.0
• property NativeTextBufferInfo.lineCount: number0.6.0
• property NativeTextBufferInfo.tabWidth: number0.6.0
• property NativeTextBufferInfo.textLength: number0.6.0

interface NativeYogaLayout

Added in 0.4.1Overview

• property NativeYogaLayout.bottom: number0.4.1
• property NativeYogaLayout.height: number0.4.1
• property NativeYogaLayout.left: number0.4.1
• property NativeYogaLayout.right: number0.4.1
• property NativeYogaLayout.top: number0.4.1
• property NativeYogaLayout.width: number0.4.1

interface NormalizedColorValue

Colors

• property NormalizedColorValue.rgba: RGBA

interface NormalizedTerminalPalette

Terminal capabilities

• property NormalizedTerminalPalette.defaultBackground: RGBA
• property NormalizedTerminalPalette.defaultForeground: RGBA
• property NormalizedTerminalPalette.palette: RGBA[]

interface OwnedRawImage extends RawImage

Added in 0.5.0Native images

• method OwnedRawImage.dispose(): void0.5.0

interface ParsedBuffer extends BufferState

Tree-sitter

• property ParsedBuffer.hasParser: true

interface ParsedKey

Keyboard input

• property ParsedKey.baseCode?: number
• property ParsedKey.capsLock?: boolean
• property ParsedKey.code?: string
• property ParsedKey.ctrl: boolean
• property ParsedKey.eventType: KeyEventType
• property ParsedKey.hyper?: boolean
• property ParsedKey.meta: boolean
• property ParsedKey.name: string
• property ParsedKey.numLock?: boolean
• property ParsedKey.number: boolean
• property ParsedKey.option: boolean
• property ParsedKey.raw: string
• property ParsedKey.repeated?: boolean
• property ParsedKey.sequence: string
• property ParsedKey.shift: boolean
• property ParsedKey.source: "raw" | "kitty"
• property ParsedKey.super?: boolean

interface ParseState

Markdown

• property ParseState.content: string
• property ParseState.stableTokenCount?: number
• property ParseState.tokens: MarkedToken[]

interface PasteMetadata

Keyboard input

• property PasteMetadata.kind?: PasteKind
• property PasteMetadata.mimeType?: string

interface PendingCall

Renderables

• property PendingCall.args: any[]
• property PendingCall.isProperty?: boolean
• property PendingCall.method: string

interface PerformanceStats

Tree-sitter

• property PerformanceStats.averageParseTime: number
• property PerformanceStats.averageQueryTime: number
• property PerformanceStats.parseTimes: number[]
• property PerformanceStats.queryTimes: number[]

interface PixelImportOptions extends ImageCreateOptions

Added in 0.5.10Native images

• property PixelImportOptions.alpha?: "straight" | "opaque"0.5.10
• property PixelImportOptions.colorSpace?: "srgb"0.5.10
• property PixelImportOptions.format?: PixelFormat0.5.10
• property PixelImportOptions.stride?: number0.5.10

interface Plugin<TNode, TSlots extends object, TContext extends PluginContext = PluginContext>

Overview

• property Plugin.dispose?: () => void
• property Plugin.id: string
• property Plugin.order?: number
• property Plugin.setup?: (ctx: Readonly<TContext>, renderer: CliRenderer) => void
• property Plugin.slots: { [K in keyof TSlots]?: SlotRenderer<TNode, TSlots[K], TContext>; }

interface PluginErrorEvent

Overview

• property PluginErrorEvent.error: Error
• property PluginErrorEvent.phase: PluginErrorPhase
• property PluginErrorEvent.pluginId: string
• property PluginErrorEvent.slot?: string
• property PluginErrorEvent.source: PluginErrorSource
• property PluginErrorEvent.timestamp: number

interface PluginErrorReport

Overview

• property PluginErrorReport.error: unknown
• property PluginErrorReport.phase: PluginErrorPhase
• property PluginErrorReport.pluginId: string
• property PluginErrorReport.slot?: string
• property PluginErrorReport.source?: PluginErrorSource

interface Position

Renderables

• property Position.bottom?: number | "auto" | `${number}%`
• property Position.left?: number | "auto" | `${number}%`
• property Position.right?: number | "auto" | `${number}%`
• property Position.top?: number | "auto" | `${number}%`

interface RawImage

Added in 0.5.0Native images

• property RawImage.alpha: "straight"0.5.0
• property RawImage.colorSpace: "srgb"0.5.0
• property RawImage.data: Uint8Array0.5.0
• property RawImage.format: PixelFormat0.5.0
• property RawImage.height: number0.5.0
• property RawImage.stride: number0.5.0
• property RawImage.width: number0.5.0

interface RenderableOptions<T extends BaseRenderable = BaseRenderable> extends Partial<LayoutOptions>

Renderables

• property RenderableOptions.buffered?: boolean
• property RenderableOptions.height?: number | "auto" | `${number}%`
• property RenderableOptions.live?: boolean
• property RenderableOptions.onKeyDown?: (key: KeyEvent) => void
• property RenderableOptions.onMouse?: (this: T, event: MouseEvent) => void
• property RenderableOptions.onMouseDown?: (this: T, event: MouseEvent) => void
• property RenderableOptions.onMouseDrag?: (this: T, event: MouseEvent) => void
• property RenderableOptions.onMouseDragEnd?: (this: T, event: MouseEvent) => void
• property RenderableOptions.onMouseDrop?: (this: T, event: MouseEvent) => void
• property RenderableOptions.onMouseMove?: (this: T, event: MouseEvent) => void
• property RenderableOptions.onMouseOut?: (this: T, event: MouseEvent) => void
• property RenderableOptions.onMouseOver?: (this: T, event: MouseEvent) => void
• property RenderableOptions.onMouseScroll?: (this: T, event: MouseEvent) => void
• property RenderableOptions.onMouseUp?: (this: T, event: MouseEvent) => void
• property RenderableOptions.onPaste?: (this: T, event: PasteEvent) => void
• property RenderableOptions.onSizeChange?: (this: T) => void
• property RenderableOptions.opacity?: number
• property RenderableOptions.renderAfter?: (this: T, buffer: OptimizedBuffer, deltaTime: number) => void
• property RenderableOptions.renderBefore?: (this: T, buffer: OptimizedBuffer, deltaTime: number) => void
• property RenderableOptions.visible?: boolean
• property RenderableOptions.width?: number | "auto" | `${number}%`
• property RenderableOptions.zIndex?: number

interface RenderContext extends EventEmitter

Renderer

• property RenderContext.blurRenderable: (renderable: Renderable) => void
• property RenderContext.cancelAnimationFrame: (handle: number) => void0.6.0
• property RenderContext.capabilities: TerminalCapabilities | null
• property RenderContext.claimFirstLineOffset?: (renderable?: Renderable) => number
• property RenderContext.clearSelection: () => void
• property RenderContext.currentFocusedEditor: EditBufferRenderable | null
• property RenderContext.currentFocusedRenderable: Renderable | null
• property RenderContext.dropLive: () => void
• property RenderContext.focusRenderable: (renderable: Renderable) => void
• property RenderContext.frameId: number
• property RenderContext.getLifecyclePasses: () => Set<Renderable>
• property RenderContext.getSelection: () => Selection | null
• property RenderContext.hasSelection: boolean
• property RenderContext.height: number
• property RenderContext.keyInput: KeyHandler
• property RenderContext.registerLifecyclePass: (renderable: Renderable) => void
• property RenderContext.requestAnimationFrame: (callback: FrameRequestCallback) => number0.6.0
• property RenderContext.requestLive: () => void
• property RenderContext.requestRender: () => void
• property RenderContext.requestSelectionUpdate: () => void
• property RenderContext.resolution?: { width: number; height: number; } | null0.5.0
• property RenderContext.setCursorColor: (color: RGBA) => void
• property RenderContext.setCursorPosition: (x: number, y: number, visible: boolean) => void
• property RenderContext.setCursorStyle: (options: CursorStyleOptions) => void
• property RenderContext.setMousePointer: (shape: MousePointerStyle) => void
• property RenderContext.startSelection: (renderable: Renderable, x: number, y: number, behavior?: SelectionBehavior) => void
• property RenderContext.terminalHeight?: number0.5.0
• property RenderContext.terminalWidth?: number0.5.0
• property RenderContext.unregisterLifecyclePass: (renderable: Renderable) => void
• property RenderContext.updateSelection: (currentRenderable: Renderable | undefined, x: number, y: number, options?: { finishDragging?: boolean; }) => void
• property RenderContext.width: number
• property RenderContext.widthMethod: WidthMethod
• readonly property RenderContext.nativeScene: NativeScene0.6.0

interface RendererClipboardBoundary

Added in 0.5.2Clipboard

• method RendererClipboardBoundary.clearClipboardOSC52(target?: ClipboardTarget): boolean0.5.2
• method RendererClipboardBoundary.copyToClipboardOSC52(text: string, target?: ClipboardTarget): boolean0.5.2
• readonly property RendererClipboardBoundary.capabilities: { readonly remote: boolean; readonly osc52_support: "supported" | "unsupported" | "unknown"; } | null0.5.2

interface RendererEvents

Renderer

• property RendererEvents."debugOverlay:toggle": (enabled: boolean) => void
• property RendererEvents."memory:snapshot": (snapshot: { heapUsed: number; heapTotal: number; arrayBuffers: number; }) => void
• property RendererEvents.capabilities: (capabilities: TerminalCapabilities) => void
• property RendererEvents.focused_editor: (current: EditBufferRenderable | null, previous: EditBufferRenderable | null) => void
• property RendererEvents.focused_renderable: (current: Renderable | null, previous: Renderable | null) => void
• property RendererEvents.key: (data: Buffer) => void
• property RendererEvents.resize: (width: number, height: number) => void
• property RendererEvents.selection: (selection: Selection) => void
• property RendererEvents.theme_mode: (mode: ThemeMode) => void

interface RendererSchedulerState

Renderer

• property RendererSchedulerState.hasScheduledRender: boolean
• property RendererSchedulerState.isRendering: boolean
• property RendererSchedulerState.isRunning: boolean

interface RenderNodeContext

Markdown

• property RenderNodeContext.conceal: boolean
• property RenderNodeContext.concealCode: boolean
• property RenderNodeContext.defaultRender: () => Renderable | null
• property RenderNodeContext.syntaxStyle: SyntaxStyle
• property RenderNodeContext.treeSitterClient?: TreeSitterClient

interface ResizeOptions

Added in 0.5.0Native images

• property ResizeOptions.height?: number0.5.0
• property ResizeOptions.kernel?: ResizeKernel0.5.0
• property ResizeOptions.width?: number0.5.0

interface ResolvedSlotRenderer<TNode, TProps, TContext extends PluginContext = PluginContext>

Overview

• property ResolvedSlotRenderer.id: string
• property ResolvedSlotRenderer.renderer: SlotRenderer<TNode, TProps, TContext>

interface ScrollAcceleration

Interaction

• method ScrollAcceleration.reset(): void
• method ScrollAcceleration.tick(now?: number): number

interface ScrollbackRenderContext

Renderer

• property ScrollbackRenderContext.renderContext: RenderContext
• property ScrollbackRenderContext.tailColumn: number
• property ScrollbackRenderContext.width: number
• property ScrollbackRenderContext.widthMethod: WidthMethod

interface ScrollbackSnapshot

Renderer

• property ScrollbackSnapshot.height?: number
• property ScrollbackSnapshot.root: Renderable
• property ScrollbackSnapshot.rowColumns?: number
• property ScrollbackSnapshot.startOnNewLine?: boolean
• property ScrollbackSnapshot.teardown?: () => void
• property ScrollbackSnapshot.trailingNewline?: boolean
• property ScrollbackSnapshot.width?: number

interface ScrollbackSurface

Renderer

• method ScrollbackSurface.commitRows(startRow: number, endRowExclusive: number, options?: ScrollbackSurfaceCommitOptions): void
• method ScrollbackSurface.destroy(): void
• method ScrollbackSurface.render(): void
• method ScrollbackSurface.settle(timeoutMs?: number): Promise<void>
• readonly property ScrollbackSurface.height: number
• readonly property ScrollbackSurface.isDestroyed: boolean
• readonly property ScrollbackSurface.renderContext: RenderContext
• readonly property ScrollbackSurface.root: Renderable
• readonly property ScrollbackSurface.width: number

interface ScrollbackSurfaceCommitOptions

Renderer

• property ScrollbackSurfaceCommitOptions.rowColumns?: number
• property ScrollbackSurfaceCommitOptions.trailingNewline?: boolean

interface ScrollbackSurfaceOptions

Renderer

• property ScrollbackSurfaceOptions.startOnNewLine?: boolean

interface ScrollBarOptions extends RenderableOptions<ScrollBarRenderable>

ScrollBar

• property ScrollBarOptions.arrowOptions?: Omit<ArrowOptions, "direction">
• property ScrollBarOptions.onChange?: (position: number) => void
• property ScrollBarOptions.orientation: "vertical" | "horizontal"
• property ScrollBarOptions.showArrows?: boolean
• property ScrollBarOptions.trackOptions?: Partial<SliderOptions>

interface ScrollBoxOptions extends BoxOptions<ScrollBoxRenderable>

ScrollBox

• property ScrollBoxOptions.contentOptions?: BoxOptions
• property ScrollBoxOptions.horizontalScrollbarOptions?: Omit<ScrollBarOptions, "orientation">
• property ScrollBoxOptions.rootOptions?: BoxOptions
• property ScrollBoxOptions.scrollAcceleration?: ScrollAcceleration
• property ScrollBoxOptions.scrollX?: boolean
• property ScrollBoxOptions.scrollY?: boolean
• property ScrollBoxOptions.scrollbarOptions?: Omit<ScrollBarOptions, "orientation">
• property ScrollBoxOptions.stickyScroll?: boolean
• property ScrollBoxOptions.stickyStart?: "bottom" | "top" | "left" | "right"
• property ScrollBoxOptions.verticalScrollbarOptions?: Omit<ScrollBarOptions, "orientation">
• property ScrollBoxOptions.viewportCulling?: boolean
• property ScrollBoxOptions.viewportOptions?: BoxOptions
• property ScrollBoxOptions.wrapperOptions?: BoxOptions

interface ScrollInfo

Interaction

• property ScrollInfo.delta: number
• property ScrollInfo.direction: "up" | "down" | "left" | "right"

interface SelectOption

Select

• property SelectOption.description: string
• property SelectOption.name: string
• property SelectOption.value?: any

interface SelectRenderableOptions extends RenderableOptions<SelectRenderable>

Select

• property SelectRenderableOptions.backgroundColor?: ColorInput
• property SelectRenderableOptions.descriptionColor?: ColorInput
• property SelectRenderableOptions.fastScrollStep?: number
• property SelectRenderableOptions.focusedBackgroundColor?: ColorInput
• property SelectRenderableOptions.focusedTextColor?: ColorInput
• property SelectRenderableOptions.font?: keyof typeof fonts
• property SelectRenderableOptions.itemSpacing?: number
• property SelectRenderableOptions.keyAliasMap?: KeyAliasMap
• property SelectRenderableOptions.keyBindings?: SelectKeyBinding[]
• property SelectRenderableOptions.options?: SelectOption[]
• property SelectRenderableOptions.selectedBackgroundColor?: ColorInput
• property SelectRenderableOptions.selectedDescriptionColor?: ColorInput
• property SelectRenderableOptions.selectedIndex?: number
• property SelectRenderableOptions.selectedTextColor?: ColorInput
• property SelectRenderableOptions.showDescription?: boolean
• property SelectRenderableOptions.showScrollIndicator?: boolean
• property SelectRenderableOptions.showSelectionIndicator?: boolean0.4.3
• property SelectRenderableOptions.textColor?: ColorInput
• property SelectRenderableOptions.wrapSelection?: boolean

interface SliderOptions extends RenderableOptions<SliderRenderable>

Slider

• property SliderOptions.backgroundColor?: ColorInput
• property SliderOptions.foregroundColor?: ColorInput
• property SliderOptions.max?: number
• property SliderOptions.min?: number
• property SliderOptions.onChange?: (value: number) => void
• property SliderOptions.orientation: "vertical" | "horizontal"
• property SliderOptions.value?: number
• property SliderOptions.viewPortSize?: number

interface SlotRegistryOptions

Overview

• property SlotRegistryOptions.debugPluginErrors?: boolean
• property SlotRegistryOptions.maxPluginErrors?: number
• property SlotRegistryOptions.onPluginError?: (event: PluginErrorEvent) => void

interface SlotRenderableOptions<TSlotName extends string, K extends TSlotName, TContext extends PluginContext = PluginContext, TData extends object = Record<string, unknown>> extends RenderableOptions

Core

• property SlotRenderableOptions.data?: TData
• property SlotRenderableOptions.fallback?: FallbackNodes | (() => FallbackNodes)
• property SlotRenderableOptions.mode?: CoreSlotMode
• property SlotRenderableOptions.name: K
• property SlotRenderableOptions.pluginFailurePlaceholder?: CoreSlotFailurePlaceholder<TContext>
• property SlotRenderableOptions.registry: CoreSlotRegistry<TSlotName, TContext, TData>

interface SplitFooterReplayResetOptions

Added in 0.3.1Renderer

• property SplitFooterReplayResetOptions.clearSavedLines?: boolean0.3.1

interface StdinParserOptions

Keyboard input

• property StdinParserOptions.armTimeouts?: boolean
• property StdinParserOptions.clock?: Clock
• property StdinParserOptions.maxPendingBytes?: number
• property StdinParserOptions.onTimeoutFlush?: () => void
• property StdinParserOptions.protocolContext?: Partial<StdinParserProtocolContext>
• property StdinParserOptions.timeoutMs?: number
• property StdinParserOptions.useKittyKeyboard?: boolean

interface StdinParserProtocolContext

Keyboard input

• property StdinParserProtocolContext.explicitWidthCprActive: boolean
• property StdinParserProtocolContext.kittyKeyboardEnabled: boolean
• property StdinParserProtocolContext.pixelResolutionQueryActive: boolean
• property StdinParserProtocolContext.privateCapabilityRepliesActive: boolean
• property StdinParserProtocolContext.startupCursorCprActive: boolean

interface StyleAttrs

Text and terminal cells

• property StyleAttrs.bg?: Color
• property StyleAttrs.blink?: boolean
• property StyleAttrs.bold?: boolean
• property StyleAttrs.dim?: boolean
• property StyleAttrs.fg?: Color
• property StyleAttrs.italic?: boolean
• property StyleAttrs.reverse?: boolean
• property StyleAttrs.strikethrough?: boolean
• property StyleAttrs.underline?: boolean

interface StyleDefinition

Tree-sitter

• property StyleDefinition.bg?: RGBA
• property StyleDefinition.bold?: boolean
• property StyleDefinition.dim?: boolean
• property StyleDefinition.fg?: RGBA
• property StyleDefinition.italic?: boolean
• property StyleDefinition.underline?: boolean

interface StyleDefinitionInput

Tree-sitter

• property StyleDefinitionInput.bg?: ColorInput
• property StyleDefinitionInput.bold?: boolean
• property StyleDefinitionInput.dim?: boolean
• property StyleDefinitionInput.fg?: ColorInput
• property StyleDefinitionInput.italic?: boolean
• property StyleDefinitionInput.underline?: boolean

interface SubmitEvent

Textarea

interface TabSelectOption

TabSelect

• property TabSelectOption.description: string
• property TabSelectOption.name: string
• property TabSelectOption.value?: any

interface TabSelectRenderableOptions extends Omit<RenderableOptions<TabSelectRenderable>, "height">

TabSelect

• property TabSelectRenderableOptions.backgroundColor?: ColorInput
• property TabSelectRenderableOptions.focusedBackgroundColor?: ColorInput
• property TabSelectRenderableOptions.focusedTextColor?: ColorInput
• property TabSelectRenderableOptions.height?: number
• property TabSelectRenderableOptions.keyAliasMap?: KeyAliasMap
• property TabSelectRenderableOptions.keyBindings?: TabSelectKeyBinding[]
• property TabSelectRenderableOptions.options?: TabSelectOption[]
• property TabSelectRenderableOptions.selectedBackgroundColor?: ColorInput
• property TabSelectRenderableOptions.selectedDescriptionColor?: ColorInput
• property TabSelectRenderableOptions.selectedTextColor?: ColorInput
• property TabSelectRenderableOptions.showDescription?: boolean
• property TabSelectRenderableOptions.showScrollArrows?: boolean
• property TabSelectRenderableOptions.showUnderline?: boolean
• property TabSelectRenderableOptions.tabWidth?: number
• property TabSelectRenderableOptions.textColor?: ColorInput
• property TabSelectRenderableOptions.wrapSelection?: boolean

interface TerminalCapabilities

Renderer

• property TerminalCapabilities.ansi256: boolean
• property TerminalCapabilities.bracketed_paste: boolean
• property TerminalCapabilities.color_scheme_updates: boolean
• property TerminalCapabilities.explicit_cursor_positioning: boolean
• property TerminalCapabilities.explicit_width: boolean
• property TerminalCapabilities.focus_tracking: boolean
• property TerminalCapabilities.hyperlinks: boolean
• property TerminalCapabilities.image_protocol?: ImageRenderProtocol0.5.0
• property TerminalCapabilities.kitty_graphics: boolean
• property TerminalCapabilities.kitty_keyboard: boolean
• property TerminalCapabilities.multiplexer: TerminalMultiplexer
• property TerminalCapabilities.notifications: boolean
• property TerminalCapabilities.osc52: boolean
• property TerminalCapabilities.osc52_support: TerminalCapabilityState0.4.2
• property TerminalCapabilities.remote: boolean
• property TerminalCapabilities.rgb: boolean
• property TerminalCapabilities.scaled_text: boolean
• property TerminalCapabilities.sgr_pixels: boolean
• property TerminalCapabilities.sixel: boolean
• property TerminalCapabilities.sync: boolean
• property TerminalCapabilities.terminal: TerminalInfo
• property TerminalCapabilities.unicode: WidthMethod

interface TerminalClipboardAdapter

Added in 0.5.2Clipboard

• method TerminalClipboardAdapter.clear(selection: ClipboardSelection): TerminalClipboardOperationResult0.5.2
• method TerminalClipboardAdapter.writeText(text: string, selection: ClipboardSelection): TerminalClipboardOperationResult0.5.2
• readonly property TerminalClipboardAdapter.remote: boolean0.5.2

interface TerminalClipboardOperationResult

Added in 0.5.2Clipboard

• readonly property TerminalClipboardOperationResult.capability: "supported" | "unsupported" | "unknown"0.5.2
• readonly property TerminalClipboardOperationResult.status: "attempted" | "local-failure" | "not-attempted"0.5.2

interface TerminalColors

Terminal capabilities

• property TerminalColors.cursorColor: Hex
• property TerminalColors.defaultBackground: Hex
• property TerminalColors.defaultForeground: Hex
• property TerminalColors.highlightBackground: Hex
• property TerminalColors.highlightForeground: Hex
• property TerminalColors.mouseBackground: Hex
• property TerminalColors.mouseForeground: Hex
• property TerminalColors.palette: Hex[]
• property TerminalColors.tekBackground: Hex
• property TerminalColors.tekForeground: Hex

interface TerminalInfo

Renderer

• property TerminalInfo.from_xtversion: boolean
• property TerminalInfo.name: string
• property TerminalInfo.version: string

interface TerminalPaletteDetector

Terminal capabilities

• method TerminalPaletteDetector.cleanup(): void
• method TerminalPaletteDetector.detect(options?: GetPaletteOptions): Promise<TerminalColors>
• method TerminalPaletteDetector.detectOSCSupport(timeoutMs?: number): Promise<boolean>

interface TerminalPaletteOptions

Terminal capabilities

• property TerminalPaletteOptions.clock?: Clock
• property TerminalPaletteOptions.isLegacyTmux?: boolean
• property TerminalPaletteOptions.isTmux?: boolean
• property TerminalPaletteOptions.oscSource?: OscSubscriptionSource
• property TerminalPaletteOptions.stdin: NodeJS.ReadStream
• property TerminalPaletteOptions.stdout: NodeJS.WriteStream
• property TerminalPaletteOptions.writeFn?: WriteFunction

interface TextareaOptions extends EditBufferOptions

Textarea

• property TextareaOptions.backgroundColor?: ColorInput
• property TextareaOptions.focusedBackgroundColor?: ColorInput
• property TextareaOptions.focusedTextColor?: ColorInput
• property TextareaOptions.initialValue?: string
• property TextareaOptions.keyAliasMap?: TextareaKeyAliasMap
• property TextareaOptions.keyBindings?: KeyBinding[]
• property TextareaOptions.onSubmit?: (event: SubmitEvent) => void
• property TextareaOptions.placeholder?: StyledText | string | null
• property TextareaOptions.placeholderColor?: ColorInput
• property TextareaOptions.textColor?: ColorInput

interface TextBufferOptions extends RenderableOptions<TextBufferRenderable>

Editing buffers and views

• property TextBufferOptions.attributes?: number
• property TextBufferOptions.bg?: string | RGBA
• property TextBufferOptions.fg?: string | RGBA
• property TextBufferOptions.selectable?: boolean
• property TextBufferOptions.selectionBg?: string | RGBA
• property TextBufferOptions.selectionFg?: string | RGBA
• property TextBufferOptions.tabIndicator?: string | number
• property TextBufferOptions.tabIndicatorColor?: string | RGBA
• property TextBufferOptions.textAlign?: "left" | "center" | "right"0.5.12
• property TextBufferOptions.truncate?: boolean
• property TextBufferOptions.wrapMode?: "none" | "char" | "word"

interface TextChunk

Editing buffers and views

• property TextChunk.attributes?: number
• property TextChunk.bg?: RGBA
• property TextChunk.fg?: RGBA
• property TextChunk.link?: { url: string; }
• property TextChunk.text: string

interface TextNodeOptions extends BaseRenderableOptions

Text and terminal cells

• property TextNodeOptions.attributes?: number
• property TextNodeOptions.bg?: string | RGBA
• property TextNodeOptions.fg?: string | RGBA
• property TextNodeOptions.link?: { url: string; }

interface TextOptions extends TextBufferOptions

Text

• property TextOptions.content?: StyledText | string

interface TextTableOptions extends RenderableOptions<TextTableRenderable>

TextTable

• property TextTableOptions.attributes?: number
• property TextTableOptions.backgroundColor?: ColorInput
• property TextTableOptions.bg?: ColorInput
• property TextTableOptions.border?: boolean
• property TextTableOptions.borderBackgroundColor?: ColorInput
• property TextTableOptions.borderColor?: ColorInput
• property TextTableOptions.borderStyle?: BorderStyle
• property TextTableOptions.cellPadding?: number
• property TextTableOptions.cellPaddingX?: number
• property TextTableOptions.cellPaddingY?: number
• property TextTableOptions.columnFitter?: TextTableColumnFitter
• property TextTableOptions.columnGap?: number
• property TextTableOptions.columnWidthMode?: TextTableColumnWidthMode
• property TextTableOptions.content?: TextTableContent
• property TextTableOptions.fg?: ColorInput
• property TextTableOptions.outerBorder?: boolean
• property TextTableOptions.selectable?: boolean
• property TextTableOptions.selectionBg?: ColorInput
• property TextTableOptions.selectionFg?: ColorInput
• property TextTableOptions.showBorders?: boolean
• property TextTableOptions.wrapMode?: "none" | "char" | "word"

interface ThemeTokenStyle

Tree-sitter

• property ThemeTokenStyle.scope: string[]
• property ThemeTokenStyle.style: { foreground?: ColorInput; background?: ColorInput; bold?: boolean; italic?: boolean; underline?: boolean; dim?: boolean; }

interface TimelineOptions

Animation and Timeline

• property TimelineOptions.autoplay?: boolean
• property TimelineOptions.duration?: number
• property TimelineOptions.loop?: boolean
• property TimelineOptions.onComplete?: () => void
• property TimelineOptions.onPause?: () => void

interface TimeToFirstDrawOptions extends RenderableOptions<TimeToFirstDrawRenderable>

TimeToFirstDraw

• property TimeToFirstDrawOptions.fg?: ColorInput
• property TimeToFirstDrawOptions.label?: string
• property TimeToFirstDrawOptions.precision?: number

interface TreeSitterClientEvents

Tree-sitter

• property TreeSitterClientEvents."buffer:disposed": [ bufferId: number ]
• property TreeSitterClientEvents."buffer:initialized": [ bufferId: number, hasParser: boolean ]
• property TreeSitterClientEvents."highlights:response": [ bufferId: number, version: number, highlights: HighlightResponse[] ]
• property TreeSitterClientEvents."worker:log": [ logType: TreeSitterWorkerLogType, message: string ]
• property TreeSitterClientEvents.error: [ error: string, bufferId?: number ]
• property TreeSitterClientEvents.warning: [ warning: string, bufferId?: number ]

interface TreeSitterClientOptions

Tree-sitter

• property TreeSitterClientOptions.dataPath: string
• property TreeSitterClientOptions.initTimeout?: number
• property TreeSitterClientOptions.workerPath?: string | URL

interface TreeSitterToStyledTextOptions

Tree-sitter

• property TreeSitterToStyledTextOptions.baseHighlight?: string
• property TreeSitterToStyledTextOptions.conceal?: Pick<TextChunkOptions, "enabled">

interface Viewport

Editing buffers and views

• property Viewport.height: number
• property Viewport.offsetX: number
• property Viewport.offsetY: number
• property Viewport.width: number

interface ViewportBounds

Renderer

• property ViewportBounds.height: number
• property ViewportBounds.width: number
• property ViewportBounds.x: number
• property ViewportBounds.y: number

interface VisualCursor

Overview

• property VisualCursor.logicalCol: number
• property VisualCursor.logicalRow: number
• property VisualCursor.offset: number
• property VisualCursor.visualCol: number
• property VisualCursor.visualRow: number

interface VNode<P = any, C = VChild[]>

Renderables

• property VNode.[BrandedVNode]: true
• property VNode.children?: C
• property VNode.props?: P
• property VNode.type: Construct<P>

interface VRenderableOptions extends RenderableOptions<VRenderable>

Renderables

• property VRenderableOptions.render?: (this: VRenderable | VRenderableOptions, buffer: OptimizedBuffer, deltaTime: number, renderable: VRenderable) => void