UFUMultiSelect class

Inheritance

Constructors

UFUMultiSelect.new({required List<UFUMultiSelectModel> mainList, String? inputHintText, Widget? totalAmount, void updateTotalAmount({int? index, bool? isSelect, bool? isSelectAll})?, bool isFilterSheet = false, String title = 'Select option', ValueChanged<List<UFUMultiSelectModel>>? onDone, Widget? doneIcon, bool disableButtons = false, bool canDisableDoneButton = false, Widget? headerPrefixChild, UFUMultiSelectType type = UFUMultiSelectType.local, bool isLoading = false, VoidCallback? onLoadMore, bool isLoadMore = false, dynamic onSearch(String keyword)?, int? totalNetworkListCount, Widget? listLoader, List<UFUMultiSelectModel>? initialSelectionsForNetworkList, bool canShowLoadMore = false, String? helperText, List<UFUMultiSelectModel>? subList, bool? canShowSubList, ValueChanged<bool>? showSubList, String? subTitleHeader, int? maxSelection, VoidCallback? onMaxSelectionReached, bool showIncludeInactiveButton = false, dynamic onTapItem(List<UFUMultiSelectModel>, int)?, bool hideSelectAll = false, Key? key})
const

Properties

canDisableDoneButton bool
final
canShowLoadMore bool
In case of network list canShowMore helps to manage loader state
final
canShowSubList bool?
Defines to show user filter
final
disableButtons bool
final
doneIcon Widget?
final
hashCode int
The hash code for this object.
no setterinherited
headerPrefixChild Widget?
Defines to add child widget in the header at right side of a multiselect.
final
helperText String?
helperText can be used to display some info as a helper to user
final
hideSelectAll bool
final
initialSelectionsForNetworkList List<UFUMultiSelectModel>?
In case of network list initialSelectionsForNetworkList is used to display selected items at beginning
final
inputHintText String?
Defines to filter list of multiselect.
final
isFilterSheet bool
Defines to filter list of multiselect.
final
isLoading bool
In case of network list isLoading helps to manage loading state
final
isLoadMore bool
In case of network list isLoading helps to manage load more state
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
listLoader Widget?
In case of network list listLoader is used to display a loading placeholder
final
mainList List<UFUMultiSelectModel>
Defines the mainList list of a multiselect.
final
maxSelection int?
Helps in restricting maximum selections
final
onDone ValueChanged<List<UFUMultiSelectModel>>?
This method is used when onDone callback it is use to return updated list.
final
onLoadMore VoidCallback?
In case of network list onLoadMore send a callback to perform further action
final
onMaxSelectionReached VoidCallback?
Can be used to display warning to user on max selection reach
final
onSearch → dynamic Function(String keyword)?
In case of network list onSearch returns a callback with search keyword to take an action
final
onTapItem → dynamic Function(List<UFUMultiSelectModel>, int)?
Can be used to perform actions externally on selecting an item
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
showIncludeInactiveButton bool
Defines to show include inactive button
final
showSubList ValueChanged<bool>?
Function to show user filter or not.
final
subList List<UFUMultiSelectModel>?
Defines the subList list of a multiselect.
final
subTitleHeader String?
Defines sub list title.
final
title String
Defines title of a multiselect.
final
totalAmount Widget?
final
totalNetworkListCount int?
In case of network list totalNetworkListCount is used to display number of total available items
final
type UFUMultiSelectType
type can be used to differentiate between network list and local list default selected type is UFUMultiSelectType.local
final
updateTotalAmount → void Function({int? index, bool? isSelect, bool? isSelectAll})?
Defined to update TotalAmount
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() UFUMultiSelectState
Creates the mutable state for this widget at a given location in the tree.
override
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, int wrapWidth = 65}) 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