You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Better image component for [Ink](https://github.com/vadimdemedes/ink) CLI/TUI applications.
4
4
5
-
Display images in your terminal with automatic protocol detection and graceful fallbacks. Supports ASCII, Braille patterns, Unicode half-blocks, and Sixel graphics.
5
+
Display images in your terminal with automatic protocol detection and graceful fallbacks. Supports ASCII, Braille patterns, Unicode half-blocks, Sixel graphics, and iTerm2 inline images.
@@ -58,7 +58,7 @@ Main component with automatic protocol detection and fallback.
58
58
-`width?` (number) - Width in terminal cells
59
59
-`height?` (number) - Height in terminal cells
60
60
-`alt?` (string) - Alternative text for loading/error states
61
-
-`protocol?` (string) - Force specific protocol: `"ascii"`, `"braille"`, `"halfBlock"`, `"sixel"` (`sixel`is experimental, see [Important Notes](#important-notes--caveats))
61
+
-`protocol?` (string) - Force specific protocol: `"ascii" | "braille" | "halfBlock" | "sixel" | "iterm2"` (`sixel`and `iterm2` are experimental, see [Important Notes](#important-notes--caveats))
62
62
63
63
#### Protocols
64
64
@@ -68,6 +68,7 @@ The component automatically selects the best available protocol:
3.**ASCII** (`ascii`) - Character-based art. Works in all terminals (fallback).
70
70
4.**Sixel** (`sixel`) - True color bitmap graphics. Requires Sixel support (experimental).
71
+
5.**iTerm2** (`iterm2`) - True color images in iTerm2-compatible terminals (experimental).
71
72
72
73
### `<TerminalInfoProvider>`
73
74
@@ -87,6 +88,7 @@ import {
87
88
BrailleImage,
88
89
HalfBlockImage,
89
90
SixelImage,
91
+
Iterm2Image,
90
92
} from"ink-picture";
91
93
```
92
94
@@ -98,11 +100,11 @@ import {
98
100
99
101
## Important Notes & Caveats
100
102
101
-
### Sixel Renderer (Experimental)
103
+
### Sixel and iTerm2 Renderers (Experimental)
102
104
103
-
The Sixel renderer provides the highest quality but comes with important limitations:
105
+
The Sixel and iTerm2 renderers provide the highest quality but come with important limitations:
104
106
105
-
⚠️ **Experimental Warning:**The Sixel component bypasses React/Ink's normal rendering pipeline and writes directly to the terminal. You may experience:
107
+
⚠️ **Experimental Warning:**These components bypasses React/Ink's normal rendering pipeline and writes directly to the terminal. You may experience:
0 commit comments