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:
new CircleAvatar(
backgroundImage: new 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:
new CircleAvatar(
backgroundColor: Colors.brown[800],
child: new Text('AH'),
);
See also:
- Chip, for representing users or concepts in long form.
- ListItem, which combines an icon (such as a CircleAvatar) with some text in a horizontal row.
- material.google.com/components/chips.html#chips-contact-chips
- Inheritance
- Object
- Widget
- StatelessWidget
- CircleAvatar
Constructors
- CircleAvatar({Key key, Widget child, Color backgroundColor, ImageProvider backgroundImage, double radius: 20.0 })
-
Creates a circle that represents a user.
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.
read-only - backgroundImage → ImageProvider
-
The background image of the circle. Changing the background image will cause the avatar to animate to the new image.
read-only - child → Widget
-
The widget below this widget in the tree.
read-only - radius → double
-
The size of the avatar. Changing the radius will cause the avatar to animate to the new size.
read-only - hashCode → int
-
Get a hash code for this object.
read-only, inherited - key → Key
-
Controls how one widget replaces another widget in the tree.
read-only, inherited - runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Operators
-
operator ==(
other) → bool -
The equality operator.
inherited
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
-
createElement(
) → StatelessElement -
Creates a StatelessElement to manage this widget's location in the tree.
inherited -
debugFillDescription(
List<String> description) → void -
Add additional information to the given description for use by toString.
inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited -
toString(
) → String -
Returns a string representation of this object.
inherited -
toStringShort(
) → String -
A short, textual description of this widget.
inherited