ChannelPreview class
It shows the current Channel preview.
The widget uses a StreamBuilder to render the channel information image as soon as it updates.
Usually you don't use this widget as it's the default channel preview used by ChannelListView.
The widget renders the ui based on the first ancestor of type StreamChatTheme. Modify it to change the widget appearance.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- ChannelPreview
Constructors
- ChannelPreview({required Channel channel, Key? key, void onTap(Channel)?, void onLongPress(Channel)?, VoidCallback? onImageTap, Widget? title, Widget? subtitle, Widget? leading, Widget? sendingIndicator, Widget? trailing})
-
Constructor for creating ChannelPreview
const
Properties
- channel → Channel
-
Channel displayed
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- leading → Widget?
-
Widget rendering the leading element, by default
it shows the ChannelAvatar
final
- onImageTap → VoidCallback?
-
The function called when the image is tapped
final
- onLongPress → (void Function(Channel)?)
-
Function called when long pressing this widget
final
- onTap → (void Function(Channel)?)
-
Function called when tapping this widget
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sendingIndicator → Widget?
-
Widget rendering the sending indicator,
by default it uses the SendingIndicator widget
final
- subtitle → Widget?
-
Widget rendering the subtitle
final
- title → Widget?
-
Widget rendering the title
final
- trailing → Widget?
-
Widget rendering the trailing element,
by default it shows the last message date
final
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
createElement(
) → StatelessElement -
Creates a StatelessElement to manage this widget's location in the tree.
inherited
-
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