ChannelListView class

screenshot screenshot

It shows the list of current channels.

class ChannelListPage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: ChannelListView(
        filter: {
          'members': {
            '\$in': [StreamChat.of(context).user.id],
          }
        },
        sort: [SortOption('last_message_at')],
        pagination: PaginationParams(
          limit: 20,
        ),
        channelWidget: ChannelPage(),
      ),
    );
  }
}

Make sure to have a StreamChat ancestor in order to provide the information about the channels. The widget uses a ListView.custom to render the list of channels.

The widget components render the ui based on the first ancestor of type StreamChatTheme. Modify it to change the widget appearance.

Constructors

ChannelListView({Key key, Map<String, dynamic> filter, Map<String, dynamic> options, List<SortOption> sort, PaginationParams pagination, ChannelTapCallback onChannelTap, dynamic onChannelLongPress(Channel), Widget channelWidget, ChannelPreviewBuilder channelPreviewBuilder, dynamic separatorBuilder(BuildContext, int), Widget errorBuilder(Error error), WidgetBuilder emptyBuilder, dynamic onImageTap(Channel), WidgetBuilder loadingBuilder, bool pullToRefresh = true})
Instantiate a new ChannelListView

Properties

channelPreviewBuilder ChannelPreviewBuilder
Builder used to create a custom channel preview
final
channelWidget → Widget
Widget used when opening a channel
final
emptyBuilder → WidgetBuilder
The builder used when the channel list is empty.
final
errorBuilder → Widget Function(Error error)
The builder that will be used in case of error
final
filter → Map<String, dynamic>
The query filters to use. You can query on any of the custom fields you've defined on the Channel. You can also filter other built-in channel fields.
final
hashCode → int
The hash code for this object. [...]
@nonVirtual, read-only, inherited
key → Key
Controls how one widget replaces another widget in the tree. [...]
final, inherited
loadingBuilder → WidgetBuilder
The builder used while loading.
final
onChannelLongPress → dynamic Function(Channel)
Function called when long pressing on a channel
final
onChannelTap ChannelTapCallback
Function called when tapping on a channel By default it calls Navigator.push building a MaterialPageRoute with the widget channelWidget as child.
final
onImageTap → dynamic Function(Channel)
The function called when the image is tapped
final
options → Map<String, dynamic>
Query channels options. [...]
final
pagination PaginationParams
Pagination parameters limit: the number of channels to return (max is 30) offset: the offset (max is 1000) message_limit: how many messages should be included to each channel
final
pullToRefresh → bool
Set it to false to disable the pull-to-refresh widget
final
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
separatorBuilder → dynamic Function(BuildContext, int)
Builder used to create a custom item separator
final
sort → List<SortOption>
The sorting used for the channels matching the filters. Sorting is based on field and direction, multiple sorting options can be provided. You can sort based on last_updated, last_message_at, updated_at, created_at or member_count. Direction can be ascending or descending.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree. [...]
inherited
createState() → _ChannelListViewState
Creates the mutable state for this widget at a given location in the tree. [...]
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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
Returns 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. [...]
@nonVirtual, inherited