MessageComposerConfiguration class

MessageComposerConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatMessageComposer can be used by a component where CometChatMessageComposer is a child component

MessageComposerConfiguration(
     messageComposerStyle: MessageComposerStyle(),
     sendButtonView: Container(),
     auxiliaryButtonView:({group, user}) => Container()
   )

Constructors

MessageComposerConfiguration({ComposerWidgetBuilder? auxiliaryButtonView, ComposerWidgetBuilder? headerView, ComposerWidgetBuilder? footerView, ComposerWidgetBuilder? secondaryButtonView, Widget? sendButtonView, ComposerActionsBuilder? attachmentOptions, String? text, dynamic onChange(String)?, int? maxLine, AuxiliaryButtonsAlignment? auxiliaryButtonsAlignment, String? placeholderText, MessageComposerStyle? messageComposerStyle, bool? hideLiveReaction, void stateCallBack(CometChatMessageComposerController)?, OnError? onError, String? attachmentIconURL, dynamic onSendButtonTap(BuildContext, BaseMessage, PreviewMessageMode?)?, CometChatTheme? theme, bool disableSoundForMessages = false, String? customSoundForMessage, String? liveReactionIconURL, String? customSoundForMessagePackage, Widget? attachmentIcon, Widget? liveReactionIcon, Widget? recordIcon, Widget? playIcon, Widget? deleteIcon, Widget? stopIcon, Widget? submitIcon, Widget? pauseIcon, bool? disableTypingEvents, MediaRecorderStyle? mediaRecorderStyle, bool? hideVoiceRecording, Widget? voiceRecordingIcon, AIOptionsStyle? aiOptionStyle, String? aiIconPackageName, Widget? aiIcon, String? aiIconURL, List<CometChatTextFormatter>? textFormatters, bool? disableMentions, TextEditingController? textEditingController})
const

Properties

aiIcon → Widget?
attachmentIcon custom ai icon
final
aiIconPackageName → String?
aiIconPackageName package name to show icon from
final
aiIconURL → String?
aiIconURL path of the icon to show in the ai button
final
aiOptionStyle → AIOptionsStyle?
aiOptionStyle sets the ai option sheet style for
final
attachmentIcon → Widget?
attachmentIcon custom attachment icon
final
attachmentIconURL → String?
attachmentIconURL path of the icon to show in the attachments button
final
attachmentOptions → ComposerActionsBuilder?
attachmentOptions options to display on tapping attachment button
final
auxiliaryButtonsAlignment → AuxiliaryButtonsAlignment?
auxiliaryButtonsAlignment controls position auxiliary button view
final
auxiliaryButtonView → ComposerWidgetBuilder?
auxiliaryButtonView ui component to be forwarded to message input component
final
customSoundForMessage → String?
customSoundForMessage custom outgoing message sound assets url
final
customSoundForMessagePackage → String?
if sending sound url from other package pass package name here
final
deleteIcon → Widget?
deleteIcon provides icon to the close Icon/widget
final
disableMentions → bool?
disableMentions disables mentions in the composer
final
disableSoundForMessages → bool
disableSoundForMessages if true then disables outgoing message sound
final
disableTypingEvents → bool?
disableTypingEvents if true then disables is typing indicator
final
footerView → ComposerWidgetBuilder?
footerView ui component to be forwarded to message input component
final
hashCode → int
The hash code for this object.
no setterinherited
headerView → ComposerWidgetBuilder?
headerView ui component to be forwarded to message input component
final
hideLiveReaction → bool?
hideLiveReaction if true hides live reaction option
final
hideVoiceRecording → bool?
hideVoiceRecording provides option to hide voice recording
final
liveReactionIcon → Widget?
liveReactionIcon custom live reaction icon
final
liveReactionIconURL → String?
liveReactionIconURL is the path of the icon to show in the live reaction button
final
maxLine → int?
maxLine maximum lines allowed to increase in the input field
final
mediaRecorderStyle → MediaRecorderStyle?
mediaRecorderStyle provides style to the media recorder
final
messageComposerStyle → MessageComposerStyle?
messageComposerStyle message composer style
final
onChange → dynamic Function(String)?
onChange callback to handle change in value of text in the input field
final
onError → OnError?
onError callback triggered in case any error happens when fetching users
final
onSendButtonTap → dynamic Function(BuildContext, BaseMessage, PreviewMessageMode?)?
onSendButtonTap some task to execute if user presses the primary/send button
final
pauseIcon → Widget?
pauseIcon provides icon to the play Icon/widget
final
placeholderText → String?
placeholderText hint text for input field
final
playIcon → Widget?
playIcon provides icon to the play Icon/widget
final
recordIcon → Widget?
recordIcon provides icon to the start Icon/widget
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secondaryButtonView → ComposerWidgetBuilder?
secondaryButtonView ui component to be forwarded to message input component
final
sendButtonView → Widget?
sendButtonView ui component to be forwarded to message input component
final
stateCallBack → void Function(CometChatMessageComposerController)?
stateCallBack
final
stopIcon → Widget?
stopIcon provides icon to the stop Icon/widget
final
submitIcon → Widget?
submitIcon provides icon to the submit Icon/widget
final
text → String?
text initial text for the input field
final
textEditingController → TextEditingController?
textEditingController controls the state of the text field
final
textFormatters → List<CometChatTextFormatter>?
textFormatters is a list of CometChatTextFormatter which is used to format the text
final
theme → CometChatTheme?
theme sets the theme for this component
final
voiceRecordingIcon → Widget?
voiceRecordingIcon provides icon to the voice recording Icon/widget
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited