ink-image

Image component for Ink

Currently only supported on iTerm >=3.

Install

$ npm install ink-image

Usage

import React from 'react';
import {render} from 'ink';
import Image from 'ink-image';

render(
	<Image preserveAspectRatio src='unicorn.jpg' width='50%'/>
);

API

<Image/>

Besides the props below, it accepts props allowed in ansi-escapes.

src

Type: string | Buffer

Path to an image or the image as a Buffer.

alt

Type: string

Alternative text to show when an image can't be displayed.

License

MIT © Kevin Mårtensson