ZetaAvatar class
An avatar is a visual representation of a user or entity.
It is recommended to use ZetaAvatar with ZetaAvatarBadge for status and notification badges, but any widget can be used.
Widgetbook: https://design.zebra.com/flutter/widgetbook/index.html#/?path=components/avatar/zetaavatar/avatar
- Inheritance
- Available extensions
Constructors
- ZetaAvatar({Key? key, ZetaAvatarSize size = ZetaAvatarSize.xl, Widget? image, String? initials, Color? backgroundColor, Widget? lowerBadge, Widget? upperBadge, Color? borderColor, String? semanticLabel, String? semanticUpperBadgeLabel, String? semanticLowerBadgeLabel, TextStyle? initialTextStyle, String? label, TextStyle? labelTextStyle, int labelMaxLines = 1, VoidCallback? onTap})
-
Constructor for ZetaAvatar
const
- ZetaAvatar.fromName({Key? key, required String name, ZetaAvatarSize size = ZetaAvatarSize.xl, Widget? lowerBadge, Widget? upperBadge, Color? borderColor, Color? backgroundColor, String? semanticLabel = 'avatar', String? semanticUpperBadgeLabel = 'upperBadge', String? semanticLowerBadgeLabel = 'lowerBadge', TextStyle? initialTextStyle, String? label, TextStyle? labelTextStyle, int labelMaxLines = 1, VoidCallback? onTap})
- Constructor for ZetaAvatar with initials from a full name.
- ZetaAvatar.image({Key? key, ZetaAvatarSize size = ZetaAvatarSize.xl, Widget? image, Widget? lowerBadge, Widget? upperBadge, Color? borderColor, String? semanticLabel = 'avatar', String? semanticUpperBadgeLabel = 'upperBadge', String? semanticLowerBadgeLabel = 'lowerBadge', String? label, TextStyle? labelTextStyle, int labelMaxLines = 1, VoidCallback? onTap})
-
Constructor for ZetaAvatar with image.
const
- ZetaAvatar.initials({Key? key, required String? initials, ZetaAvatarSize size = ZetaAvatarSize.xl, Widget? lowerBadge, Widget? upperBadge, Color? borderColor, Color? backgroundColor, String? semanticLabel = 'avatar', String? semanticUpperBadgeLabel = 'upperBadge', String? semanticLowerBadgeLabel = 'lowerBadge', TextStyle? initialTextStyle, String? label, TextStyle? labelTextStyle, int labelMaxLines = 1, VoidCallback? onTap})
-
Constructor for ZetaAvatar with initials.
const
Properties
- backgroundColor → Color?
-
Background color.
final
- borderColor → Color?
-
Shows border around the avatar
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- image → Widget?
-
Image to display for avatar.
final
- initials → String?
-
String to display initials.
final
- initialTextStyle → TextStyle?
-
Text style for initials.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- label → String?
-
Label to display below the avatar.
final
- labelMaxLines → int
-
Maximum number of lines for label.
final
- labelTextStyle → TextStyle?
-
Text style for label.
final
- lowerBadge → Widget?
-
Status badge shown at lower right corner of avatar.
final
- onTap → VoidCallback?
-
Callback when avatar is tapped.
final
- rounded → bool?
-
Sets rounded or sharp border of the containing box and the icon style.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- semanticLabel → String?
-
Value passed into wrapping Semantics widget.
final
- semanticLowerBadgeLabel → String?
-
Value passed into wrapping Semantics widget for lower badge.
final
- semanticUpperBadgeLabel → String?
-
Value passed into wrapping Semantics widget for upper badge.
final
- size → ZetaAvatarSize
-
The size of the ZetaAvatar
final
- upperBadge → Widget?
-
Notification Badge shown at top right corner of avatar.
final
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
copyWith(
{ZetaAvatarSize? size, Widget? image, String? initials, Color? backgroundColor, Color? borderColor, Widget? lowerBadge, Widget? upperBadge, String? label, TextStyle? labelTextStyle, int? labelMaxLines, VoidCallback? onTap, Key? key}) → ZetaAvatar - Return copy of avatar with certain changed fields
-
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.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
paddingAll(
double space) → Widget -
Available on Widget, provided by the SpacingWidget extension
Equal padding on all sides. -
paddingBottom(
double space) → Widget -
Available on Widget, provided by the SpacingWidget extension
Padding on bottom only. -
paddingEnd(
double space) → Widget -
Available on Widget, provided by the SpacingWidget extension
Padding on start edge only. Is affected by whether the device is LTR or RTL: -
paddingHorizontal(
double space) → Widget -
Available on Widget, provided by the SpacingWidget extension
Equal padding on start and end. -
paddingStart(
double space) → Widget -
Available on Widget, provided by the SpacingWidget extension
Padding on start edge only. Is affected by whether the device is LTR or RTL: -
paddingTop(
double space) → Widget -
Available on Widget, provided by the SpacingWidget extension
Padding on top only. -
paddingVertical(
double space) → Widget -
Available on Widget, provided by the SpacingWidget extension
Equal padding on top and bottom. -
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
-
fontSize(
BuildContext context, ZetaAvatarSize size) → double - Font size for initials
-
pixelSize(
BuildContext context, ZetaAvatarSize size) → double - Returns pixel size for ZetaAvatarSize