tuil
ReferenceComponentsTerminal image

renderTerminalImage

renderTerminalImage component API, behavior, and executable example.

View rawEdit

Loading executable example…

API and events

Render terminal images when the capability profile permits them and deterministic text fallbacks everywhere else.

export function renderTerminalImage(
  source: TerminalImageSource,
  columns = source.width,
  color = true,
): string;

Props, functions, and events

This declaration has no public members.

No events are emitted.

Callback props run after the documented input is accepted. Callbacks are not cancellable unless their return type or description states otherwise.

Interaction and capabilities

Image output follows terminal capability detection and explicit dimensions.

The published manifest records keyboard, focus, pointer, theme, terminal, semantic, event, and dependency requirements.

Complete import

import { renderTerminalImage } from "@mwillbanks/tuil-ink";

On this page