StreamThreadHeader class

Shows information about the current message thread.

class ThreadPage extends StatelessWidget {
  final Message parent;

  ThreadPage({
    Key key,
    this.parent,
  }) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: ThreadHeader(
        parent: parent,
      ),
      body: Column(
        children: <Widget>[
          Expanded(
            child: MessageListView(
              parentMessage: parent,
            ),
          ),
          MessageInput(
            parentMessage: parent,
          ),
        ],
      ),
    );
  }
}

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

A StreamChannel ancestor is required 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. Alternatively, you can override the behavior with onBackPressed.

The UI is rendered based on the first ancestor of type StreamChatTheme and the ChannelTheme.channelHeaderTheme property. Modify it to change the widget's appearance.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• StreamThreadHeader

Implemented types

• PreferredSizeWidget

Constructors

StreamThreadHeader({Key? key, required Message parent, bool showBackButton = true, VoidCallback? onBackPressed, Widget? title, Widget? subtitle, bool? centerTitle, Widget? leading, List<Widget>? actions, VoidCallback? onTitleTap, bool showTypingIndicator = true, Color? backgroundColor, double elevation = 1})

const

Properties

actions → List<Widget>?

A list of Widgets to display in a row after the title widget.

final

backgroundColor → Color?

The background color of this StreamThreadHeader.

final

centerTitle → bool?

Whether the title should be centered

final

elevation → double

The elevation for this StreamThreadHeader.

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?

The action to perform when pressing the back button.

final

onTitleTap → VoidCallback?

The action to perform when the title is tapped.

final

parent → Message

The message parent of this thread

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

Whether to show the leading back button.

final

showTypingIndicator → bool

Whether to show the typing indicator if users are currently 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