v1.3.5

Maintenance Release

We now have 0 vulnerabilities 🥳

What's Changed

• chore(deps-dev): bump the dependencies group across 1 directory with 5 updates by @dependabot[bot] in #20

Full Changelog: v1.3.4...v1.3.5

v1.3.4

New Features / Fixes

Image component can now render partially-loaded images.

<Image
  src="foo.jpg"
  alt="alt text"
  protocol="kitty" // optionally explicitly specify an image protocol to use
  allowPartial=true // optionally allow partially-loaded images
/>

This behavior is disabled by default.

What's Changed

• ImageProps.allowPartial by @smartacephale in #15
• Migrate to biome and bump dependencies by @dependabot[bot] in #18

New Contributors

• @smartacephale made their first contribution in #15
• @dependabot[bot] made their first contribution in #18

Full Changelog: v1.3.3...v1.3.4

v1.3.3

What's Changed

• hotfix: use ink's stdin and stdout for esc sequence query, add tests by @supreme-gg-gg in #14

Full Changelog: v1.3.2...v1.3.3

v1.3.2

Bug Fixes

• Fixed image scaling on iTerm2 / retina displays
• Fixed stdout raw mode reset when querying for terminal capabilities
• Default for protocol prop in Image is now "auto", this should be fully backwards compatible
• TypeScript API improvements:
  • protocol prop in Image is now a literal of supported protocols instead of a string for better DX
  • Now exports a type for protocol names
• Children of TerminalInfoProvider won't be rendered until info detection is complete, this is to provide better DX while debugging
• Added Warp to the list of terminals that support iTerm2 (we're an agentic image rendering library now btw 😂 )
• Added a heuristic for determining the best image protocol for different terminal emulators when protocol isn't specified, to work around various quirks in their implementations for image rendering

What's Changed

• Improve API types and docs, technical debt payment by @endernoke in #9
• Improve typescript API and image protocol selection logic by @endernoke in #13
• Fix raw mode reset and iTerm2 image scaling by @supreme-gg-gg in #12

New Contributors

• @supreme-gg-gg made their first contribution in #12

Full Changelog: v1.3.1...v1.3.2

v1.3.1

What's Changed

• VS Code support + fix iTerm2 IIP by @endernoke in #8

Full Changelog: v1.3.0...v1.3.1

v1.3.0

What's Changed

• Add kitty graphics renderer by @endernoke in #5

Full Changelog: v1.2.0...v1.3.0

v1.2.0

What's Changed

• Support iTerm2 inline images protocol rendering (works on iTerm2, WezTerm, Konsole, Rio Terminal etc.)

Full Changelog: v1.1.1...v1.2.0

v1.1.1

1.1.1

This is a patch release. No new features are introduced.

What's Changed

• Fixed sixel image flickering and disappearing on first render by adding a slight delay before writing the image to terminal

Full Changelog: v1.1.0...v1.1.1

v1.1.0

Release 1.1.0

This release replaces the dependency on ascii-art with a custom renderer for generating ASCII images. This way the package no longer depends on canvas, which may have non-straightforward installation steps.

No functionality should be affected in this release.

Full Changelog: v1.0.0...v1.1.0

v1.0.0

Release 1.0.0 (First Release 🎉)

This is the first release for ink-picture. It is now live on npm:

npm install ink-picture

I originally created a utility for displaying images in Ink while working on instagram-cli. We didn't have any real option but to code it up from scratch, as the ink-image library is too simplistic and isn't maintained for years.

We realized that rendering images properly anywhere in the terminal, with automatic resizing and smart detection of terminal display capabilities was a more complex task than imagined. (And adding Sixel support is a literal mess.) So we've decided to refactor this small library we've made in-house into a separate public package. I hope the community will find this useful.

Contributions are much appreciated! Feel free to open issues and PRs for bugs and/or feature requests.