Chat class

A customizable chat widget that provides a complete chat interface.

This widget follows Clean Architecture principles by separating concerns:

The widget supports:

  • Message display with grouping
  • Custom message bubbles and input fields
  • Scroll behavior and new message notifications
  • Read-only mode

Example usage:

Chat(
  chatController: ChatController(),
  configuration: ChatConfiguration(
    senderAlignment: ChatAlignment.end,
  ),
  onScrollToTop: () async {
    // Load more messages
  },
)
Inheritance

Constructors

Chat({Key? key, bool readOnly = false, ChatController? chatController, ChatConfiguration configuration = const ChatConfiguration(), Future<void> onScrollToTop()?, Widget customInputField(BuildContext, ChatController)?})
Creates a new Chat widget.
const

Properties

chatController ChatController?
The controller that manages chat state and behavior.
final
configuration ChatConfiguration
Configuration object that defines the chat's appearance and behavior.
final
customInputField Widget Function(BuildContext, ChatController)?
Custom input field widget.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onScrollToTop Future<void> Function()?
Callback function called when the user scrolls to the top.
final
readOnly bool
Whether the chat is in read-only mode.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<Chat>
Creates the mutable state for this widget at a given location in the tree.
override
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, int wrapWidth = 65}) 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