ArnaAvatar class
A rounded square that represents a user.
Typically used with a user's profile image, or, in the absence of such an image, the user's initials. A given user's initials should always be paired with the same background color, for consistency.
If foregroundImage fails then backgroundImage is used. If backgroundImage fails too, backgroundColor is used.
The onBackgroundImageError parameter must be null if the backgroundImage is null. The onForegroundImageError parameter must be null if the foregroundImage is null.
{@tool snippet}
If the avatar is to have an image, the image should be specified in the backgroundImage property:
ArnaAvatar(
backgroundImage: NetworkImage(userAvatarUrl),
)
{@end-tool}
The image will be cropped to have a rounded square shape.
{@tool snippet}
If the avatar is to just have the user's initials, they are typically provided using a Text widget as the child and a backgroundColor:
ArnaAvatar(
backgroundColor: ArnaColors.blue,
child: const Text('AH'),
)
{@end-tool}
See also:
- ArnaListTile, which can combine an icon (such as an ArnaAvatar) with some text for a fixed height list entry.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- ArnaAvatar
Constructors
-
ArnaAvatar({Key? key, Widget? child, Color? backgroundColor, ImageProvider<
Object> ? backgroundImage, ImageProvider<Object> ? foregroundImage, ImageErrorListener? onBackgroundImageError, ImageErrorListener? onForegroundImageError, Color? foregroundColor, double? size}) -
Creates a rounded square that represents a user.
const
Properties
- backgroundColor → Color?
-
The color with which to fill the rounded square. Changing the background color will cause the avatar to animate
to the new color.
final
-
backgroundImage
→ ImageProvider<
Object> ? -
The background image of the rounded square. Changing the background image will cause the avatar to animate to the
new image.
final
- child → Widget?
-
The widget below this widget in the tree.
final
- foregroundColor → Color?
-
The default text color for text in the rounded square.
final
-
foregroundImage
→ ImageProvider<
Object> ? -
The foreground image of the rounded square.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onBackgroundImageError → ImageErrorListener?
-
An optional error callback for errors emitted when loading backgroundImage.
final
- onForegroundImageError → ImageErrorListener?
-
An optional error callback for errors emitted when loading foregroundImage.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- size → double?
-
The size of the avatar.
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}) → 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