StreamChannelGridView class

A GridView that shows a grid of Users, it uses StreamChannelGridTile as a default item.

Example:

StreamChannelGridView(
  controller: controller,
  onChannelTap: (channel) {
    // Handle channel tap event
  },
  onChannelLongPress: (channel) {
    // Handle channel long press event
  },
)

See also:

Inheritance

Constructors

StreamChannelGridView({Key? key, required StreamChannelListController controller, SliverGridDelegate gridDelegate = defaultChannelGridViewDelegate, StreamChannelGridViewIndexedWidgetBuilder? itemBuilder, WidgetBuilder? emptyBuilder, PagedValueScrollViewLoadMoreErrorBuilder? loadMoreErrorBuilder, WidgetBuilder? loadMoreIndicatorBuilder, WidgetBuilder? loadingBuilder, Widget errorBuilder(BuildContext, StreamChatError)?, void onChannelTap(Channel)?, void onChannelLongPress(Channel)?, int loadMoreTriggerIndex = 3, Axis scrollDirection = Axis.vertical, bool reverse = false, ScrollController? scrollController, bool? primary, ScrollPhysics? physics, bool shrinkWrap = false, EdgeInsetsGeometry? padding, bool addAutomaticKeepAlives = true, bool addRepaintBoundaries = true, bool addSemanticIndexes = true, double? cacheExtent, int? semanticChildCount, DragStartBehavior dragStartBehavior = DragStartBehavior.start, ScrollViewKeyboardDismissBehavior keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual, String? restorationId, Clip clipBehavior = Clip.hardEdge})
Creates a new instance of StreamChannelGridView.
const

Properties

addAutomaticKeepAlives → bool
Whether to wrap each child in an AutomaticKeepAlive.
final
addRepaintBoundaries → bool
Whether to wrap each child in a RepaintBoundary.
final
addSemanticIndexes → bool
Whether to wrap each child in an IndexedSemantics.
final
cacheExtent → double?
The viewport has an area before and after the visible area to cache items that are about to become visible when the user scrolls.
final
clipBehavior → Clip
The content will be clipped (or not) according to this option.
final
controller → StreamChannelListController
The StreamUserListController used to control the grid of users.
final
dragStartBehavior → DragStartBehavior
Determines the way that drag start behavior is handled.
final
emptyBuilder → WidgetBuilder?
A builder that is called to build the empty state of the grid.
final
errorBuilder → Widget Function(BuildContext, StreamChatError)?
A builder that is called to build the error state of the grid.
final
gridDelegate → SliverGridDelegate
A delegate that controls the layout of the children within the PagedValueGridView.
final
hashCode → int
The hash code for this object.
no setterinherited
itemBuilder → StreamChannelGridViewIndexedWidgetBuilder?
A builder that is called to build items in the PagedValueGridView.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
keyboardDismissBehavior → ScrollViewKeyboardDismissBehavior
ScrollViewKeyboardDismissBehavior the defines how this ScrollView will dismiss the keyboard automatically.
final
loadingBuilder → WidgetBuilder?
A builder that is called to build the loading state of the grid.
final
loadMoreErrorBuilder → PagedValueScrollViewLoadMoreErrorBuilder?
A builder that is called to build the load more error state of the grid.
final
loadMoreIndicatorBuilder → WidgetBuilder?
A builder that is called to build the load more indicator of the grid.
final
loadMoreTriggerIndex → int
The index to take into account when triggering controller.loadMore.
final
onChannelLongPress → void Function(Channel)?
Called when the user long-presses on this grid tile.
final
onChannelTap → void Function(Channel)?
Called when the user taps this grid tile.
final
padding → EdgeInsetsGeometry?
The amount of space by which to inset the children.
final
physics → ScrollPhysics?
How the scroll view should respond to user input.
final
primary → bool?
Whether this is the primary scroll view associated with the parent PrimaryScrollController.
final
restorationId → String?
Restoration ID to save and restore the scroll offset of the scrollable.
final
reverse → bool
Whether the scroll view scrolls in the reading direction.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollController → ScrollController?
An object that can be used to control the position to which this scroll view is scrolled.
final
scrollDirection → Axis
The Axis along which the scroll view's offset increases.
final
semanticChildCount → int?
The number of children that will contribute semantic information.
final
shrinkWrap → bool
Whether the extent of the scroll view in the scrollDirection should be determined by the contents being viewed.
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