# TerminalImage

Source: /tuil/docs/reference/packages/ink/api/terminal-image
Locale: en

function exported by @mwillbanks/tuil-ink.



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

## function [#function]

Public function exported by `@mwillbanks/tuil-ink`.

```ts
export function TerminalImage({
  source,
  alt,
  columns,
  id: providedId,
  testId,
  ...props
}: TerminalImageProps): ReactNode;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member                                                                             | Type                 | Required | Description                                                                                                                    | Related types                                                                 |
| ---------------------------------------------------------------------------------- | -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------- |
| `{   source,   alt,   columns,   id: providedId,   testId,   ...props }` | `TerminalImageProps` | Yes      | Supplies the `{   source,   alt,   columns,   id: providedId,   testId,   ...props }` value as `TerminalImageProps`. | [`TerminalImageProps`](/tuil/docs/reference/packages/ink/api/terminal-image-props) |

## Returns [#returns]

`ReactNode` — Returns a value that satisfies `ReactNode`.

Related types: —

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`TerminalImageProps`](/tuil/docs/reference/packages/ink/api/terminal-image-props)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/ink/src/image.tsx)

## Package [#package]

[@mwillbanks/tuil-ink](/tuil/docs/reference/packages/ink)