StreamChannelListHeader class

Shows the current StreamChatClient status.

class MyApp extends StatelessWidget {
  final StreamChatClient client;

  MyApp(this.client);

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

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

Uses the inherited StreamChatClient, by default, to fetch information about the status of the client. You can also pass your own StreamChatClient if you don't have it in the widget tree.

Renders the UI based on the first ancestor of type StreamChatTheme and the StreamChannelListHeaderThemeData property. Modify it to change the widget's appearance.

Inheritance
Implemented types

Constructors

StreamChannelListHeader({Key? key, StreamChatClient? client, ChannelListHeaderTitleBuilder? titleBuilder, dynamic onUserAvatarTap(User)?, VoidCallback? onNewChatButtonTap, bool showConnectionStateTile = false, VoidCallback? preNavigationCallback, Widget? subtitle, bool? centerTitle, Widget? leading, List<Widget>? actions, Color? backgroundColor, double elevation = 1})
Shows the current StreamChatClient status.
const

Properties

actions → List<Widget>?
A list of Widgets to display in a row after the title widget.
final
backgroundColor → Color?
The background color for this StreamChannelListHeader.
final
centerTitle → bool?
Whether the title should be centered
final
client → StreamChatClient?
Use this if you don't have a StreamChatClient in your widget tree.
final
elevation → double
The elevation for this StreamChannelListHeader.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
leading → Widget?
Leading widget
final
onNewChatButtonTap → VoidCallback?
The action to perform when pressing the "new chat" button.
final
onUserAvatarTap → (dynamic Function(User)?)
The action to perform when pressing the user avatar button.
final
preferredSize → Size
The size this widget would prefer if it were otherwise unconstrained.
no setteroverride
preNavigationCallback → VoidCallback?
The function to execute before navigation is performed
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showConnectionStateTile → bool
Whether to show the connection state tile
final
subtitle → Widget?
Subtitle widget
final
titleBuilder → ChannelListHeaderTitleBuilder?
A widget builder for custom ChannelListHeader title widgets.
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