StreamMessageInput class

The message composer.

Handles plain text, attachments picked from the file dialog or dropped or pasted onto the composer, quoted replies, editing an existing message, thread replies, and @ and / autocomplete.

The draft lives in a StreamMessageComposerController rather than in this component, so a message action elsewhere in the tree can populate it. See that class for why.

Constructors

StreamMessageInput({String? placeholder, bool sendTypingEvents = true, bool enableAttachments = true, bool enableAutocomplete = true, void onMessageSent(Message message)?, void onError(Object error)?, Key? key})
Creates a message composer.
const

Properties

enableAttachments → bool
Whether to offer the attachment button and accept drops and pastes.
final
enableAutocomplete → bool
Whether @ opens the mention popup and / the command popup.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one component replaces another component in the tree.
finalinherited
onError → void Function(Object error)?
Called when sending fails.
final
onMessageSent → void Function(Message message)?
Called after a message has been accepted by the API.
final
placeholder → String?
Placeholder shown while the field is empty. Defaults to a translated string that depends on whether this composer belongs to a thread.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sendTypingEvents → bool
Whether to emit typing.start and typing.stop events while composing.
final

Methods

createElement() → Element
Creates a StatefulElement to manage this component's location in the tree.
inherited
createState() → State<StreamMessageInput>
Creates the mutable state for this component at a given location in the tree.
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