AvatarWidget class

Widget to build an Avatar.

Displays a colored BoxDecoration with initials based on a title if avatar is not specified.

Inheritance
Available extensions

Constructors

AvatarWidget({Key? key, Avatar? avatar, AvatarRadius? radius, String? title, int? color, double opacity = 1, bool isOnline = false, bool isAway = false, Widget? label, FutureOr<void> onForbidden()?, BoxShape shape = BoxShape.circle, Widget? child})
const
AvatarWidget.fromChat(Chat? chat, String? title, Avatar? avatar, UserId? me, {Key? key, AvatarRadius? radius, double opacity = 1})
Creates an AvatarWidget from the specified Chat and its parameters.
factory
AvatarWidget.fromContact(ChatContact? contact, {Key? key, Avatar? avatar, AvatarRadius? radius, double opacity = 1})
Creates an AvatarWidget from the specified contact.
factory
AvatarWidget.fromMonolog(Chat? chat, UserId? me, {Key? key, AvatarRadius? radius, double opacity = 1, BoxShape shape = BoxShape.circle})
Creates an AvatarWidget from the specified chat-monolog.
factory
AvatarWidget.fromMyUser(MyUser? myUser, {Key? key, AvatarRadius? radius, double opacity = 1, bool badge = true, FutureOr<void> onForbidden()?, BoxShape shape = BoxShape.circle})
Creates an AvatarWidget from the specified MyUser.
factory
AvatarWidget.fromUser(User? user, {Key? key, AvatarRadius? radius, double opacity = 1, BoxShape shape = BoxShape.circle})
Creates an AvatarWidget from the specified user.
factory

Properties

avatar Avatar?
Avatar to display.
final
child Widget?
Widget to display inside this AvatarWidget.
final
color int?
Integer that determining the gradient color of the avatar.
final
hashCode int
The hash code for this object.
no setterinherited
isAway bool
Indicator whether to display an away Badge in the bottom-right corner of this AvatarWidget.
final
isOnline bool
Indicator whether to display an online Badge in the bottom-right corner of this AvatarWidget.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
label Widget?
Optional label to show inside this AvatarWidget.
final
marginZero Widget

Available on Widget, provided by the WidgetMarginX extension

no setter
onForbidden FutureOr<void> Function()?
Callback, called when avatar fetching fails with Forbidden error.
final
opacity double
Opacity of this AvatarWidget.
final
paddingZero Widget

Available on Widget, provided by the WidgetPaddingX extension

no setter
radius AvatarRadius?
AvatarRadius to display avatar with.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
shape BoxShape
BoxShape of this AvatarWidget.
final
sliverBox Widget

Available on Widget, provided by the WidgetSliverBoxX extension

no setter
title String?
Optional title of an avatar to display.
final

Methods

animate({Key? key, List<Effect>? effects, AnimateCallback? onInit, AnimateCallback? onPlay, AnimateCallback? onComplete, bool? autoPlay, Duration? delay, AnimationController? controller, Adapter? adapter, double? target, double? value}) Animate

Available on Widget, provided by the AnimateWidgetExtensions extension

Wraps the target Widget in an Animate instance, and returns the instance for chaining calls. Ex. myWidget.animate() is equivalent to Animate(child: myWidget).
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
marginAll(double margin) Widget

Available on Widget, provided by the WidgetMarginX extension

marginOnly({double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0}) Widget

Available on Widget, provided by the WidgetMarginX extension

marginSymmetric({double horizontal = 0.0, double vertical = 0.0}) Widget

Available on Widget, provided by the WidgetMarginX extension

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
paddingAll(double padding) Widget

Available on Widget, provided by the WidgetPaddingX extension

paddingOnly({double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0}) Widget

Available on Widget, provided by the WidgetPaddingX extension

paddingSymmetric({double horizontal = 0.0, double vertical = 0.0}) Widget

Available on Widget, provided by the WidgetPaddingX extension

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

Static Methods

fromRxChat(RxChat? chat, {Key? key, AvatarRadius? radius, double opacity = 1, FutureOr<void> onForbidden()?, BoxShape shape = BoxShape.circle}) Widget
Creates an AvatarWidget from the specified RxChat.
fromRxContact(RxChatContact? contact, {Key? key, Avatar? avatar, AvatarRadius? radius, double opacity = 1, bool badge = true}) Widget
Creates an AvatarWidget from the specified reactive contact.
fromRxUser(RxUser? user, {Key? key, AvatarRadius? radius, double opacity = 1, bool badge = true, BoxShape shape = BoxShape.circle}) Widget
Creates an AvatarWidget from the specified reactive user.