StreamChannelAvatar class

It shows the current Channel image.

class MyApp extends StatelessWidget {
  final StreamChatClient client;
  final Channel channel;

  MyApp(this.client, this.channel);

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      home: StreamChat(
        client: client,
        child: StreamChannel(
          channel: channel,
          child: Center(
            child: StreamChannelAvatar(
              channel: channel,
            ),
          ),
        ),
      ),
    );
  }
}

The widget uses a StreamBuilder to render the channel information image as soon as it updates.

By default the widget radius size is 40x40 pixels. Set the property constraints to set a custom dimension.

The widget renders the ui based on the first ancestor of type StreamChatTheme. Modify it to change the widget appearance.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• StreamChannelAvatar

Constructors

StreamChannelAvatar({Key? key, required Channel channel, BoxConstraints? constraints, VoidCallback? onTap, BorderRadius? borderRadius, bool selected = false, Color? selectionColor, double selectionThickness = 4, StreamUserAvatarBuilder? ownSpaceAvatarBuilder, StreamUserAvatarBuilder? oneToOneAvatarBuilder, StreamGroupAvatarBuilder? groupAvatarBuilder})

Instantiate a new ChannelImage

Properties

borderRadius → BorderRadius?

BorderRadius to display the widget

final

channel → Channel

The channel to show the image of

final

constraints → BoxConstraints?

The diameter of the image

final

groupAvatarBuilder → StreamGroupAvatarBuilder?

Builder to create avatar for group channel.

final

hashCode → int

The hash code for this object.

no setter, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

oneToOneAvatarBuilder → StreamUserAvatarBuilder?

Builder to create avatar for one to one channel.

final

onTap → VoidCallback?

The function called when the image is tapped

final

ownSpaceAvatarBuilder → StreamUserAvatarBuilder?

Builder to create avatar for own space channel.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selected → bool

If image is selected

final

selectionColor → Color?

Selection color for image

final

selectionThickness → double

Thickness of selection image

final

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.

inherited

debugFillProperties(DiagnosticPropertiesBuilder properties) → void

Add additional properties associated with the node.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent 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 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}) → 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