GroupsConfiguration class

GroupsConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatGroups can be used by a component where CometChatGroups is a child component

GroupsConfiguration(
       groupsStyle: GroupsStyle(),
       avatarStyle: AvatarStyle(),
       listItemStyle: ListItemStyle(),
       statusIndicatorStyle: StatusIndicatorStyle(),
     );

Constructors

GroupsConfiguration({String? title, String? searchPlaceholder, bool? showBackButton, bool? hideSearch, GroupsStyle? groupsStyle, GroupsRequestBuilder? groupsRequestBuilder, Widget? subtitleView(BuildContext, Group)?, Widget listItemView(Group)?, ScrollController? controller, List<CometChatOption>? options(Group group, CometChatGroupsController controller, BuildContext context)?, Widget? backButton, Widget? searchBoxIcon, CometChatTheme? theme, SelectionMode? selectionMode, dynamic onSelection(List<Group>?)?, String? emptyStateText, String? errorStateText, WidgetBuilder? loadingStateView, WidgetBuilder? emptyStateView, WidgetBuilder? errorStateView, ListItemStyle? listItemStyle, AvatarStyle? avatarStyle, StatusIndicatorStyle? statusIndicatorStyle, Widget? createGroupIcon, JoinProtectedGroupConfiguration? joinProtectedGroupConfiguration, bool? hideSeparator, Widget? passwordGroupIcon, Widget? privateGroupIcon, ActivateSelection? activateSelection, bool? hideError, dynamic stateCallBack(CometChatGroupsController controller)?, GroupsBuilderProtocol? groupsProtocol, List<Widget> appBarOptions(BuildContext context)?, OnError? onError, VoidCallback? onBack, dynamic onItemTap(BuildContext, Group)?, dynamic onItemLongPress(BuildContext, Group)?, Widget? submitIcon, Widget? selectionIcon, bool? hideAppbar, String? controllerTag})
const

Properties

activateSelection → ActivateSelection?
activateSelection lets the widget know if conversations are allowed to be selected
final
appBarOptions → List<Widget> Function(BuildContext context)?
appBarOptions list of options to be visible in app bar
final
avatarStyle → AvatarStyle?
avatarStyle set style for avatar
final
backButton → Widget?
backButton back button
final
controller → ScrollController?
controller sets controller for the list
final
controllerTag → String?
Group tag to create from , if this is passed its parent responsibility to close this
final
createGroupIcon → Widget?
createGroupIcon replace create group icon
final
emptyStateText → String?
emptyStateText text to be displayed when the list is empty
final
emptyStateView → WidgetBuilder?
emptyStateView returns view fow empty state
final
errorStateText → String?
errorStateText text to be displayed when error occur
final
errorStateView → WidgetBuilder?
errorStateView returns view fow error state behind the dialog
final
groupsProtocol → GroupsBuilderProtocol?
groupsProtocol set custom groups request builder protocol
final
groupsRequestBuilder → GroupsRequestBuilder?
groupsRequestBuilder set custom request builder
final
groupsStyle → GroupsStyle?
groupsStyle sets style
final
hashCode → int
The hash code for this object.
no setterinherited
hideAppbar → bool?
hideAppbar toggle visibility for app bar
final
hideError → bool?
hideError toggle visibility of error dialog
final
hideSearch → bool?
hideSearch switch on/ff search input
final
hideSeparator → bool?
hideSeparator
final
joinProtectedGroupConfiguration → JoinProtectedGroupConfiguration?
joinProtectedGroupConfiguration sets configuration for CometChatJoinProtectedGroup
final
listItemStyle → ListItemStyle?
listItemStyle style for every list item
final
listItemView → Widget Function(Group)?
listItemView set custom view for each group
final
loadingStateView → WidgetBuilder?
loadingStateView returns view fow loading state
final
onBack → VoidCallback?
onBack callback triggered on closing this screen
final
onError → OnError?
onError callback triggered in case any error happens when fetching groups
final
onItemLongPress → dynamic Function(BuildContext, Group)?
onItemLongPress callback triggered on pressing for long on a group item
final
onItemTap → dynamic Function(BuildContext, Group)?
onItemTap callback triggered on tapping a group item
final
onSelection → dynamic Function(List<Group>?)?
onSelection function will be performed
final
options → List<CometChatOption>? Function(Group group, CometChatGroupsController controller, BuildContext context)?
options set options which will be visible at slide of each banned member
final
passwordGroupIcon → Widget?
passwordGroupIcon sets icon in status indicator for password group
final
privateGroupIcon → Widget?
privateGroupIcon sets icon in status indicator for private group
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchBoxIcon → Widget?
searchBoxIcon search icon
final
searchPlaceholder → String?
searchPlaceholder placeholder text of search input
final
selectionIcon → Widget?
selectionIcon will change selection icon
final
selectionMode → SelectionMode?
selectionMode specifies mode groups module is opening in
final
showBackButton → bool?
showBackButton switch on/off back button
final
stateCallBack → dynamic Function(CometChatGroupsController controller)?
stateCallBack to access controller functions from parent pass empty reference of CometChatGroupsController object
final
statusIndicatorStyle → StatusIndicatorStyle?
statusIndicatorStyle set style for status indicator
final
submitIcon → Widget?
submitIcon will override the default submit icon
final
subtitleView → Widget? Function(BuildContext, Group)?
subtitleView to set subtitle for each group
final
theme → CometChatTheme?
theme can pass custom theme
final
title → String?
title sets title for the list
final

Methods

merge(GroupsConfiguration mergeWith) → GroupsConfiguration
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