CircleAvatar class
A circle 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 the avatar is to have an image, the image should be specified in the
backgroundImage property:
CircleAvatar(
backgroundImage: NetworkImage(userAvatarUrl),
)
The image will be cropped to have a circle shape.
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:
CircleAvatar(
backgroundColor: Colors.brown.shade800,
child: Text('AH'),
)
See also:
- Chip, for representing users or concepts in long form.
- ListTile, which can combine an icon (such as a CircleAvatar) with some text for a fixed height list entry.
- material.google.com/components/chips.html#chips-contact-chips
- Inheritance
- Object
- Diagnosticable
- DiagnosticableTree
- Widget
- StatelessWidget
- CircleAvatar
Constructors
- CircleAvatar({Key key, Widget child, Color backgroundColor, ImageProvider backgroundImage, Color foregroundColor, double radius, double minRadius, double maxRadius })
-
Creates a circle that represents a user.
const
Properties
- backgroundColor → Color
-
The color with which to fill the circle. Changing the background
color will cause the avatar to animate to the new color. [...]
final
- backgroundImage → ImageProvider
-
The background image of the circle. 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 circle. [...]
final
- maxRadius → double
-
The maximum size of the avatar, expressed as the radius (half the
diameter). [...]
final
- minRadius → double
-
The minimum size of the avatar, expressed as the radius (half the
diameter). [...]
final
- radius → double
-
The size of the avatar, expressed as the radius (half the diameter). [...]
final
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- key → Key
-
Controls how one widget replaces another widget in the tree. [...]
final, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
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. [...]
@protected, inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node. [...]
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent 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 toStringDeep. [...]
inherited
-
toString(
{DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String -
Returns 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 ==(
dynamic other) → bool -
The equality operator. [...]
inherited