ChannelHeader class

It shows the current Channel information.

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

  MyApp(this.client, this.channel);

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: StreamChat(
        client: client,
        child: StreamChannel(
          channel: channel,
          child: Scaffold(
            appBar: ChannelHeader(),
          ),
        ),
      ),
    );
  }
}

Usually you would use this widget as an AppBar inside a Scaffold. However you can also use it as a normal widget.

Make sure to have a StreamChannel ancestor in order to provide the information about the channel. Every part of the widget uses a StreamBuilder to render the channel information as soon as it updates.

By default the widget shows a backButton that calls Navigator.pop. You can disable this button using the showBackButton property of just override the behaviour with onBackPressed.

The widget components render the ui based on the first ancestor of type StreamChatTheme and on its ChannelTheme.channelHeaderTheme property. Modify it to change the widget appearance.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• ChannelHeader

Implemented types

• PreferredSizeWidget

Constructors

ChannelHeader({Key? key, bool showBackButton = true, VoidCallback? onBackPressed, VoidCallback? onTitleTap, bool showTypingIndicator = true, VoidCallback? onImageTap, bool showConnectionStateTile = false, Widget? title, Widget? subtitle, Widget? leading, List<Widget>? actions, Color? backgroundColor})

Creates a channel header

const

Properties

actions → List<Widget>?

AppBar actions By default it shows the ChannelAvatar

final

backgroundColor → Color?

The background color for this ChannelHeader.

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

leading → Widget?

Leading widget

final

onBackPressed → VoidCallback?

Callback to call when pressing the back button. By default it calls Navigator.pop

final

onImageTap → VoidCallback?

Callback to call when the image is tapped.

final

onTitleTap → VoidCallback?

Callback to call when the header is tapped.

final

preferredSize → Size

The size this widget would prefer if it were otherwise unconstrained.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

showBackButton → bool

True if this header shows the leading back button

final

showConnectionStateTile → bool

Show connection tile on header

final

showTypingIndicator → bool

If true the typing indicator will be rendered if a user is typing

final

subtitle → Widget?

Subtitle widget

final

title → Widget?

Title widget

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