ChatsList<T extends ChatBase> class
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- ChatsList
Constructors
-
ChatsList({Key? key, required ChatsListController<
ChatBase> controller, required String appUserId, bool areItemsTheSame(T oldItem, T newItem)?, ChatsListStyle? chatsListStyle, GroupAvatarStyle? groupAvatarStyle, bool unreadBubbleEnabled = true, required ChatsListTileBuilders<ChatBase> builders, dynamic scrollHandler(ScrollNotification scroll)?})
Properties
- appUserId → String
-
The id of the app's current user
required to determine whether a message is owned
final
- areItemsTheSame → (bool Function(T oldItem, T newItem)?)
-
Called by the DiffUtil to decide whether two object represent the same Item.
By default, this will check whether oldItem.getId() == newItem.getId();
final
-
builders
→ ChatsListTileBuilders<
ChatBase> -
Replace any component you are unsatisfied with with a custom Widget, build using
these builders
final
- chatsListStyle → ChatsListStyle?
-
Styling and settings for ChatsList.
final
-
controller
→ ChatsListController<
ChatBase> -
The controller that manages items and actions
final
- groupAvatarStyle → GroupAvatarStyle?
-
Styling configuration for the default GroupAvatar used in
_buildLeading
final - hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollHandler → (dynamic Function(ScrollNotification scroll)?)
-
Scrolling will trigger NotificationListener, which will call this handler;
Typically looks like this:
void _handleScrollEvent(ScrollNotification scroll) {
if (scroll.metrics.pixels == scroll.metrics.maxScrollExtent)
_getMoreChats();
}
final
- unreadBubbleEnabled → bool
-
Set to true if you want to display a bubble above the group avatar
which shows the number of unread messages
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _ChatsListState< ChatBase> -
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}) → 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