ZIMKitMessageListPage class

Inheritance

Constructors

ZIMKitMessageListPage({Key? key, required String conversationID, ZIMConversationType conversationType = ZIMConversationType.peer, AppBar? appBarBuilder(BuildContext context, AppBar defaultAppBar)?, List<Widget>? appBarActions, List<ZIMKitMessageInputAction>? messageInputActions, void onMessageSent(ZIMKitMessage)?, ZIMKitMessageListPageEvents? events, FutureOr<ZIMKitMessage> preMessageSending(ZIMKitMessage)?, double? messageInputHeight, InputDecoration? inputDecoration, bool showPickFileButton = true, bool showPickMediaButton = true, bool showMoreButton = true, bool showRecordButton = true, TextEditingController? editingController, ScrollController? messageListScrollController, void onMessageItemPressed(BuildContext context, ZIMKitMessage message, Function defaultAction)?, void onMessageItemLongPress(BuildContext context, LongPressStartDetails details, ZIMKitMessage message, Function defaultAction)?, Widget messageItemBuilder(BuildContext context, ZIMKitMessage message, Widget defaultWidget)?, Widget messageContentBuilder(BuildContext context, ZIMKitMessage message, Widget defaultWidget)?, Widget messageListErrorBuilder(BuildContext context, Widget defaultWidget)?, Widget messageListLoadingBuilder(BuildContext context, Widget defaultWidget)?, Widget messageListBackgroundBuilder(BuildContext context, Widget defaultWidget)?, ThemeData? theme, void onMediaFilesPicked(BuildContext context, List<PlatformFile> files, Function defaultAction)?, Widget? sendButtonWidget, Widget? pickMediaButtonWidget, Widget? pickFileButtonWidget, FocusNode? inputFocusNode, BoxDecoration? inputBackgroundDecoration, EdgeInsetsGeometry? messageInputContainerPadding, Decoration? messageInputContainerDecoration, TextInputType? messageInputKeyboardType, int? messageInputMaxLines, int? messageInputMinLines, TextInputAction? messageInputTextInputAction, TextCapitalization? messageInputTextCapitalization})
const

Properties

appBarActions List<Widget>?
if you just want add some actions to the appBar, use appBarActions.
final
appBarBuilder → (AppBar? Function(BuildContext context, AppBar defaultAppBar)?)
final
conversationID String
this page's conversationID
final
conversationType ZIMConversationType
this page's conversationType
final
editingController TextEditingController?
The TextEditingController to use. if not provided, a default one will be created.
final
events ZIMKitMessageListPageEvents?
events.
final
hashCode int
The hash code for this object.
no setterinherited
inputBackgroundDecoration BoxDecoration?
final
inputDecoration InputDecoration?
The TextField's decoration.
final
inputFocusNode FocusNode?
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
messageContentBuilder → (Widget Function(BuildContext context, ZIMKitMessage message, Widget defaultWidget)?)
final
messageInputActions List<ZIMKitMessageInputAction>?
To add your own action, use the messageInputActions parameter like this:
final
messageInputContainerDecoration Decoration?
The default config is
final
messageInputContainerPadding EdgeInsetsGeometry?
The default config is
final
messageInputHeight double?
final
messageInputKeyboardType TextInputType?
default is TextInputType.multiline
final
messageInputMaxLines int?
final
messageInputMinLines int?
final
messageInputTextCapitalization TextCapitalization?
final
messageInputTextInputAction TextInputAction?
final
messageItemBuilder → (Widget Function(BuildContext context, ZIMKitMessage message, Widget defaultWidget)?)
final
messageListBackgroundBuilder → (Widget Function(BuildContext context, Widget defaultWidget)?)
final
messageListErrorBuilder → (Widget Function(BuildContext context, Widget defaultWidget)?)
final
messageListLoadingBuilder → (Widget Function(BuildContext context, Widget defaultWidget)?)
final
messageListScrollController ScrollController?
The ScrollController to use. if not provided, a default one will be created.
final
onMediaFilesPicked → (void Function(BuildContext context, List<PlatformFile> files, Function defaultAction)?)
final
onMessageItemLongPress → (void Function(BuildContext context, LongPressStartDetails details, ZIMKitMessage message, Function defaultAction)?)
final
onMessageItemPressed → (void Function(BuildContext context, ZIMKitMessage message, Function defaultAction)?)
final
onMessageSent → (void Function(ZIMKitMessage)?)
Called when a message is sent.
final
pickFileButtonWidget Widget?
final
pickMediaButtonWidget Widget?
final
preMessageSending → (FutureOr<ZIMKitMessage> Function(ZIMKitMessage)?)
Called before a message is sent.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
sendButtonWidget Widget?
final
showMoreButton bool
By default, ZIMKitMessageInput will show a button to pop more. If you don't want to show this button, set showMoreButton to false.
final
showPickFileButton bool
By default, ZIMKitMessageInput will show a button to pick file. If you don't want to show this button, set showPickFileButton to false.
final
showPickMediaButton bool
By default, ZIMKitMessageInput will show a button to pick media. If you don't want to show this button, set showPickMediaButton to false.
final
showRecordButton bool
By default, ZIMKitMessageInput will show a button to record. If you don't want to show this button, set showRecordButton to false.
final
theme ThemeData?
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<ZIMKitMessageListPage>
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