ChannelPreview class
Shows a preview for the current Channel.
Uses a StreamBuilder to render the channel information image as soon as it updates.
It is not recommended to use this widget directly as it is the
default channel preview widget used by ChannelListView
.
The UI is rendered based on the first ancestor of type StreamChatTheme. Modify it to change the widget's appearance.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- ChannelPreview
Constructors
- ChannelPreview({required Channel channel, Key? key, void onTap(Channel)?, void onLongPress(Channel)?, ViewInfoCallback? onViewInfoTap, VoidCallback? onImageTap, Widget? title, Widget? subtitle, Widget? leading, Widget? sendingIndicator, Widget? trailing})
-
const
Properties
- channel → Channel
-
The Channel being previewed.
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
StreamChannelAvatar.
final
- onImageTap → VoidCallback?
-
The action to perform when the image is tapped
final
- onLongPress → (void Function(Channel)?)
-
The action to perform when this widget is long pressed.
final
- onTap → (void Function(Channel)?)
-
The action to perform when this widget is tapped or clicked.
final
- onViewInfoTap → ViewInfoCallback?
-
The action to perform when 'View Info' is tapped or clicked.
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
StreamSendingIndicator 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 date of
the last message.
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