# renderTerminalImage

Source: /tuil/docs/reference/components/terminal-image/render-terminal-image
Locale: en

renderTerminalImage component API, behavior, and executable example.





{/* Generated by tooling/docs/generate-reference.ts. */}

<PublishedStory storyId="platform-expansion" variant="TerminalImage" />

## API and events [#api-and-events]

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

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

### Props, functions, and events [#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 [#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 [#complete-import]

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