TextAvatar class

A widget to display a text avatar with a background color.

The TextAvatar widget is used to display a circular avatar with a text inside it. It automatically generates the background color based on the first letter of the provided text.

Inheritance
Available extensions

Constructors

TextAvatar.new({Key? key, required String text, Color? backgroundColor, double radius = 10, double size = 48.0, TextStyle? style, Map<String, Color>? includeColor, bool upperCase = true})
Creates a TextAvatar widget with the given parameters.

Properties

backgroundColor ↔ Color?
The background color of the circular avatar.
getter/setter pair
colors → Map<String, Color>
no setter
hashCode → int
The hash code for this object.
no setterinherited
includeColor → Map<String, Color>?
A map of letters to custom background colors for the avatars.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
radius ↔ double
The radius of the circular avatar.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
size ↔ double
The size of the circular avatar.
getter/setter pair
style → TextStyle?
The text style of the text inside the avatar.
final
text → String
The text to display inside the avatar.
final
upperCase → bool
Whether to show the text in uppercase (default) or lowercase.
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
center({double? heightFactor, double? widthFactor}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Centers the widget within a Center widget.
cornerRadiusWithClipRRect(double radius) → ClipRRect

Available on Widget?, provided by the WidgetExtension extension

Adds a uniform corner radius to the widget using ClipRRect.
cornerRadiusWithClipRRectOnly({int bottomLeft = 0, int bottomRight = 0, int topLeft = 0, int topRight = 0}) → ClipRRect

Available on Widget?, provided by the WidgetExtension extension

Adds rounded corners to the widget using ClipRRect with custom radii.
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
expand({dynamic flex = 1}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Wraps the widget with Expanded.
fit({BoxFit? fit, AlignmentGeometry? alignment}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Wraps the widget with FittedBox.
flexible({dynamic flex = 1, FlexFit? fit}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Wraps the widget with Flexible.
getLetters() → String
makeRefreshable() → Widget

Available on Widget?, provided by the WidgetExtension extension

Wraps the widget with a RefreshIndicator to make it refreshable. This assumes that the widget is inside a Stack with a ListView.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onTap(Function? function, {BorderRadius? borderRadius, Color? splashColor, Color? hoverColor, Color? highlightColor}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Wraps the widget with an InkWell for tap functionality.
opacity({required double opacity, int durationInSecond = 1, Duration? duration}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Adds animated opacity to the widget.
paddingAll(double padding) → Padding

Available on Widget, provided by the PaddingWidgetExtension extension

return padding all
paddingBottom(double bottom) → Padding

Available on Widget, provided by the PaddingWidgetExtension extension

return padding bottom
paddingLeft(double left) → Padding

Available on Widget, provided by the PaddingWidgetExtension extension

return padding left
paddingOnly({double top = 0.0, double left = 0.0, double bottom = 0.0, double right = 0.0}) → Padding

Available on Widget, provided by the PaddingWidgetExtension extension

return custom padding from each side
paddingRight(double right) → Padding

Available on Widget, provided by the PaddingWidgetExtension extension

return padding right
paddingSymmetric({double vertical = 0.0, double horizontal = 0.0}) → Padding

Available on Widget, provided by the PaddingWidgetExtension extension

return padding symmetric
paddingTop(double top) → Padding

Available on Widget, provided by the PaddingWidgetExtension extension

return padding top
rotate({required double angle, bool transformHitTests = true, Offset? origin}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Rotates the widget using Transform.rotate.
scale({required double scale, Offset? origin, AlignmentGeometry? alignment, bool transformHitTests = true}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Scales the widget using Transform.scale.
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
translate({required Offset offset, bool transformHitTests = true, Key? key}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Translates (moves) the widget using Transform.translate.
validate({Widget value = const SizedBox()}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Returns the widget if it is not null, otherwise returns a default value.
visible(bool visible, {Widget? defaultWidget}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Controls the visibility of the widget.
withHeight(double height) → SizedBox

Available on Widget?, provided by the WidgetExtension extension

Wraps the widget inside a SizedBox with a custom height.
withShaderMask(List<Color> colors, {BlendMode blendMode = BlendMode.srcATop}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Wraps the widget with a ShaderMask using a list of colors.
withShaderMaskGradient(Gradient gradient, {BlendMode blendMode = BlendMode.srcATop}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Wraps the widget with a ShaderMask using a custom Gradient.
withSize({double width = 0.0, double height = 0.0}) → SizedBox

Available on Widget?, provided by the WidgetExtension extension

Wraps the widget inside a SizedBox with a custom height and width.
withTooltip({required String msg}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Wraps the widget with a Tooltip.
withWidth(double width) → SizedBox

Available on Widget?, provided by the WidgetExtension extension

Wraps the widget inside a SizedBox with a custom width.

Operators

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