Image class

A widget that displays an image in the terminal.

Uses HalfBlockImageDrawable for cross-terminal compatibility, rendering images using half-block characters (▀) with foreground/background colors.

The image parameter provides the image data asynchronously. While loading, placeholder is displayed. If loading fails, errorWidget is shown.

Image(
  image: FileImage('photo.png'),
  width: 40,
  height: 20,
  fit: BoxFit.contain,
)

Inheritance

Constructors

Image({required ImageProvider image, int? width, int? height, BoxFit fit = BoxFit.contain, Widget? placeholder, Widget? errorWidget, Key? key})

children → List<Widget>: Child widgets that receive forwarded messages.
no setterinherited
debugRenderObjectPassthrough → bool: Whether this widget is intentionally transparent to render-object layouts.
no setterinherited
errorWidget → Widget?: Widget to display if loading fails.
final
fit → BoxFit: How the image should be fitted into the available space.
final
focusable → bool: Whether this widget can receive keyboard focus.
no setterinherited
hashCode → int: The hash code for this object.
no setterinherited
height → int?: Desired height in terminal rows. Defaults to half the image height (since each row encodes 2 pixel rows via half-blocks).
final
id → String: Unique identifier for this widget.
no setterinherited
image → ImageProvider: The image provider that resolves to image data.
final
key → Key?: Key for preserving widget identity.
finalinherited
placeholder → Widget?: Widget to display while the image is loading.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
theme → Theme: Access the current theme.
no setterinherited
width → int?: Desired width in terminal columns. Defaults to image width.
final

buildCachedView<T>(T builder(), Object? cacheKey) → T: Returns a cached view if the cache key matches.
inherited
createState() → State<Image>: Creates the mutable State associated with this widget.
override
handleInit() → Cmd?: Override this instead of init for widget-specific initialization.
inherited
handleIntercept(Msg msg) → (Widget, Cmd?): Override this to handle messages before they reach children.
inherited
handleUpdate(Msg msg) → (Widget, Cmd?): Override this to handle messages specific to this widget.
inherited
init() → Cmd?: Called once when the widget is first mounted.
inherited
invalidateCachedView() → void: Clears any cached view for this widget.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited
update(Msg msg) → (Model, Cmd?): Handles messages by forwarding to children then calling handleUpdate.
inherited
view() → Object: Renders the widget to a string or View.
inherited