DisplayImage class

A widget for displaying images from various sources and formats.

The DisplayImage class is a versatile widget that can display images from either network sources or local assets. It supports common image formats, such as SVG, PNG, JPEG, JPG, and GIF. The widget determines the appropriate rendering method based on the image URL's prefix and extension.

Parameters:

  • imageUrl: The URL or asset path of the image to display.
  • backgroundColor: An optional background color to apply to the image (used as a ColorFilter for SVG and as a tint for other formats).
  • size: The desired size of the image, specified as a Size object.

Usage:

DisplayImage(
  imageUrl: "https://example.com/image.png",
  size: Size(100, 100),
),

The widget handles different image formats and sources:

  • SVG Images: Uses flutter_svg to render SVG images from network or asset sources.
  • Raster Images: For PNG, JPEG/JPG, and GIF, it uses Image.network or Image.asset depending on the source.

If the image extension is not recognized or the URL does not indicate a network-based source, it returns an error icon as a fallback.

Inheritance

Constructors

DisplayImage.new({Key? key, required String imageUrl, Color? backgroundColor, Size? size, BoxFit boxFit = BoxFit.contain})
const

Properties

backgroundColor → Color?
final
boxFit → BoxFit
final
hashCode → int
The hash code for this object.
no setterinherited
imageUrl → String
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
size → Size?
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited